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, 'myChannel', {
  type: ivs.ChannelType.ADVANCED_HD,
  preset: ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY,
});

Properties

Name	Type	Description
authorized?🔹	boolean	Whether the channel is authorized.
channelName?🔹	string	A name for the channel.
containerFormat?🔹	ContainerFormat	Indicates which content-packaging format is used (MPEG-TS or fMP4).
insecureIngest?🔹	boolean	Whether the channel allows insecure RTMP ingest.
latencyMode?🔹	LatencyMode	Channel latency mode.
multitrackInputConfiguration?🔹	MultitrackInputConfiguration	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.
recordingConfiguration?🔹	IRecordingConfiguration	A recording configuration for the channel.
type?🔹	ChannelType	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: ContainerFormat (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: LatencyMode (optional, default: LatencyMode.LOW)

Channel latency mode.

---

multitrackInputConfiguration?🔹

Type: MultitrackInputConfiguration (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.

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

---

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: IRecordingConfiguration (optional, default: recording is disabled)

A recording configuration for the channel.

---

type?🔹

Type: ChannelType (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