Interface Channel.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Channel.Builder,Channel>, SdkBuilder<Channel.Builder,Channel>, SdkPojo
Enclosing class:
Channel
@Mutable @NotThreadSafe public static interface Channel.Builder extends SdkPojo, CopyableBuilder<Channel.Builder,Channel>

  • Method Details

    • arn

      Channel.Builder arn(String arn)

      Channel ARN.

      Parameters:
      arn - Channel ARN.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • authorized

      Channel.Builder authorized(Boolean authorized)

      Whether the channel is private (enabled for playback authorization). Default: false.

      Parameters:
      authorized - Whether the channel is private (enabled for playback authorization). Default: false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerFormat

      Channel.Builder containerFormat(String containerFormat)

      Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

      Parameters:
      containerFormat - Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • containerFormat

      Channel.Builder containerFormat(ContainerFormat containerFormat)

      Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.

      Parameters:
      containerFormat - Indicates which content-packaging format is used (MPEG-TS or fMP4). If multitrackInputConfiguration is specified and enabled is true, then containerFormat is required and must be set to FRAGMENTED_MP4. Otherwise, containerFormat may be set to TS or FRAGMENTED_MP4. Default: TS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • ingestEndpoint

      Channel.Builder ingestEndpoint(String ingestEndpoint)

      Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

      Parameters:
      ingestEndpoint - Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • insecureIngest

      Channel.Builder insecureIngest(Boolean insecureIngest)

      Whether the channel allows insecure RTMP ingest. Default: false.

      Parameters:
      insecureIngest - Whether the channel allows insecure RTMP ingest. Default: false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • latencyMode

      Channel.Builder latencyMode(String latencyMode)

      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

      Parameters:
      latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • latencyMode

      Channel.Builder latencyMode(ChannelLatencyMode latencyMode)

      Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.

      Parameters:
      latencyMode - Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multitrackInputConfiguration

      Channel.Builder multitrackInputConfiguration(MultitrackInputConfiguration multitrackInputConfiguration)

      Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

      Parameters:
      multitrackInputConfiguration - Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • multitrackInputConfiguration

      default Channel.Builder multitrackInputConfiguration(Consumer<MultitrackInputConfiguration.Builder> multitrackInputConfiguration)

      Object specifying multitrack input configuration. Default: no multitrack input configuration is specified.

      This is a convenience method that creates an instance of the MultitrackInputConfiguration.Builder avoiding the need to create one manually via MultitrackInputConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multitrackInputConfiguration(MultitrackInputConfiguration).

      Parameters:
      multitrackInputConfiguration - a consumer that will call methods on MultitrackInputConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      Channel.Builder name(String name)

      Channel name.

      Parameters:
      name - Channel name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playbackRestrictionPolicyArn

      Channel.Builder playbackRestrictionPolicyArn(String playbackRestrictionPolicyArn)

      Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).

      Parameters:
      playbackRestrictionPolicyArn - Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playbackUrl

      Channel.Builder playbackUrl(String playbackUrl)

      Channel playback URL.

      Parameters:
      playbackUrl - Channel playback URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preset

      Channel.Builder preset(String preset)

      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD ), preset is the empty string ("").

      Parameters:
      preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • preset

      Channel.Builder preset(TranscodePreset preset)

      Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD ), preset is the empty string ("").

      Parameters:
      preset - Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recordingConfigurationArn

      Channel.Builder recordingConfigurationArn(String recordingConfigurationArn)

      Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).

      Parameters:
      recordingConfigurationArn - Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • srt

      Channel.Builder srt(Srt srt)

      Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

      Parameters:
      srt - Specifies the endpoint and optional passphrase for streaming with the SRT protocol.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • srt

      default Channel.Builder srt(Consumer<Srt.Builder> srt)

      Specifies the endpoint and optional passphrase for streaming with the SRT protocol.

      This is a convenience method that creates an instance of the Srt.Builder avoiding the need to create one manually via Srt.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to srt(Srt).

      Parameters:
      srt - a consumer that will call methods on Srt.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      Channel.Builder tags(Map<String,String> tags)

      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

      Parameters:
      tags - Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      Channel.Builder type(String type)

      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

      Parameters:
      type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      Channel.Builder type(ChannelType type)

      Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.

      Parameters:
      type - Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable input resolution or bitrate, the stream probably will disconnect immediately. Default: STANDARD. For details, see Channel Types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: