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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

Note:

When making an API call, you may pass AudioDescription data as a hash:

{
  audio_normalization_settings: {
    algorithm: "ITU_BS_1770_1", # accepts ITU_BS_1770_1, ITU_BS_1770_2
    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: { # required
    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", # required, 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, # required
      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", # required, accepts AAC, MP2, WAV, AIFF, AC3, EAC3, PASSTHROUGH
    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,
    },
    wav_settings: {
      bit_depth: 1,
      channels: 1,
      format: "RIFF", # accepts RIFF, RF64
      sample_rate: 1,
    },
  },
  custom_language_code: "__stringMin3Max3PatternAZaZ3",
  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: { # required
      output_channels: [ # required
        {
          input_channels: [1], # required
        },
      ],
    },
    channels_in: 1, # required
    channels_out: 1, # required
  },
  stream_name: "__stringPatternWS",
}

Description of audio output

Instance Attribute Summary collapse

Instance Attribute Details

#audio_normalization_settingsTypes::AudioNormalizationSettings

Advanced audio normalization settings.



544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#audio_source_nameString

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)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#audio_typeInteger

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)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#audio_type_controlString

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:

  • (String)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#codec_settingsTypes::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 you choose for Audio codec (Codec). For each codec enum you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings



544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#custom_language_codeString

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

Returns:

  • (String)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#language_codeString

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:

  • (String)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#language_code_controlString

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

Returns:

  • (String)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#remix_settingsTypes::RemixSettings

Advanced audio remixing settings.



544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end

#stream_nameString

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

Returns:

  • (String)


544
545
546
547
548
549
550
551
552
553
554
555
556
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 544

class AudioDescription < Struct.new(
  :audio_normalization_settings,
  :audio_source_name,
  :audio_type,
  :audio_type_control,
  :codec_settings,
  :custom_language_code,
  :language_code,
  :language_code_control,
  :remix_settings,
  :stream_name)
  include Aws::Structure
end