interface ChannelProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IVS.ChannelProps |
 Java | software.amazon.awscdk.services.ivs.ChannelProps |
 Python | aws_cdk.aws_ivs.ChannelProps |
 TypeScript (source) | @aws-cdk/aws-ivs » 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. |
| latency | Latency | Channel latency mode. |
| name? | string | Channel name. |
| 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
latencyMode?
Type:
Latency
(optional, default: LatencyMode.LOW)
Channel latency mode.
name?
Type:
string
(optional, default: None)
Channel name.
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