AudioDescription (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.20.110 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.AudioDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AudioDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AudioDescription.Builder,AudioDescription>
```
Settings related to one audio tab on the MediaConvert console. In your job JSON, an instance of AudioDescription is equivalent to one audio tab in the console. Usually, one audio tab corresponds to one output audio track. Depending on how you set up your input audio selectors and whether you use audio selector groups, one audio tab can correspond to a group of output audio tracks.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AudioDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AudioDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AudioChannelTaggingSettings`	`audioChannelTaggingSettings()` When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually.
`AudioNormalizationSettings`	`audioNormalizationSettings()` Advanced audio normalization settings.
`String`	`audioSourceName()` Specifies which audio data to use from each input.
`Integer`	`audioType()` Applies only if Follow Input Audio Type is unchecked (false).
`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.
`String`	`audioTypeControlAsString()` When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output.
`static AudioDescription.Builder`	`builder()`
`AudioCodecSettings`	`codecSettings()` Settings related to audio encoding.
`String`	`customLanguageCode()` Specify the language for this audio output track.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`LanguageCode`	`languageCode()` Indicates the language of the audio output track.
`String`	`languageCodeAsString()` Indicates the language of the audio output track.
`AudioLanguageCodeControl`	`languageCodeControl()` Specify which source for language code takes precedence for this audio track.
`String`	`languageCodeControlAsString()` Specify which source for language code takes precedence for this audio track.
`RemixSettings`	`remixSettings()` Advanced audio remixing settings.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AudioDescription.Builder>`	`serializableBuilderClass()`
`String`	`streamName()` Specify a label for this output audio stream.
`AudioDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - audioChannelTaggingSettings
```
public final 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.
    
    Returns:
    
    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.
  - audioNormalizationSettings
```
public final AudioNormalizationSettings audioNormalizationSettings()
```
    Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
    
    Returns:
    
    Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.
  - audioSourceName
```
public final 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.
    
    Returns:
    
    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.
  - audioType
```
public final 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.
    
    Returns:
    
    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.
  - audioTypeControl
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, audioTypeControl will return AudioTypeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioTypeControlAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AudioTypeControl
  - audioTypeControlAsString
```
public final String audioTypeControlAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, audioTypeControl will return AudioTypeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from audioTypeControlAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AudioTypeControl
  - codecSettings
```
public final AudioCodecSettings codecSettings()
```
    Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
    
    Returns:
    
    Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
  - customLanguageCode
```
public final 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.
    
    Returns:
    
    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.
  - languageCode
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    LanguageCode
  - languageCodeControl
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, languageCodeControl will return AudioLanguageCodeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeControlAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AudioLanguageCodeControl
  - languageCodeControlAsString
```
public final String languageCodeControlAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, languageCodeControl will return AudioLanguageCodeControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeControlAsString().
    
    Returns:
    
    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.
    
    See Also:
    
    AudioLanguageCodeControl
  - remixSettings
```
public final RemixSettings remixSettings()
```
    Advanced audio remixing settings.
    
    Returns:
    
    Advanced audio remixing settings.
  - streamName
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public AudioDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AudioDescription.Builder,AudioDescription>
  - builder
```
public static AudioDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AudioDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AudioDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

audioChannelTaggingSettings

audioNormalizationSettings

audioSourceName

audioType

audioTypeControl

audioTypeControlAsString

codecSettings

customLanguageCode

languageCode

languageCodeAsString

languageCodeControl

languageCodeControlAsString

remixSettings

streamName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields