class Channel (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ivs.Alpha.Channel |
![]() | github.com/aws/aws-cdk-go/awscdkivsalpha/v2#Channel |
![]() | software.amazon.awscdk.services.ivs.alpha.Channel |
![]() | aws_cdk.aws_ivs_alpha.Channel |
![]() | @aws-cdk/aws-ivs-alpha ยป Channel |
Implements
IConstruct
, IDependable
, IResource
, IChannel
A new IVS channel.
Example
const myRtmpChannel = new ivs.Channel(this, 'myRtmpChannel', {
type: ivs.ChannelType.STANDARD,
insecureIngest: true, // default value is false
});
Initializer
new Channel(scope: Construct, id: string, props?: ChannelProps)
Parameters
- scope
Construct
- id
string
- props
Channel
Props
Construct Props
Name | Type | Description |
---|---|---|
authorized? | boolean | Whether the channel is authorized. |
channel | string | A name for the channel. |
container | Container | Indicates which content-packaging format is used (MPEG-TS or fMP4). |
insecure | boolean | Whether the channel allows insecure RTMP ingest. |
latency | Latency | Channel latency mode. |
multitrack | Multitrack | Object specifying multitrack input configuration. You must specify multitrackInputConfiguration if you want to use MultiTrack Video. |
preset? | Preset | An optional transcode preset for the channel. |
recording | IRecording | A recording configuration for the channel. |
type? | Channel | The channel type, which determines the allowable resolution and bitrate. |
authorized?
Type:
boolean
(optional, default: false)
Whether the channel is authorized.
If you wish to make an authorized channel, you will need to ensure that a PlaybackKeyPair has been uploaded to your account as this is used to validate the signed JWT that is required for authorization
channelName?
Type:
string
(optional, default: Automatically generated name)
A name for the channel.
containerFormat?
Type:
Container
(optional, default: ContainerFormat.FRAGMENTED_MP4
is automatically set when the multitrackInputConfiguration
is specified. If not specified, it remains undefined and uses the IVS default setting (TS).)
Indicates which content-packaging format is used (MPEG-TS or fMP4).
If multitrackInputConfiguration
is specified, only fMP4 can be used.
Otherwise, containerFormat
may be set to ContainerFormat.TS
or ContainerFormat.FRAGMENTED_MP4
.
insecureIngest?
Type:
boolean
(optional, default: false)
Whether the channel allows insecure RTMP ingest.
latencyMode?
Type:
Latency
(optional, default: LatencyMode.LOW)
Channel latency mode.
multitrackInputConfiguration?
Type:
Multitrack
(optional, default: undefined - IVS default setting is not use MultiTrack Video.)
Object specifying multitrack input configuration. You must specify multitrackInputConfiguration
if you want to use MultiTrack Video.
multitrackInputConfiguration
is only supported for ChannelType.STANDARD
.
preset?
Type:
Preset
(optional, default: Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise)
An optional transcode preset for the channel.
Can be used for ADVANCED_HD and ADVANCED_SD channel types. When LOW or STANDARD is used, the preset will be overridden and set to none regardless of the value provided.
recordingConfiguration?
Type:
IRecording
(optional, default: recording is disabled)
A recording configuration for the channel.
type?
Type:
Channel
(optional, default: ChannelType.STANDARD)
The channel type, which determines the allowable resolution and bitrate.
If you exceed the allowable resolution or bitrate, the stream will disconnect immediately
Properties
Name | Type | Description |
---|---|---|
channel | string | The channel ARN. |
channel | string | Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software. |
channel | string | Channel playback URL. |
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
stack | Stack | The stack in which this resource is defined. |
channelArn
Type:
string
The channel ARN.
For example: arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh
channelIngestEndpoint
Type:
string
Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
For example: a1b2c3d4e5f6.global-contribute.live-video.net
channelPlaybackUrl
Type:
string
Channel playback URL.
For example: https://a1b2c3d4e5f6.us-west-2.playback.live-video.net/api/video/v1/us-west-2.123456789012.channel.abcdEFGH.m3u8
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
add | Adds a stream key for this IVS Channel. |
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Import an existing channel. |
addStreamKey(id)
public addStreamKey(id: string): StreamKey
Parameters
- id
string
Returns
Adds a stream key for this IVS Channel.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromChannelArn(scope, id, channelArn)
public static fromChannelArn(scope: Construct, id: string, channelArn: string): IChannel
Parameters
- scope
Construct
- id
string
- channelArn
string
Returns
Import an existing channel.