Class: AWSCDK::MediaLive::CfnChannel::AudioNormalizationSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The settings for normalizing video.

The parent of this entity is AudioDescription.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(algorithm: nil, algorithm_control: nil, peak_calculation: nil, peak_limiter_threshold: nil, target_lkfs: nil) ⇒ AudioNormalizationSettingsProperty

Returns a new instance of AudioNormalizationSettingsProperty.

Parameters:

  • algorithm (String, nil) (defaults to: nil) —

    The audio normalization algorithm to use.

  • algorithm_control (String, nil) (defaults to: nil) —

    When set to correctAudio, the output audio is corrected using the chosen algorithm.

  • peak_calculation (String, nil) (defaults to: nil)
  • peak_limiter_threshold (Numeric, nil) (defaults to: nil)
  • target_lkfs (Numeric, nil) (defaults to: nil) —

    The Target LKFS(loudness) to adjust volume to.



1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'media_live/cfn_channel.rb', line 1863

def initialize(algorithm: nil, algorithm_control: nil, peak_calculation: nil, peak_limiter_threshold: nil, target_lkfs: nil)
  @algorithm = algorithm
  Jsii::Type.check_type(@algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "algorithm") unless @algorithm.nil?
  @algorithm_control = algorithm_control
  Jsii::Type.check_type(@algorithm_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "algorithmControl") unless @algorithm_control.nil?
  @peak_calculation = peak_calculation
  Jsii::Type.check_type(@peak_calculation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "peakCalculation") unless @peak_calculation.nil?
  @peak_limiter_threshold = peak_limiter_threshold
  Jsii::Type.check_type(@peak_limiter_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "peakLimiterThreshold") unless @peak_limiter_threshold.nil?
  @target_lkfs = target_lkfs
  Jsii::Type.check_type(@target_lkfs, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "targetLkfs") unless @target_lkfs.nil?
end

Instance Attribute Details

#algorithm ⇒ String? (readonly)

The audio normalization algorithm to use.

itu17701 conforms to the CALM Act specification. itu17702 conforms to the EBU R-128 specification.

Returns:

  • (String, nil)

See Also:



1882
1883
1884
 
# File 'media_live/cfn_channel.rb', line 1882

def algorithm
  @algorithm
end

#algorithm_control ⇒ String? (readonly)

When set to correctAudio, the output audio is corrected using the chosen algorithm.

If set to measureOnly, the audio is measured but not adjusted.

Returns:

  • (String, nil)

See Also:



1889
1890
1891
 
# File 'media_live/cfn_channel.rb', line 1889

def algorithm_control
  @algorithm_control
end

#peak_calculation ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1892
1893
1894
 
# File 'media_live/cfn_channel.rb', line 1892

def peak_calculation
  @peak_calculation
end

#peak_limiter_threshold ⇒ Numeric? (readonly)

Returns:

  • (Numeric, nil)

See Also:



1895
1896
1897
 
# File 'media_live/cfn_channel.rb', line 1895

def peak_limiter_threshold
  @peak_limiter_threshold
end

#target_lkfs ⇒ Numeric? (readonly)

The Target LKFS(loudness) to adjust volume to.

If no value is entered, a default value is used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.

Returns:

  • (Numeric, nil)

See Also:



1902
1903
1904
 
# File 'media_live/cfn_channel.rb', line 1902

def target_lkfs
  @target_lkfs
end

Class Method Details

.jsii_properties ⇒ Object 



1904
1905
1906
1907
1908
1909
1910
1911
1912
 
# File 'media_live/cfn_channel.rb', line 1904

def self.jsii_properties
  {
    :algorithm => "algorithm",
    :algorithm_control => "algorithmControl",
    :peak_calculation => "peakCalculation",
    :peak_limiter_threshold => "peakLimiterThreshold",
    :target_lkfs => "targetLkfs",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
 
# File 'media_live/cfn_channel.rb', line 1914

def to_jsii
  result = {}
  result.merge!({
    "algorithm" => @algorithm,
    "algorithmControl" => @algorithm_control,
    "peakCalculation" => @peak_calculation,
    "peakLimiterThreshold" => @peak_limiter_threshold,
    "targetLkfs" => @target_lkfs,
  })
  result.compact
end