Package software.amazon.awscdk.services.ivs.alpha

Interface ChannelProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ChannelProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.109.0 (build c221850)", date="2025-03-14T03:25:07.968Z") @Stability(Experimental) public interface ChannelProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for creating a new Channel.

Example: 

 Channel myChannel = Channel.Builder.create(this, "myChannel")
         .type(ChannelType.ADVANCED_HD)
         .preset(Preset.CONSTRAINED_BANDWIDTH_DELIVERY)
         .build();

  • Method Details

    • getAuthorized

      @Stability(Experimental) @Nullable default Boolean getAuthorized()
      (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

    • getChannelName

      @Stability(Experimental) @Nullable default String getChannelName()
      (experimental) A name for the channel.

      Default: Automatically generated name

    • getContainerFormat

      @Stability(Experimental) @Nullable default ContainerFormat getContainerFormat()
      (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).

    • getInsecureIngest

      @Stability(Experimental) @Nullable default Boolean getInsecureIngest()
      (experimental) Whether the channel allows insecure RTMP ingest.

      Default: false

    • getLatencyMode

      @Stability(Experimental) @Nullable default LatencyMode getLatencyMode()
      (experimental) Channel latency mode.

      Default: LatencyMode.LOW

    • getMultitrackInputConfiguration

      @Stability(Experimental) @Nullable default MultitrackInputConfiguration getMultitrackInputConfiguration()
      (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 Also:

    • getPreset

      @Stability(Experimental) @Nullable default Preset getPreset()
      (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

    • getRecordingConfiguration

      @Stability(Experimental) @Nullable default IRecordingConfiguration getRecordingConfiguration()
      (experimental) A recording configuration for the channel.

      Default: - recording is disabled

    • getType

      @Stability(Experimental) @Nullable default ChannelType getType()
      (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

    • builder

      @Stability(Experimental) static ChannelProps.Builder builder()
      Returns:
      a ChannelProps.Builder of ChannelProps