software.amazon.awssdk.services.ivs.model

Interface CreateChannelRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, IvsRequest.Builder, SdkBuilder<CreateChannelRequest.Builder,CreateChannelRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateChannelRequest

public static interface CreateChannelRequest.Builder
extends IvsRequest.Builder, SdkPojo, CopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Method Summary

Modifier and Type	Method and Description
CreateChannelRequest.Builder	authorized(Boolean authorized) Whether the channel is private (enabled for playback authorization).
CreateChannelRequest.Builder	insecureIngest(Boolean insecureIngest) Whether the channel allows insecure RTMP ingest.
CreateChannelRequest.Builder	latencyMode(ChannelLatencyMode latencyMode) Channel latency mode.
CreateChannelRequest.Builder	latencyMode(String latencyMode) Channel latency mode.
CreateChannelRequest.Builder	name(String name) Channel name.
CreateChannelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateChannelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateChannelRequest.Builder	preset(String preset) Optional transcode preset for the channel.
CreateChannelRequest.Builder	preset(TranscodePreset preset) Optional transcode preset for the channel.
CreateChannelRequest.Builder	recordingConfigurationArn(String recordingConfigurationArn) Recording-configuration ARN.
CreateChannelRequest.Builder	tags(Map<String,String> tags) Array of 1-50 maps, each of the form string:string (key:value).
CreateChannelRequest.Builder	type(ChannelType type) Channel type, which determines the allowable resolution and bitrate.
CreateChannelRequest.Builder	type(String type) Channel type, which determines the allowable resolution and bitrate.

Methods inherited from interface software.amazon.awssdk.services.ivs.model.IvsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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.

insecureIngest

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

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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) 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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode, ChannelLatencyMode

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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) 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. (Note: In the Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.) Default: LOW.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ChannelLatencyMode, ChannelLatencyMode

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.

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:

TranscodePreset, TranscodePreset

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:

TranscodePreset, TranscodePreset

recordingConfigurationArn

CreateChannelRequest.Builder recordingConfigurationArn(String recordingConfigurationArn)

Recording-configuration ARN. Default: "" (empty string, recording is disabled).

Parameters:

recordingConfigurationArn - Recording-configuration ARN. 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 Tagging Amazon Web Services Resources for more information, 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 Tagging Amazon Web Services Resources for more information, 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:

ChannelType, ChannelType

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:

ChannelType, ChannelType

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder