Interface AudioDescription.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AudioDescription.Builder,
,AudioDescription> SdkBuilder<AudioDescription.Builder,
,AudioDescription> SdkPojo
- Enclosing class:
AudioDescription
public static interface AudioDescription.Builder
extends SdkPojo, CopyableBuilder<AudioDescription.Builder,AudioDescription>
-
Method Summary
Modifier and TypeMethodDescriptiondefault AudioDescription.Builder
audioNormalizationSettings
(Consumer<AudioNormalizationSettings.Builder> audioNormalizationSettings) Advanced audio normalization settings.audioNormalizationSettings
(AudioNormalizationSettings audioNormalizationSettings) Advanced audio normalization settings.audioSelectorName
(String audioSelectorName) The name of the AudioSelector used as the source for this AudioDescription.Applies only if audioTypeControl is useConfigured.Applies only if audioTypeControl is useConfigured.audioTypeControl
(String audioTypeControl) Determines how audio type is determined.audioTypeControl
(AudioDescriptionAudioTypeControl audioTypeControl) Determines how audio type is determined.default AudioDescription.Builder
audioWatermarkingSettings
(Consumer<AudioWatermarkSettings.Builder> audioWatermarkingSettings) Settings to configure one or more solutions that insert audio watermarks in the audio encode This is a convenience method that creates an instance of theAudioWatermarkSettings.Builder
avoiding the need to create one manually viaAudioWatermarkSettings.builder()
.audioWatermarkingSettings
(AudioWatermarkSettings audioWatermarkingSettings) Settings to configure one or more solutions that insert audio watermarks in the audio encodedefault AudioDescription.Builder
codecSettings
(Consumer<AudioCodecSettings.Builder> codecSettings) Audio codec settings.codecSettings
(AudioCodecSettings codecSettings) Audio codec settings.languageCode
(String languageCode) RFC 5646 language code representing the language of the audio output track.languageCodeControl
(String languageCodeControl) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.languageCodeControl
(AudioDescriptionLanguageCodeControl languageCodeControl) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.The name of this AudioDescription.default AudioDescription.Builder
remixSettings
(Consumer<RemixSettings.Builder> remixSettings) Settings that control how input audio channels are remixed into the output audio channels.remixSettings
(RemixSettings remixSettings) Settings that control how input audio channels are remixed into the output audio channels.streamName
(String streamName) Used for MS Smooth and Apple HLS outputs.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
audioNormalizationSettings
AudioDescription.Builder audioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings) Advanced audio normalization settings.- Parameters:
audioNormalizationSettings
- Advanced audio normalization settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
audioNormalizationSettings
default AudioDescription.Builder audioNormalizationSettings(Consumer<AudioNormalizationSettings.Builder> audioNormalizationSettings) Advanced audio normalization settings. This is a convenience method that creates an instance of theAudioNormalizationSettings.Builder
avoiding the need to create one manually viaAudioNormalizationSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaudioNormalizationSettings(AudioNormalizationSettings)
.- Parameters:
audioNormalizationSettings
- a consumer that will call methods onAudioNormalizationSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
audioSelectorName
The name of the AudioSelector used as the source for this AudioDescription.- Parameters:
audioSelectorName
- The name of the AudioSelector used as the source for this AudioDescription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
audioType
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.- Parameters:
audioType
- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
audioType
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.- Parameters:
audioType
- Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
audioTypeControl
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.- Parameters:
audioTypeControl
- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
audioTypeControl
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.- Parameters:
audioTypeControl
- Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
audioWatermarkingSettings
AudioDescription.Builder audioWatermarkingSettings(AudioWatermarkSettings audioWatermarkingSettings) Settings to configure one or more solutions that insert audio watermarks in the audio encode- Parameters:
audioWatermarkingSettings
- Settings to configure one or more solutions that insert audio watermarks in the audio encode- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
audioWatermarkingSettings
default AudioDescription.Builder audioWatermarkingSettings(Consumer<AudioWatermarkSettings.Builder> audioWatermarkingSettings) Settings to configure one or more solutions that insert audio watermarks in the audio encode This is a convenience method that creates an instance of theAudioWatermarkSettings.Builder
avoiding the need to create one manually viaAudioWatermarkSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaudioWatermarkingSettings(AudioWatermarkSettings)
.- Parameters:
audioWatermarkingSettings
- a consumer that will call methods onAudioWatermarkSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
codecSettings
Audio codec settings.- Parameters:
codecSettings
- Audio codec settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
codecSettings
Audio codec settings. This is a convenience method that creates an instance of theAudioCodecSettings.Builder
avoiding the need to create one manually viaAudioCodecSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocodecSettings(AudioCodecSettings)
.- Parameters:
codecSettings
- a consumer that will call methods onAudioCodecSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.- Parameters:
languageCode
- RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageCodeControl
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.- Parameters:
languageCodeControl
- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCodeControl
AudioDescription.Builder languageCodeControl(AudioDescriptionLanguageCodeControl languageCodeControl) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.- Parameters:
languageCodeControl
- Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.- Parameters:
name
- The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
remixSettings
Settings that control how input audio channels are remixed into the output audio channels.- Parameters:
remixSettings
- Settings that control how input audio channels are remixed into the output audio channels.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
remixSettings
Settings that control how input audio channels are remixed into the output audio channels. This is a convenience method that creates an instance of theRemixSettings.Builder
avoiding the need to create one manually viaRemixSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toremixSettings(RemixSettings)
.- Parameters:
remixSettings
- a consumer that will call methods onRemixSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
streamName
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).- Parameters:
streamName
- Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-