You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaConvert::Types::AudioDescription

Inherits:

Struct

Object
Struct
Aws::MediaConvert::Types::AudioDescription

show all

Defined in:: (unknown)

Overview

Note:

When passing AudioDescription as input to an Aws::Client method, you can use a vanilla Hash:

{
  audio_channel_tagging_settings: {
    channel_tag: "L", # accepts L, R, C, LFE, LS, RS, LC, RC, CS, LSD, RSD, TCS, VHL, VHC, VHR
  },
  audio_normalization_settings: {
    algorithm: "ITU_BS_1770_1", # accepts ITU_BS_1770_1, ITU_BS_1770_2, ITU_BS_1770_3, ITU_BS_1770_4
    algorithm_control: "CORRECT_AUDIO", # accepts CORRECT_AUDIO, MEASURE_ONLY
    correction_gate_level: 1,
    loudness_logging: "LOG", # accepts LOG, DONT_LOG
    peak_calculation: "TRUE_PEAK", # accepts TRUE_PEAK, NONE
    target_lkfs: 1.0,
  },
  audio_source_name: "__string",
  audio_type: 1,
  audio_type_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
  codec_settings: {
    aac_settings: {
      audio_description_broadcaster_mix: "BROADCASTER_MIXED_AD", # accepts BROADCASTER_MIXED_AD, NORMAL
      bitrate: 1,
      codec_profile: "LC", # accepts LC, HEV1, HEV2
      coding_mode: "AD_RECEIVER_MIX", # accepts AD_RECEIVER_MIX, CODING_MODE_1_0, CODING_MODE_1_1, CODING_MODE_2_0, CODING_MODE_5_1
      rate_control_mode: "CBR", # accepts CBR, VBR
      raw_format: "LATM_LOAS", # accepts LATM_LOAS, NONE
      sample_rate: 1,
      specification: "MPEG2", # accepts MPEG2, MPEG4
      vbr_quality: "LOW", # accepts LOW, MEDIUM_LOW, MEDIUM_HIGH, HIGH
    },
    ac_3_settings: {
      bitrate: 1,
      bitstream_mode: "COMPLETE_MAIN", # accepts COMPLETE_MAIN, COMMENTARY, DIALOGUE, EMERGENCY, HEARING_IMPAIRED, MUSIC_AND_EFFECTS, VISUALLY_IMPAIRED, VOICE_OVER
      coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_1_1, CODING_MODE_2_0, CODING_MODE_3_2_LFE
      dialnorm: 1,
      dynamic_range_compression_profile: "FILM_STANDARD", # accepts FILM_STANDARD, NONE
      lfe_filter: "ENABLED", # accepts ENABLED, DISABLED
      metadata_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
      sample_rate: 1,
    },
    aiff_settings: {
      bit_depth: 1,
      channels: 1,
      sample_rate: 1,
    },
    codec: "AAC", # accepts AAC, MP2, MP3, WAV, AIFF, AC3, EAC3, EAC3_ATMOS, VORBIS, OPUS, PASSTHROUGH
    eac_3_atmos_settings: {
      bitrate: 1,
      bitstream_mode: "COMPLETE_MAIN", # accepts COMPLETE_MAIN
      coding_mode: "CODING_MODE_9_1_6", # accepts CODING_MODE_9_1_6
      dialogue_intelligence: "ENABLED", # accepts ENABLED, DISABLED
      dynamic_range_compression_line: "NONE", # accepts NONE, FILM_STANDARD, FILM_LIGHT, MUSIC_STANDARD, MUSIC_LIGHT, SPEECH
      dynamic_range_compression_rf: "NONE", # accepts NONE, FILM_STANDARD, FILM_LIGHT, MUSIC_STANDARD, MUSIC_LIGHT, SPEECH
      lo_ro_center_mix_level: 1.0,
      lo_ro_surround_mix_level: 1.0,
      lt_rt_center_mix_level: 1.0,
      lt_rt_surround_mix_level: 1.0,
      metering_mode: "LEQ_A", # accepts LEQ_A, ITU_BS_1770_1, ITU_BS_1770_2, ITU_BS_1770_3, ITU_BS_1770_4
      sample_rate: 1,
      speech_threshold: 1,
      stereo_downmix: "NOT_INDICATED", # accepts NOT_INDICATED, STEREO, SURROUND, DPL2
      surround_ex_mode: "NOT_INDICATED", # accepts NOT_INDICATED, ENABLED, DISABLED
    },
    eac_3_settings: {
      attenuation_control: "ATTENUATE_3_DB", # accepts ATTENUATE_3_DB, NONE
      bitrate: 1,
      bitstream_mode: "COMPLETE_MAIN", # accepts COMPLETE_MAIN, COMMENTARY, EMERGENCY, HEARING_IMPAIRED, VISUALLY_IMPAIRED
      coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0, CODING_MODE_3_2
      dc_filter: "ENABLED", # accepts ENABLED, DISABLED
      dialnorm: 1,
      dynamic_range_compression_line: "NONE", # accepts NONE, FILM_STANDARD, FILM_LIGHT, MUSIC_STANDARD, MUSIC_LIGHT, SPEECH
      dynamic_range_compression_rf: "NONE", # accepts NONE, FILM_STANDARD, FILM_LIGHT, MUSIC_STANDARD, MUSIC_LIGHT, SPEECH
      lfe_control: "LFE", # accepts LFE, NO_LFE
      lfe_filter: "ENABLED", # accepts ENABLED, DISABLED
      lo_ro_center_mix_level: 1.0,
      lo_ro_surround_mix_level: 1.0,
      lt_rt_center_mix_level: 1.0,
      lt_rt_surround_mix_level: 1.0,
      metadata_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
      passthrough_control: "WHEN_POSSIBLE", # accepts WHEN_POSSIBLE, NO_PASSTHROUGH
      phase_control: "SHIFT_90_DEGREES", # accepts SHIFT_90_DEGREES, NO_SHIFT
      sample_rate: 1,
      stereo_downmix: "NOT_INDICATED", # accepts NOT_INDICATED, LO_RO, LT_RT, DPL2
      surround_ex_mode: "NOT_INDICATED", # accepts NOT_INDICATED, ENABLED, DISABLED
      surround_mode: "NOT_INDICATED", # accepts NOT_INDICATED, ENABLED, DISABLED
    },
    mp_2_settings: {
      bitrate: 1,
      channels: 1,
      sample_rate: 1,
    },
    mp_3_settings: {
      bitrate: 1,
      channels: 1,
      rate_control_mode: "CBR", # accepts CBR, VBR
      sample_rate: 1,
      vbr_quality: 1,
    },
    opus_settings: {
      bitrate: 1,
      channels: 1,
      sample_rate: 1,
    },
    vorbis_settings: {
      channels: 1,
      sample_rate: 1,
      vbr_quality: 1,
    },
    wav_settings: {
      bit_depth: 1,
      channels: 1,
      format: "RIFF", # accepts RIFF, RF64
      sample_rate: 1,
    },
  },
  custom_language_code: "__stringPatternAZaZ23AZaZ",
  language_code: "ENG", # accepts ENG, SPA, FRA, DEU, GER, ZHO, ARA, HIN, JPN, RUS, POR, ITA, URD, VIE, KOR, PAN, ABK, AAR, AFR, AKA, SQI, AMH, ARG, HYE, ASM, AVA, AVE, AYM, AZE, BAM, BAK, EUS, BEL, BEN, BIH, BIS, BOS, BRE, BUL, MYA, CAT, KHM, CHA, CHE, NYA, CHU, CHV, COR, COS, CRE, HRV, CES, DAN, DIV, NLD, DZO, ENM, EPO, EST, EWE, FAO, FIJ, FIN, FRM, FUL, GLA, GLG, LUG, KAT, ELL, GRN, GUJ, HAT, HAU, HEB, HER, HMO, HUN, ISL, IDO, IBO, IND, INA, ILE, IKU, IPK, GLE, JAV, KAL, KAN, KAU, KAS, KAZ, KIK, KIN, KIR, KOM, KON, KUA, KUR, LAO, LAT, LAV, LIM, LIN, LIT, LUB, LTZ, MKD, MLG, MSA, MAL, MLT, GLV, MRI, MAR, MAH, MON, NAU, NAV, NDE, NBL, NDO, NEP, SME, NOR, NOB, NNO, OCI, OJI, ORI, ORM, OSS, PLI, FAS, POL, PUS, QUE, QAA, RON, ROH, RUN, SMO, SAG, SAN, SRD, SRB, SNA, III, SND, SIN, SLK, SLV, SOM, SOT, SUN, SWA, SSW, SWE, TGL, TAH, TGK, TAM, TAT, TEL, THA, BOD, TIR, TON, TSO, TSN, TUR, TUK, TWI, UIG, UKR, UZB, VEN, VOL, WLN, CYM, FRY, WOL, XHO, YID, YOR, ZHA, ZUL, ORJ, QPC, TNG
  language_code_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
  remix_settings: {
    channel_mapping: {
      output_channels: [
        {
          input_channels: [1],
        },
      ],
    },
    channels_in: 1,
    channels_out: 1,
  },
  stream_name: "__stringPatternWS",
}

