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

Class: Aws::MediaLive::Types::AudioDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

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

{
  audio_normalization_settings: {
    algorithm: "ITU_1770_1", # accepts ITU_1770_1, ITU_1770_2
    algorithm_control: "CORRECT_AUDIO", # accepts CORRECT_AUDIO
    target_lkfs: 1.0,
  },
  audio_selector_name: "__string", # required
  audio_type: "CLEAN_EFFECTS", # accepts CLEAN_EFFECTS, HEARING_IMPAIRED, UNDEFINED, VISUAL_IMPAIRED_COMMENTARY
  audio_type_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
  codec_settings: {
    aac_settings: {
      bitrate: 1.0,
      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
      input_type: "BROADCASTER_MIXED_AD", # accepts BROADCASTER_MIXED_AD, NORMAL
      profile: "HEV1", # accepts HEV1, HEV2, LC
      rate_control_mode: "CBR", # accepts CBR, VBR
      raw_format: "LATM_LOAS", # accepts LATM_LOAS, NONE
      sample_rate: 1.0,
      spec: "MPEG2", # accepts MPEG2, MPEG4
      vbr_quality: "HIGH", # accepts HIGH, LOW, MEDIUM_HIGH, MEDIUM_LOW
    },
    ac_3_settings: {
      bitrate: 1.0,
      bitstream_mode: "COMMENTARY", # accepts COMMENTARY, COMPLETE_MAIN, 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,
      drc_profile: "FILM_STANDARD", # accepts FILM_STANDARD, NONE
      lfe_filter: "DISABLED", # accepts DISABLED, ENABLED
      metadata_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
    },
    eac_3_settings: {
      attenuation_control: "ATTENUATE_3_DB", # accepts ATTENUATE_3_DB, NONE
      bitrate: 1.0,
      bitstream_mode: "COMMENTARY", # accepts COMMENTARY, COMPLETE_MAIN, 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: "DISABLED", # accepts DISABLED, ENABLED
      dialnorm: 1,
      drc_line: "FILM_LIGHT", # accepts FILM_LIGHT, FILM_STANDARD, MUSIC_LIGHT, MUSIC_STANDARD, NONE, SPEECH
      drc_rf: "FILM_LIGHT", # accepts FILM_LIGHT, FILM_STANDARD, MUSIC_LIGHT, MUSIC_STANDARD, NONE, SPEECH
      lfe_control: "LFE", # accepts LFE, NO_LFE
      lfe_filter: "DISABLED", # accepts DISABLED, ENABLED
      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: "NO_PASSTHROUGH", # accepts NO_PASSTHROUGH, WHEN_POSSIBLE
      phase_control: "NO_SHIFT", # accepts NO_SHIFT, SHIFT_90_DEGREES
      stereo_downmix: "DPL2", # accepts DPL2, LO_RO, LT_RT, NOT_INDICATED
      surround_ex_mode: "DISABLED", # accepts DISABLED, ENABLED, NOT_INDICATED
      surround_mode: "DISABLED", # accepts DISABLED, ENABLED, NOT_INDICATED
    },
    mp_2_settings: {
      bitrate: 1.0,
      coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0
      sample_rate: 1.0,
    },
    pass_through_settings: {
    },
    wav_settings: {
      bit_depth: 1.0,
      coding_mode: "CODING_MODE_1_0", # accepts CODING_MODE_1_0, CODING_MODE_2_0, CODING_MODE_4_0, CODING_MODE_8_0
      sample_rate: 1.0,
    },
  },
  language_code: "__stringMin1Max35",
  language_code_control: "FOLLOW_INPUT", # accepts FOLLOW_INPUT, USE_CONFIGURED
  name: "__string", # required
  remix_settings: {
    channel_mappings: [ # required
      {
        input_channel_levels: [ # required
          {
            gain: 1, # required
            input_channel: 1, # required
          },
        ],
        output_channel: 1, # required
      },
    ],
    channels_in: 1,
    channels_out: 1,
  },
  stream_name: "__string",
}

Audio Description

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#audio_normalization_settings ⇒ Types::AudioNormalizationSettings

Advanced audio normalization settings.

Returns:

#audio_selector_name ⇒ String

The name of the AudioSelector used as the source for this AudioDescription.

Returns:

  • (String) —

    The name of the AudioSelector used as the source for this AudioDescription.

#audio_type ⇒ String

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

Possible values:

  • CLEAN_EFFECTS
  • HEARING_IMPAIRED
  • UNDEFINED
  • VISUAL_IMPAIRED_COMMENTARY

Returns:

  • (String) —

    Applies only if audioTypeControl is useConfigured.

#audio_type_control ⇒ String

Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd.

Possible values:

  • FOLLOW_INPUT
  • USE_CONFIGURED

Returns:

  • (String) —

    Determines how audio type is determined.

#codec_settings ⇒ Types::AudioCodecSettings

Audio codec settings.

Returns:

#language_code ⇒ String

RFC 5646 language code representing the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

Returns:

  • (String) —

    RFC 5646 language code representing the language of the audio output track.

#language_code_control ⇒ String

Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

Possible values:

  • FOLLOW_INPUT
  • USE_CONFIGURED

Returns:

  • (String) —

    Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input.

#name ⇒ String

The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

Returns:

  • (String) —

    The name of this AudioDescription.

#remix_settings ⇒ Types::RemixSettings

Settings that control how input audio channels are remixed into the output audio channels.

Returns:

  • (Types::RemixSettings) —

    Settings that control how input audio channels are remixed into the output audio channels.

#stream_name ⇒ String

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).

Returns:

  • (String) —

    Used for MS Smooth and Apple HLS outputs.