Interface CreateChannelRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateChannelRequest.Builder,
,CreateChannelRequest> IvsRequest.Builder
,SdkBuilder<CreateChannelRequest.Builder,
,CreateChannelRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateChannelRequest
-
Method Summary
Modifier and TypeMethodDescriptionauthorized
(Boolean authorized) Whether the channel is private (enabled for playback authorization).containerFormat
(String containerFormat) Indicates which content-packaging format is used (MPEG-TS or fMP4).containerFormat
(ContainerFormat containerFormat) Indicates which content-packaging format is used (MPEG-TS or fMP4).insecureIngest
(Boolean insecureIngest) Whether the channel allows insecure RTMP and SRT ingest.latencyMode
(String latencyMode) Channel latency mode.latencyMode
(ChannelLatencyMode latencyMode) Channel latency mode.default CreateChannelRequest.Builder
multitrackInputConfiguration
(Consumer<MultitrackInputConfiguration.Builder> multitrackInputConfiguration) Object specifying multitrack input configuration.multitrackInputConfiguration
(MultitrackInputConfiguration multitrackInputConfiguration) Object specifying multitrack input configuration.Channel name.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.playbackRestrictionPolicyArn
(String playbackRestrictionPolicyArn) Playback-restriction-policy ARN.Optional transcode preset for the channel.preset
(TranscodePreset preset) Optional transcode preset for the channel.recordingConfigurationArn
(String recordingConfigurationArn) Recording-configuration ARN.Array of 1-50 maps, each of the formstring:string (key:value)
.Channel type, which determines the allowable resolution and bitrate.type
(ChannelType type) Channel type, which determines the allowable resolution and bitrate.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ivs.model.IvsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
Indicates which content-packaging format is used (MPEG-TS or fMP4). If
multitrackInputConfiguration
is specified andenabled
istrue
, thencontainerFormat
is required and must be set toFRAGMENTED_MP4
. Otherwise,containerFormat
may be set toTS
orFRAGMENTED_MP4
. Default:TS
.- Parameters:
containerFormat
- Indicates which content-packaging format is used (MPEG-TS or fMP4). IfmultitrackInputConfiguration
is specified andenabled
istrue
, thencontainerFormat
is required and must be set toFRAGMENTED_MP4
. Otherwise,containerFormat
may be set toTS
orFRAGMENTED_MP4
. Default:TS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
containerFormat
Indicates which content-packaging format is used (MPEG-TS or fMP4). If
multitrackInputConfiguration
is specified andenabled
istrue
, thencontainerFormat
is required and must be set toFRAGMENTED_MP4
. Otherwise,containerFormat
may be set toTS
orFRAGMENTED_MP4
. Default:TS
.- Parameters:
containerFormat
- Indicates which content-packaging format is used (MPEG-TS or fMP4). IfmultitrackInputConfiguration
is specified andenabled
istrue
, thencontainerFormat
is required and must be set toFRAGMENTED_MP4
. Otherwise,containerFormat
may be set toTS
orFRAGMENTED_MP4
. Default:TS
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Channel latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.- Parameters:
latencyMode
- Channel latency mode. UseNORMAL
to broadcast and deliver live video up to Full HD. UseLOW
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 latency mode. Use
NORMAL
to broadcast and deliver live video up to Full HD. UseLOW
for near-real-time interaction with viewers. Default:LOW
.- Parameters:
latencyMode
- Channel latency mode. UseNORMAL
to broadcast and deliver live video up to Full HD. UseLOW
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 theMultitrackInputConfiguration.Builder
avoiding the need to create one manually viaMultitrackInputConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomultitrackInputConfiguration(MultitrackInputConfiguration)
.- Parameters:
multitrackInputConfiguration
- a consumer that will call methods onMultitrackInputConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
Channel name.
- Parameters:
name
- Channel name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).- Parameters:
preset
- Optional transcode preset for the channel. This is selectable only forADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
preset
Optional transcode preset for the channel. This is selectable only for
ADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).- Parameters:
preset
- Optional transcode preset for the channel. This is selectable only forADVANCED_HD
andADVANCED_SD
channel types. For those channel types, the defaultpreset
isHIGHER_BANDWIDTH_DELIVERY
. For other channel types (BASIC
andSTANDARD
),preset
is the empty string (""
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 formstring: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 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 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-