Description of audio output

Instance Attribute Summary collapse

#audio_channel_tagging_settings ⇒ Types::AudioChannelTaggingSettings
When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually.
#audio_normalization_settings ⇒ Types::AudioNormalizationSettings
Advanced audio normalization settings.
#audio_source_name ⇒ String
Specifies which audio data to use from each input.
#audio_type ⇒ Integer
Applies only if Follow Input Audio Type is unchecked (false).
#audio_type_control ⇒ String
When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output.
#codec_settings ⇒ Types::AudioCodecSettings
Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding.
#custom_language_code ⇒ String
Specify the language for this audio output track.
#language_code ⇒ String
Indicates the language of the audio output track.
#language_code_control ⇒ String
Specify which source for language code takes precedence for this audio track.
#remix_settings ⇒ Types::RemixSettings
Advanced audio remixing settings.
#stream_name ⇒ String
Specify a label for this output audio stream.

Instance Attribute Details

#audio_channel_tagging_settings ⇒ `Types::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:

(Types::AudioChannelTaggingSettings) —
When you mimic a multi-channel audio layout with multiple mono-channel tracks, you can tag each channel layout manually.

#audio_normalization_settings ⇒ `Types::AudioNormalizationSettings`

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

Returns:

(Types::AudioNormalizationSettings) —
Advanced audio normalization settings.

