AWS SDK for C++  1.9.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::AudioDescription Class Reference

#include <AudioDescription.h>

Public Member Functions

 AudioDescription ()
 
 AudioDescription (Aws::Utils::Json::JsonView jsonValue)
 
AudioDescriptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AudioChannelTaggingSettingsGetAudioChannelTaggingSettings () const
 
bool AudioChannelTaggingSettingsHasBeenSet () const
 
void SetAudioChannelTaggingSettings (const AudioChannelTaggingSettings &value)
 
void SetAudioChannelTaggingSettings (AudioChannelTaggingSettings &&value)
 
AudioDescriptionWithAudioChannelTaggingSettings (const AudioChannelTaggingSettings &value)
 
AudioDescriptionWithAudioChannelTaggingSettings (AudioChannelTaggingSettings &&value)
 
const AudioNormalizationSettingsGetAudioNormalizationSettings () const
 
bool AudioNormalizationSettingsHasBeenSet () const
 
void SetAudioNormalizationSettings (const AudioNormalizationSettings &value)
 
void SetAudioNormalizationSettings (AudioNormalizationSettings &&value)
 
AudioDescriptionWithAudioNormalizationSettings (const AudioNormalizationSettings &value)
 
AudioDescriptionWithAudioNormalizationSettings (AudioNormalizationSettings &&value)
 
const Aws::StringGetAudioSourceName () const
 
bool AudioSourceNameHasBeenSet () const
 
void SetAudioSourceName (const Aws::String &value)
 
void SetAudioSourceName (Aws::String &&value)
 
void SetAudioSourceName (const char *value)
 
AudioDescriptionWithAudioSourceName (const Aws::String &value)
 
AudioDescriptionWithAudioSourceName (Aws::String &&value)
 
AudioDescriptionWithAudioSourceName (const char *value)
 
int GetAudioType () const
 
bool AudioTypeHasBeenSet () const
 
void SetAudioType (int value)
 
AudioDescriptionWithAudioType (int value)
 
const AudioTypeControlGetAudioTypeControl () const
 
bool AudioTypeControlHasBeenSet () const
 
void SetAudioTypeControl (const AudioTypeControl &value)
 
void SetAudioTypeControl (AudioTypeControl &&value)
 
AudioDescriptionWithAudioTypeControl (const AudioTypeControl &value)
 
AudioDescriptionWithAudioTypeControl (AudioTypeControl &&value)
 
const AudioCodecSettingsGetCodecSettings () const
 
bool CodecSettingsHasBeenSet () const
 
void SetCodecSettings (const AudioCodecSettings &value)
 
void SetCodecSettings (AudioCodecSettings &&value)
 
AudioDescriptionWithCodecSettings (const AudioCodecSettings &value)
 
AudioDescriptionWithCodecSettings (AudioCodecSettings &&value)
 
const Aws::StringGetCustomLanguageCode () const
 
bool CustomLanguageCodeHasBeenSet () const
 
void SetCustomLanguageCode (const Aws::String &value)
 
void SetCustomLanguageCode (Aws::String &&value)
 
void SetCustomLanguageCode (const char *value)
 
AudioDescriptionWithCustomLanguageCode (const Aws::String &value)
 
AudioDescriptionWithCustomLanguageCode (Aws::String &&value)
 
