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	audioChannelTaggingSettings(AudioChannelTaggingSettings audioChannelTaggingSettings) When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually.
default AudioDescription.Builder	audioChannelTaggingSettings(Consumer<AudioChannelTaggingSettings.Builder> audioChannelTaggingSettings) When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually.
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) Settings related to audio encoding.
default AudioDescription.Builder	codecSettings(Consumer<AudioCodecSettings.Builder> codecSettings) Settings related to audio encoding.
AudioDescription.Builder	customLanguageCode(String customLanguageCode) Specify the language for this audio output track.
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) Specify which source for language code takes precedence for this audio track.
AudioDescription.Builder	languageCodeControl(String languageCodeControl) Specify which source for language code takes precedence for this audio track.
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) Specify a label for this output audio stream.

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

audioChannelTaggingSettings

AudioDescription.Builder audioChannelTaggingSettings(AudioChannelTaggingSettings audioChannelTaggingSettings)

When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel.

Parameters:

audioChannelTaggingSettings - When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel.

Returns:

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

audioChannelTaggingSettings

default AudioDescription.Builder audioChannelTaggingSettings(Consumer<AudioChannelTaggingSettings.Builder> audioChannelTaggingSettings)

When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually. For example, you would tag the tracks that contain your left, right, and center audio with Left (L), Right (R), and Center (C), respectively. When you don't specify a value, MediaConvert labels your track as Center (C) by default. To use audio layout tagging, your output must be in a QuickTime (.mov) container; your audio codec must be AAC, WAV, or AIFF; and you must set up your audio track to have only one channel. This is a convenience method that creates an instance of the AudioChannelTaggingSettings.Builder avoiding the need to create one manually via AudioChannelTaggingSettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audioChannelTaggingSettings(AudioChannelTaggingSettings).

Parameters:

audioChannelTaggingSettings - a consumer that will call methods on AudioChannelTaggingSettings.Builder

Returns:

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

See Also:

audioChannelTaggingSettings(AudioChannelTaggingSettings)

audioNormalizationSettings

AudioDescription.Builder audioNormalizationSettings(AudioNormalizationSettings audioNormalizationSettings)

Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.

Parameters:

audioNormalizationSettings - Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.

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. Ignore these settings unless you need to comply with a loudness standard. This is a convenience method 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)

Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.

Parameters:

codecSettings - Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.

Returns:

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

codecSettings

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

Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec. This is a convenience method 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. The service puts this language code into your output audio track when you set Language code control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also uses your specified custom language code when you set Language code control (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file doesn't specify a language code. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

Parameters:

customLanguageCode - Specify the language for this audio output track. The service puts this language code into your output audio track when you set Language code control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The service also uses your specified custom language code when you set Language code control (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file doesn't specify a language code. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.

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)

Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.

Parameters:

languageCodeControl - Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.

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)

Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.

Parameters:

languageCodeControl - Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.

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

Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Parameters:

streamName - Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.

Returns:

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