Interface CreateChannelRequest.Builder

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

  • Method Details

    • authorized

      CreateChannelRequest.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

      CreateChannelRequest.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

      CreateChannelRequest.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:

    • insecureIngest

      CreateChannelRequest.Builder insecureIngest(Boolean insecureIngest)

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

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

    • latencyMode

      CreateChannelRequest.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

      CreateChannelRequest.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

      CreateChannelRequest.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 CreateChannelRequest.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

      CreateChannelRequest.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

      CreateChannelRequest.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.

    • preset

      CreateChannelRequest.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

      CreateChannelRequest.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

      CreateChannelRequest.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.

    • tags

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

      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 - 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

      CreateChannelRequest.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

      CreateChannelRequest.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:

    • overrideConfiguration

      CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateChannelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.