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

Class: Aws::MediaConvert::Types::AudioCodecSettings

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 AudioCodecSettings data as a hash:

{
  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,
  },
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#aac_settingsTypes::AacSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#ac_3_settingsTypes::Ac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#aiff_settingsTypes::AiffSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#codecString

Type of Audio codec.

Returns:

  • (String)


353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#eac_3_settingsTypes::Eac3Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#mp_2_settingsTypes::Mp2Settings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end

#wav_settingsTypes::WavSettings

Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.

Returns:



353
354
355
356
357
358
359
360
361
362
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 353

class AudioCodecSettings < Struct.new(
  :aac_settings,
  :ac_3_settings,
  :aiff_settings,
  :codec,
  :eac_3_settings,
  :mp_2_settings,
  :wav_settings)
  include Aws::Structure
end