AudioDescriptionWithCustomLanguageCode (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
AudioDescriptionWithLanguageCode (const LanguageCode &value)
 
AudioDescriptionWithLanguageCode (LanguageCode &&value)
 
const AudioLanguageCodeControlGetLanguageCodeControl () const
 
bool LanguageCodeControlHasBeenSet () const
 
void SetLanguageCodeControl (const AudioLanguageCodeControl &value)
 
void SetLanguageCodeControl (AudioLanguageCodeControl &&value)
 
AudioDescriptionWithLanguageCodeControl (const AudioLanguageCodeControl &value)
 
AudioDescriptionWithLanguageCodeControl (AudioLanguageCodeControl &&value)
 
const RemixSettingsGetRemixSettings () const
 
bool RemixSettingsHasBeenSet () const
 
void SetRemixSettings (const RemixSettings &value)
 
void SetRemixSettings (RemixSettings &&value)
 
AudioDescriptionWithRemixSettings (const RemixSettings &value)
 
AudioDescriptionWithRemixSettings (RemixSettings &&value)
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
AudioDescriptionWithStreamName (const Aws::String &value)
 
AudioDescriptionWithStreamName (Aws::String &&value)
 
AudioDescriptionWithStreamName (const char *value)
 

Detailed Description

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:

AWS API Reference

Definition at line 43 of file AudioDescription.h.

Constructor & Destructor Documentation

◆ AudioDescription() [1/2]

Aws::MediaConvert::Model::AudioDescription::AudioDescription ( )

◆ AudioDescription() [2/2]

Aws::MediaConvert::Model::AudioDescription::AudioDescription ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AudioChannelTaggingSettingsHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::AudioChannelTaggingSettingsHasBeenSet ( ) const
inline

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.

Definition at line 72 of file AudioDescription.h.

◆ AudioNormalizationSettingsHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::AudioNormalizationSettingsHasBeenSet ( ) const
inline

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

Definition at line 129 of file AudioDescription.h.

◆ AudioSourceNameHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::AudioSourceNameHasBeenSet ( ) const
inline

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.

Definition at line 182 of file AudioDescription.h.

◆ AudioTypeControlHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::AudioTypeControlHasBeenSet ( ) const
inline

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.

Definition at line 320 of file AudioDescription.h.

◆ AudioTypeHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::AudioTypeHasBeenSet ( ) const
inline

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.

Definition at line 283 of file AudioDescription.h.

◆ CodecSettingsHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::CodecSettingsHasBeenSet ( ) const
inline

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

Definition at line 373 of file AudioDescription.h.

◆ CustomLanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::CustomLanguageCodeHasBeenSet ( ) const
inline

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.

Definition at line 426 of file AudioDescription.h.

◆ GetAudioChannelTaggingSettings()

const AudioChannelTaggingSettings& Aws::MediaConvert::Model::AudioDescription::GetAudioChannelTaggingSettings ( ) const
inline

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.

Definition at line 61 of file AudioDescription.h.

◆ GetAudioNormalizationSettings()

const AudioNormalizationSettings& Aws::MediaConvert::Model::AudioDescription::GetAudioNormalizationSettings ( ) const
inline

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

Definition at line 123 of file AudioDescription.h.

◆ GetAudioSourceName()

const Aws::String& Aws::MediaConvert::Model::AudioDescription::GetAudioSourceName ( ) const
inline

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.

Definition at line 168 of file AudioDescription.h.

◆ GetAudioType()

int Aws::MediaConvert::Model::AudioDescription::GetAudioType ( ) const
inline

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.

Definition at line 275 of file AudioDescription.h.

◆ GetAudioTypeControl()

const AudioTypeControl& Aws::MediaConvert::Model::AudioDescription::GetAudioTypeControl ( ) const
inline

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.

Definition at line 310 of file AudioDescription.h.

◆ GetCodecSettings()

const AudioCodecSettings& Aws::MediaConvert::Model::AudioDescription::GetCodecSettings ( ) const
inline

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

Definition at line 367 of file AudioDescription.h.

◆ GetCustomLanguageCode()

const Aws::String& Aws::MediaConvert::Model::AudioDescription::GetCustomLanguageCode ( ) const
inline

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.

Definition at line 412 of file AudioDescription.h.

◆ GetLanguageCode()

const LanguageCode& Aws::MediaConvert::Model::AudioDescription::GetLanguageCode ( ) const
inline

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.

Definition at line 519 of file AudioDescription.h.

◆ GetLanguageCodeControl()

const AudioLanguageCodeControl& Aws::MediaConvert::Model::AudioDescription::GetLanguageCodeControl ( ) const
inline

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.

Definition at line 570 of file AudioDescription.h.

◆ GetRemixSettings()

const RemixSettings& Aws::MediaConvert::Model::AudioDescription::GetRemixSettings ( ) const
inline

Advanced audio remixing settings.

Definition at line 626 of file AudioDescription.h.

◆ GetStreamName()

const Aws::String& Aws::MediaConvert::Model::AudioDescription::GetStreamName ( ) const
inline

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.

Definition at line 660 of file AudioDescription.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::AudioDescription::Jsonize ( ) const

◆ LanguageCodeControlHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::LanguageCodeControlHasBeenSet ( ) const
inline

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.

Definition at line 580 of file AudioDescription.h.

◆ LanguageCodeHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::LanguageCodeHasBeenSet ( ) const
inline

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.

Definition at line 527 of file AudioDescription.h.

◆ operator=()

AudioDescription& Aws::MediaConvert::Model::AudioDescription::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RemixSettingsHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::RemixSettingsHasBeenSet ( ) const
inline

Advanced audio remixing settings.

Definition at line 631 of file AudioDescription.h.

◆ SetAudioChannelTaggingSettings() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioChannelTaggingSettings ( AudioChannelTaggingSettings &&  value)
inline

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.

Definition at line 94 of file AudioDescription.h.

◆ SetAudioChannelTaggingSettings() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioChannelTaggingSettings ( const AudioChannelTaggingSettings value)
inline

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.

Definition at line 83 of file AudioDescription.h.

◆ SetAudioNormalizationSettings() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioNormalizationSettings ( AudioNormalizationSettings &&  value)
inline

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

Definition at line 141 of file AudioDescription.h.

◆ SetAudioNormalizationSettings() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioNormalizationSettings ( const AudioNormalizationSettings value)
inline

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

Definition at line 135 of file AudioDescription.h.

◆ SetAudioSourceName() [1/3]

void Aws::MediaConvert::Model::AudioDescription::SetAudioSourceName ( Aws::String &&  value)
inline

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.

Definition at line 210 of file AudioDescription.h.

◆ SetAudioSourceName() [2/3]

void Aws::MediaConvert::Model::AudioDescription::SetAudioSourceName ( const Aws::String value)
inline

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.

Definition at line 196 of file AudioDescription.h.

◆ SetAudioSourceName() [3/3]

void Aws::MediaConvert::Model::AudioDescription::SetAudioSourceName ( const char *  value)
inline

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.

Definition at line 224 of file AudioDescription.h.

◆ SetAudioType()

void Aws::MediaConvert::Model::AudioDescription::SetAudioType ( int  value)
inline

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.

Definition at line 291 of file AudioDescription.h.

◆ SetAudioTypeControl() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioTypeControl ( AudioTypeControl &&  value)
inline

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.

Definition at line 340 of file AudioDescription.h.

◆ SetAudioTypeControl() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetAudioTypeControl ( const AudioTypeControl value)
inline

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.

Definition at line 330 of file AudioDescription.h.

◆ SetCodecSettings() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetCodecSettings ( AudioCodecSettings &&  value)
inline

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

Definition at line 385 of file AudioDescription.h.

◆ SetCodecSettings() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetCodecSettings ( const AudioCodecSettings value)
inline

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

Definition at line 379 of file AudioDescription.h.

◆ SetCustomLanguageCode() [1/3]

void Aws::MediaConvert::Model::AudioDescription::SetCustomLanguageCode ( Aws::String &&  value)
inline

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.

Definition at line 454 of file AudioDescription.h.

◆ SetCustomLanguageCode() [2/3]

void Aws::MediaConvert::Model::AudioDescription::SetCustomLanguageCode ( const Aws::String value)
inline

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.

Definition at line 440 of file AudioDescription.h.

◆ SetCustomLanguageCode() [3/3]

void Aws::MediaConvert::Model::AudioDescription::SetCustomLanguageCode ( const char *  value)
inline

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.

Definition at line 468 of file AudioDescription.h.

◆ SetLanguageCode() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetLanguageCode ( const LanguageCode value)
inline

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.

Definition at line 535 of file AudioDescription.h.

◆ SetLanguageCode() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetLanguageCode ( LanguageCode &&  value)
inline

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.

Definition at line 543 of file AudioDescription.h.

◆ SetLanguageCodeControl() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetLanguageCodeControl ( AudioLanguageCodeControl &&  value)
inline

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.

Definition at line 600 of file AudioDescription.h.

◆ SetLanguageCodeControl() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetLanguageCodeControl ( const AudioLanguageCodeControl value)
inline

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.

Definition at line 590 of file AudioDescription.h.

◆ SetRemixSettings() [1/2]

void Aws::MediaConvert::Model::AudioDescription::SetRemixSettings ( const RemixSettings value)
inline

Advanced audio remixing settings.

Definition at line 636 of file AudioDescription.h.

◆ SetRemixSettings() [2/2]

void Aws::MediaConvert::Model::AudioDescription::SetRemixSettings ( RemixSettings &&  value)
inline

Advanced audio remixing settings.

Definition at line 641 of file AudioDescription.h.

◆ SetStreamName() [1/3]

void Aws::MediaConvert::Model::AudioDescription::SetStreamName ( Aws::String &&  value)
inline

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.

Definition at line 684 of file AudioDescription.h.

◆ SetStreamName() [2/3]

void Aws::MediaConvert::Model::AudioDescription::SetStreamName ( const Aws::String value)
inline

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.

Definition at line 676 of file AudioDescription.h.

◆ SetStreamName() [3/3]

void Aws::MediaConvert::Model::AudioDescription::SetStreamName ( const char *  value)
inline

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.

Definition at line 692 of file AudioDescription.h.

◆ StreamNameHasBeenSet()

bool Aws::MediaConvert::Model::AudioDescription::StreamNameHasBeenSet ( ) const
inline

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.

Definition at line 668 of file AudioDescription.h.

◆ WithAudioChannelTaggingSettings() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioChannelTaggingSettings ( AudioChannelTaggingSettings &&  value)
inline

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.

Definition at line 116 of file AudioDescription.h.

◆ WithAudioChannelTaggingSettings() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioChannelTaggingSettings ( const AudioChannelTaggingSettings value)
inline

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.

Definition at line 105 of file AudioDescription.h.

◆ WithAudioNormalizationSettings() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioNormalizationSettings ( AudioNormalizationSettings &&  value)
inline

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

Definition at line 153 of file AudioDescription.h.

◆ WithAudioNormalizationSettings() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioNormalizationSettings ( const AudioNormalizationSettings value)
inline

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

Definition at line 147 of file AudioDescription.h.

◆ WithAudioSourceName() [1/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioSourceName ( Aws::String &&  value)
inline

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.

Definition at line 252 of file AudioDescription.h.

◆ WithAudioSourceName() [2/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioSourceName ( const Aws::String value)
inline

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.

Definition at line 238 of file AudioDescription.h.

◆ WithAudioSourceName() [3/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioSourceName ( const char *  value)
inline

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.

Definition at line 266 of file AudioDescription.h.

◆ WithAudioType()

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioType ( int  value)
inline

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.

Definition at line 299 of file AudioDescription.h.

◆ WithAudioTypeControl() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioTypeControl ( AudioTypeControl &&  value)
inline

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.

Definition at line 360 of file AudioDescription.h.

◆ WithAudioTypeControl() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithAudioTypeControl ( const AudioTypeControl value)
inline

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.

Definition at line 350 of file AudioDescription.h.

◆ WithCodecSettings() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithCodecSettings ( AudioCodecSettings &&  value)
inline

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

Definition at line 397 of file AudioDescription.h.

◆ WithCodecSettings() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithCodecSettings ( const AudioCodecSettings value)
inline

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

Definition at line 391 of file AudioDescription.h.

◆ WithCustomLanguageCode() [1/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithCustomLanguageCode ( Aws::String &&  value)
inline

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.

Definition at line 496 of file AudioDescription.h.

◆ WithCustomLanguageCode() [2/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithCustomLanguageCode ( const Aws::String value)
inline

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.

Definition at line 482 of file AudioDescription.h.

◆ WithCustomLanguageCode() [3/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithCustomLanguageCode ( const char *  value)
inline

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.

Definition at line 510 of file AudioDescription.h.

◆ WithLanguageCode() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithLanguageCode ( const LanguageCode value)
inline

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.

Definition at line 551 of file AudioDescription.h.

◆ WithLanguageCode() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithLanguageCode ( LanguageCode &&  value)
inline

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.

Definition at line 559 of file AudioDescription.h.

◆ WithLanguageCodeControl() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithLanguageCodeControl ( AudioLanguageCodeControl &&  value)
inline

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.

Definition at line 620 of file AudioDescription.h.

◆ WithLanguageCodeControl() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithLanguageCodeControl ( const AudioLanguageCodeControl value)
inline

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.

Definition at line 610 of file AudioDescription.h.

◆ WithRemixSettings() [1/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithRemixSettings ( const RemixSettings value)
inline

Advanced audio remixing settings.

Definition at line 646 of file AudioDescription.h.

◆ WithRemixSettings() [2/2]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithRemixSettings ( RemixSettings &&  value)
inline

Advanced audio remixing settings.

Definition at line 651 of file AudioDescription.h.

◆ WithStreamName() [1/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithStreamName ( Aws::String &&  value)
inline

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.

Definition at line 708 of file AudioDescription.h.

◆ WithStreamName() [2/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithStreamName ( const Aws::String value)
inline

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.

Definition at line 700 of file AudioDescription.h.

◆ WithStreamName() [3/3]

AudioDescription& Aws::MediaConvert::Model::AudioDescription::WithStreamName ( const char *  value)
inline

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.

Definition at line 716 of file AudioDescription.h.


The documentation for this class was generated from the following file: