interface ChannelProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Ivs.Alpha.ChannelProps |
Go | github.com/aws/aws-cdk-go/awscdkivsalpha/v2#ChannelProps |
Java | software.amazon.awscdk.services.ivs.alpha.ChannelProps |
Python | aws_cdk.aws_ivs_alpha.ChannelProps |
TypeScript (source) | @aws-cdk/aws-ivs-alpha ยป ChannelProps |
Properties for creating a new Channel.
Example
const myChannel = new ivs.Channel(this, 'Channel', {
authorized: true, // default value is false
});
Properties
Name | Type | Description |
---|---|---|
authorized? | boolean | Whether the channel is authorized. |
channel | string | A name for the channel. |
latency | Latency | Channel latency mode. |
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.
latencyMode?
Type:
Latency
(optional, default: LatencyMode.LOW)
Channel latency mode.
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