software.amazon.awssdk.services.mediaconvert.model

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 Type	Method and Description
AudioDescription.Builder	audioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings) Advanced audio normalization settings.
default AudioDescription.Builder	audioNormalizationSettings(Consumer<AudioNormalizationSettings.Builder> audioNormalizationSettings) Advanced audio normalization settings.
AudioDescription.Builder	audioSourceName(String audioSourceName) Specifies which audio data to use from each input.
AudioDescription.Builder	audioType(Integer audioType) Applies only if Follow Input Audio Type is unchecked (false).
AudioDescription.Builder	audioTypeControl(AudioTypeControl audioTypeControl) When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output.
AudioDescription.Builder	audioTypeControl(String audioTypeControl) When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output.
AudioDescription.Builder	codecSettings(AudioCodecSettings codecSettings) Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding.
default AudioDescription.Builder	codecSettings(Consumer<AudioCodecSettings.Builder> codecSettings) Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding.
AudioDescription.Builder	customLanguageCode(String customLanguageCode) Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code.
AudioDescription.Builder	languageCode(LanguageCode languageCode) Indicates the language of the audio output track.
AudioDescription.Builder	languageCode(String languageCode) Indicates the language of the audio output track.
AudioDescription.Builder	languageCodeControl(AudioLanguageCodeControl languageCodeControl) Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
AudioDescription.Builder	languageCodeControl(String languageCodeControl) Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.
default AudioDescription.Builder	remixSettings(Consumer<RemixSettings.Builder> remixSettings) Advanced audio remixing settings.
AudioDescription.Builder	remixSettings(RemixSettings remixSettings) Advanced audio remixing settings.
AudioDescription.Builder	streamName(String streamName) Used for MS Smooth and Apple HLS outputs.

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

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

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 that creates an instance of the AudioNormalizationSettings.Builder avoiding the need to create one manually via AudioNormalizationSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audioNormalizationSettings(AudioNormalizationSettings).

Parameters:

audioNormalizationSettings - a consumer that will call methods on AudioNormalizationSettings.Builder

Returns:

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

See Also:

audioNormalizationSettings(AudioNormalizationSettings)

audioSourceName

AudioDescription.Builder audioSourceName(String audioSourceName)

Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

Parameters:

audioSourceName - Specifies which audio data to use from each input. In the simplest case, specify an "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.

Returns:

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

audioType

AudioDescription.Builder audioType(Integer audioType)

Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

Parameters:

audioType - Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.

Returns:

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

audioTypeControl

AudioDescription.Builder audioTypeControl(String audioTypeControl)

When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.

Parameters:

audioTypeControl - When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.

Returns:

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

See Also:

AudioTypeControl, AudioTypeControl

audioTypeControl

AudioDescription.Builder audioTypeControl(AudioTypeControl audioTypeControl)

When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.

Parameters:

audioTypeControl - When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.

Returns:

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

See Also:

AudioTypeControl, AudioTypeControl

codecSettings

AudioDescription.Builder codecSettings(AudioCodecSettings codecSettings)

Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings

Parameters:

codecSettings - Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings

Returns:

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

codecSettings

default AudioDescription.Builder codecSettings(Consumer<AudioCodecSettings.Builder> codecSettings)

Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings This is a convenience that creates an instance of the AudioCodecSettings.Builder avoiding the need to create one manually via AudioCodecSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to codecSettings(AudioCodecSettings).

Parameters:

codecSettings - a consumer that will call methods on AudioCodecSettings.Builder

Returns:

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

See Also:

codecSettings(AudioCodecSettings)

customLanguageCode

AudioDescription.Builder customLanguageCode(String customLanguageCode)

Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

Parameters:

customLanguageCode - Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' 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.

languageCode

AudioDescription.Builder languageCode(String languageCode)

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

Parameters:

languageCode - Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' 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:

LanguageCode, LanguageCode

languageCode

AudioDescription.Builder languageCode(LanguageCode languageCode)

Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.

Parameters:

languageCode - Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' 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:

LanguageCode, LanguageCode

languageCodeControl

AudioDescription.Builder languageCodeControl(String languageCodeControl)

Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input.

Parameters:

languageCodeControl - Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT 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:

AudioLanguageCodeControl, AudioLanguageCodeControl

languageCodeControl

AudioDescription.Builder languageCodeControl(AudioLanguageCodeControl languageCodeControl)

Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input.

Parameters:

languageCodeControl - Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT 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:

AudioLanguageCodeControl, AudioLanguageCodeControl

remixSettings

AudioDescription.Builder remixSettings(RemixSettings remixSettings)

Advanced audio remixing settings.

Parameters:

remixSettings - Advanced audio remixing settings.

Returns:

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

remixSettings

default AudioDescription.Builder remixSettings(Consumer<RemixSettings.Builder> remixSettings)

Advanced audio remixing settings. This is a convenience that creates an instance of the RemixSettings.Builder avoiding the need to create one manually via RemixSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to remixSettings(RemixSettings).

Parameters:

remixSettings - a consumer that will call methods on RemixSettings.Builder

Returns:

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

See Also:

remixSettings(RemixSettings)

streamName

AudioDescription.Builder streamName(String streamName)

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.

Parameters:

streamName - Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal.

Returns:

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