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

Class: Aws::MediaConvert::Types::AudioNormalizationSettings

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

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#algorithm ⇒ String

Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.

Returns:

  • (String) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end

#algorithm_control ⇒ String

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Returns:

  • (String) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end

#correction_gate_level ⇒ Integer

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction.

Returns:

  • (Integer) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end

#loudness_logging ⇒ String

If set to LOG, log each output's audio track loudness to a CSV file.

Returns:

  • (String) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end

#peak_calculation ⇒ String

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Returns:

  • (String) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end

#target_lkfs ⇒ Float

When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.

Returns:

  • (Float) 


740
741
742
743
744
745
746
747
748
 
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 740

class AudioNormalizationSettings < Struct.new(
  :algorithm,
  :algorithm_control,
  :correction_gate_level,
  :loudness_logging,
  :peak_calculation,
  :target_lkfs)
  include Aws::Structure
end