ChannelProps

class aws_cdk.aws_ivs_alpha.ChannelProps(*, authorized=None, channel_name=None, container_format=None, insecure_ingest=None, latency_mode=None, multitrack_input_configuration=None, preset=None, recording_configuration=None, type=None)

Bases: object

(experimental) Properties for creating a new Channel.

Parameters:

  • authorized (Optional[bool]) – (experimental) 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 Default: false

  • channel_name (Optional[str]) – (experimental) A name for the channel. Default: Automatically generated name

  • container_format (Optional[ContainerFormat]) – (experimental) 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. 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).

  • insecure_ingest (Optional[bool]) – (experimental) Whether the channel allows insecure RTMP ingest. Default: false

  • latency_mode (Optional[LatencyMode]) – (experimental) Channel latency mode. Default: LatencyMode.LOW

  • multitrack_input_configuration (Union[MultitrackInputConfiguration, Dict[str, Any], None]) – (experimental) Object specifying multitrack input configuration. You must specify multitrackInputConfiguration if you want to use MultiTrack Video. multitrackInputConfiguration is only supported for ChannelType.STANDARD. Default: undefined - IVS default setting is not use MultiTrack Video.

  • preset (Optional[Preset]) – (experimental) 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. Default: - Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise

  • recording_configuration (Optional[IRecordingConfiguration]) – (experimental) A recording configuration for the channel. Default: - recording is disabled

  • type (Optional[ChannelType]) – (experimental) The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately Default: ChannelType.STANDARD

Stability:

experimental

ExampleMetadata:

infused

Example:

my_channel = ivs.Channel(self, "myChannel",
    type=ivs.ChannelType.ADVANCED_HD,
    preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
)

Attributes

authorized

(experimental) 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

Default:

false

Stability:

experimental

channel_name

(experimental) A name for the channel.

Default:

Automatically generated name

Stability:

experimental

container_format

(experimental) 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.

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).

Stability:

experimental

insecure_ingest

(experimental) Whether the channel allows insecure RTMP ingest.

Default:

false

Stability:

experimental

latency_mode

(experimental) Channel latency mode.

Default:

LatencyMode.LOW

Stability:

experimental

multitrack_input_configuration

(experimental) Object specifying multitrack input configuration. You must specify multitrackInputConfiguration if you want to use MultiTrack Video.

multitrackInputConfiguration is only supported for ChannelType.STANDARD.

Default:

undefined - IVS default setting is not use MultiTrack Video.

See:

https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html

Stability:

experimental

preset

(experimental) 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.

Default:

  • Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise

Stability:

experimental

recording_configuration

(experimental) A recording configuration for the channel.

Default:

  • recording is disabled

Stability:

experimental

type

(experimental) The channel type, which determines the allowable resolution and bitrate.

If you exceed the allowable resolution or bitrate, the stream will disconnect immediately

Default:

ChannelType.STANDARD

Stability:

experimental