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

Class Channel.Builder

java.lang.Object
software.amazon.awscdk.services.ivs.alpha.Channel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Channel>
Enclosing class:
Channel
@Stability(Experimental) public static final class Channel.Builder extends Object implements software.amazon.jsii.Builder<Channel>
(experimental) A fluent builder for Channel.

  • Method Details

    • create

      @Stability(Experimental) public static Channel.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Channel.Builder.

    • authorized

      @Stability(Experimental) public Channel.Builder authorized(Boolean 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

      Parameters:
      authorized - Whether the channel is authorized. This parameter is required.
      Returns:
      this

    • channelName

      @Stability(Experimental) public Channel.Builder channelName(String channelName)
      (experimental) A name for the channel.

      Default: Automatically generated name

      Parameters:
      channelName - A name for the channel. This parameter is required.
      Returns:
      this

    • containerFormat

      @Stability(Experimental) public Channel.Builder containerFormat(ContainerFormat 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).

      Parameters:
      containerFormat - Indicates which content-packaging format is used (MPEG-TS or fMP4). This parameter is required.
      Returns:
      this

    • insecureIngest

      @Stability(Experimental) public Channel.Builder insecureIngest(Boolean insecureIngest)
      (experimental) Whether the channel allows insecure RTMP ingest.

      Default: false

      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. This parameter is required.
      Returns:
      this

    • latencyMode

      @Stability(Experimental) public Channel.Builder latencyMode(LatencyMode latencyMode)
      (experimental) Channel latency mode.

      Default: LatencyMode.LOW

      Parameters:
      latencyMode - Channel latency mode. This parameter is required.
      Returns:
      this

    • multitrackInputConfiguration

      @Stability(Experimental) public Channel.Builder multitrackInputConfiguration(MultitrackInputConfiguration multitrackInputConfiguration)
      (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.

      Parameters:
      multitrackInputConfiguration - Object specifying multitrack input configuration. You must specify multitrackInputConfiguration if you want to use MultiTrack Video. This parameter is required.
      Returns:
      this
      See Also:

    • preset

      @Stability(Experimental) public Channel.Builder preset(Preset 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

      Parameters:
      preset - An optional transcode preset for the channel. This parameter is required.
      Returns:
      this

    • recordingConfiguration

      @Stability(Experimental) public Channel.Builder recordingConfiguration(IRecordingConfiguration recordingConfiguration)
      (experimental) A recording configuration for the channel.

      Default: - recording is disabled

      Parameters:
      recordingConfiguration - A recording configuration for the channel. This parameter is required.
      Returns:
      this

    • type

      @Stability(Experimental) public Channel.Builder type(ChannelType 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

      Parameters:
      type - The channel type, which determines the allowable resolution and bitrate. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public Channel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Channel>
      Returns:
      a newly built instance of Channel.