#audio_source_name ⇒ `String`

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:

(String) —
Specifies which audio data to use from each input.

#audio_type ⇒ `Integer`

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:

(Integer) —
Applies only if Follow Input Audio Type is unchecked (false).

#audio_type_control ⇒ `String`

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.

Possible values:

FOLLOW_INPUT
USE_CONFIGURED

Returns:

(String) —
When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output.

#codec_settings ⇒ `Types::AudioCodecSettings`

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 that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings * VORBIS, VorbisSettings * OPUS, OpusSettings

Returns:

(Types::AudioCodecSettings) —
Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding.

#custom_language_code ⇒ `String`

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:

(String) —
Specify the language for this audio output track.

#language_code ⇒ `String`

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.

Possible values:

ENG
SPA
FRA
DEU
GER
ZHO
ARA
HIN
JPN
RUS
POR
ITA
URD
VIE
KOR
PAN
ABK
AAR
AFR
AKA
SQI
AMH
ARG
HYE
ASM
AVA
AVE
AYM
AZE
BAM
BAK
EUS
BEL
BEN
BIH
BIS
BOS
BRE
BUL
MYA
CAT
KHM
CHA
CHE
NYA
CHU
CHV
COR
COS
CRE
HRV
CES
DAN
DIV
NLD
DZO
ENM
EPO
EST
EWE
FAO
FIJ
FIN
FRM
FUL
GLA
GLG
LUG
KAT
ELL
GRN
GUJ
HAT
HAU
HEB
HER
HMO
HUN
ISL
IDO
IBO
IND
INA
ILE
IKU
IPK
GLE
JAV
KAL
KAN
KAU
KAS
KAZ
KIK
KIN
KIR
KOM
KON
KUA
KUR
LAO
LAT
LAV
LIM
LIN
LIT
LUB
LTZ
MKD
MLG
MSA
MAL
MLT
GLV
MRI
MAR
MAH
MON
NAU
NAV
NDE
NBL
NDO
NEP
SME
NOR
NOB
NNO
OCI
OJI
ORI
ORM
OSS
PLI
FAS
POL
PUS
QUE
QAA
RON
ROH
RUN
SMO
SAG
SAN
SRD
SRB
SNA
III
SND
SIN
SLK
SLV
SOM
SOT
SUN
SWA
SSW
SWE
TGL
TAH
TGK
TAM
TAT
TEL
THA
BOD
TIR
TON
TSO
TSN
TUR
TUK
TWI
UIG
UKR
UZB
VEN
VOL
WLN
CYM
FRY
WOL
XHO
YID
YOR
ZHA
ZUL
ORJ
QPC
TNG

Returns:

(String) —
Indicates the language of the audio output track.

#language_code_control ⇒ `String`

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.

Possible values:

FOLLOW_INPUT
USE_CONFIGURED

Returns:

(String) —
Specify which source for language code takes precedence for this audio track.

#remix_settings ⇒ `Types::RemixSettings`

Advanced audio remixing settings.

Returns:

(Types::RemixSettings) —
Advanced audio remixing settings.

#stream_name ⇒ `String`

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:

(String) —
Specify a label for this output audio stream.

Class: Aws::MediaConvert::Types::AudioDescription

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#audio_channel_tagging_settings ⇒ Types::AudioChannelTaggingSettings

#audio_normalization_settings ⇒ Types::AudioNormalizationSettings

#audio_source_name ⇒ String

#audio_type ⇒ Integer

#audio_type_control ⇒ String

#codec_settings ⇒ Types::AudioCodecSettings

#custom_language_code ⇒ String

#language_code ⇒ String

#language_code_control ⇒ String

#remix_settings ⇒ Types::RemixSettings

#stream_name ⇒ String

#audio_channel_tagging_settings ⇒ `Types::AudioChannelTaggingSettings`

#audio_normalization_settings ⇒ `Types::AudioNormalizationSettings`

#audio_source_name ⇒ `String`

#audio_type ⇒ `Integer`

#audio_type_control ⇒ `String`

#codec_settings ⇒ `Types::AudioCodecSettings`

#custom_language_code ⇒ `String`

#language_code ⇒ `String`

#language_code_control ⇒ `String`

#remix_settings ⇒ `Types::RemixSettings`

#stream_name ⇒ `String`