Experimental
@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ChannelProps Struct
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,
});
my_channel = ivs.Channel(self, "myChannel",
type=ivs.ChannelType.ADVANCED_HD,
preset=ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY
)
Channel myChannel = Channel.Builder.create(this, "myChannel")
.type(ChannelType.ADVANCED_HD)
.preset(Preset.CONSTRAINED_BANDWIDTH_DELIVERY)
.build();
// Install: dotnet add package Amazon.CDK.AWS.IVS.Alpha
var myChannel = new Channel(this, "myChannel", new ChannelProps {
Type = ChannelType.ADVANCED_HD,
Preset = Preset.CONSTRAINED_BANDWIDTH_DELIVERY
});
// Install: go get github.com/aws/aws-cdk-go/awscdkivsalpha/v2
myChannel := ivs.NewChannel(this, jsii.String("myChannel"), &ChannelProps{
Type: ivs.ChannelType_ADVANCED_HD,
Preset: ivs.Preset_CONSTRAINED_BANDWIDTH_DELIVERY,
})
Properties
authorizedoptionalbooleanauthorizedoptionalboolauthorizedoptionalBooleanAuthorizedoptionalboolAuthorizedoptional*bool= false#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
channelNameoptionalstringchannel_nameoptionalstrchannelNameoptionalStringChannelNameoptionalstringChannelNameoptional*string#Default: Automatically generated name
containerFormatoptionalContainerFormatcontainer_formatoptionalContainerFormatcontainerFormatoptionalContainerFormatContainerFormatoptionalContainerFormatContainerFormatoptionalContainerFormat#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).
If multitrackInputConfiguration is specified, only fMP4 can be used. Otherwise, containerFormat may be set to ContainerFormat.TS or ContainerFormat.FRAGMENTED_MP4.
insecureIngestoptionalbooleaninsecure_ingestoptionalboolinsecureIngestoptionalBooleanInsecureIngestoptionalboolInsecureIngestoptional*bool= false#latencyModeoptionalLatencyModelatency_modeoptionalLatencyModelatencyModeoptionalLatencyModeLatencyModeoptionalLatencyModeLatencyModeoptionalLatencyMode= LatencyMode.LOW#multitrackInputConfigurationoptionalMultitrackInputConfigurationmultitrack_input_configurationoptionalMultitrackInputConfigurationmultitrackInputConfigurationoptionalMultitrackInputConfigurationMultitrackInputConfigurationoptionalMultitrackInputConfigurationMultitrackInputConfigurationoptionalMultitrackInputConfiguration#Default: undefined - IVS default setting is not use MultiTrack Video.
multitrackInputConfiguration is only supported for ChannelType.STANDARD.
presetoptionalPresetpresetoptionalPresetpresetoptionalPresetPresetoptionalPresetPresetoptionalPreset#Default: Preset.HIGHER_BANDWIDTH_DELIVERY if channelType is ADVANCED_SD or ADVANCED_HD, none otherwise
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.
recordingConfigurationoptionalIRecordingConfigurationrecording_configurationoptionalIRecordingConfigurationrecordingConfigurationoptionalIRecordingConfigurationRecordingConfigurationoptionalIRecordingConfigurationRecordingConfigurationoptionalIRecordingConfiguration#Default: recording is disabled
typeoptionalChannelTypetypeoptionalChannelTypetypeoptionalChannelTypeTypeoptionalChannelTypeTypeoptionalChannelType= ChannelType.STANDARD#If you exceed the allowable resolution or bitrate, the stream will disconnect immediately