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

Class ChannelProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • authorized

      @Stability(Experimental) public ChannelProps.Builder authorized(Boolean authorized)
      Sets the value of ChannelProps.getAuthorized()
      Parameters:
      authorized - 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
      Returns:
      this

    • channelName

      @Stability(Experimental) public ChannelProps.Builder channelName(String channelName)
      Sets the value of ChannelProps.getChannelName()
      Parameters:
      channelName - A name for the channel.
      Returns:
      this

    • containerFormat

      @Stability(Experimental) public ChannelProps.Builder containerFormat(ContainerFormat containerFormat)
      Sets the value of ChannelProps.getContainerFormat()
      Parameters:
      containerFormat - 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.
      Returns:
      this

    • insecureIngest

      @Stability(Experimental) public ChannelProps.Builder insecureIngest(Boolean insecureIngest)
      Sets the value of ChannelProps.getInsecureIngest()
      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest.
      Returns:
      this

    • latencyMode

      @Stability(Experimental) public ChannelProps.Builder latencyMode(LatencyMode latencyMode)
      Sets the value of ChannelProps.getLatencyMode()
      Parameters:
      latencyMode - Channel latency mode.
      Returns:
      this

    • multitrackInputConfiguration

      @Stability(Experimental) public ChannelProps.Builder multitrackInputConfiguration(MultitrackInputConfiguration multitrackInputConfiguration)
      Sets the value of ChannelProps.getMultitrackInputConfiguration()
      Parameters:
      multitrackInputConfiguration - Object specifying multitrack input configuration. You must specify multitrackInputConfiguration if you want to use MultiTrack Video. multitrackInputConfiguration is only supported for ChannelType.STANDARD.
      Returns:
      this

    • preset

      @Stability(Experimental) public ChannelProps.Builder preset(Preset preset)
      Sets the value of ChannelProps.getPreset()
      Parameters:
      preset - 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.
      Returns:
      this

    • recordingConfiguration

      @Stability(Experimental) public ChannelProps.Builder recordingConfiguration(IRecordingConfiguration recordingConfiguration)
      Sets the value of ChannelProps.getRecordingConfiguration()
      Parameters:
      recordingConfiguration - A recording configuration for the channel.
      Returns:
      this

    • type

      @Stability(Experimental) public ChannelProps.Builder type(ChannelType type)
      Sets the value of ChannelProps.getType()
      Parameters:
      type - The channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream will disconnect immediately
      Returns:
      this

    • build

      @Stability(Experimental) public ChannelProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<ChannelProps>
      Returns:
      a new instance of ChannelProps
      Throws:
      NullPointerException - if any required attribute was not provided