Class: AWSCDK::MediaLive::CfnChannel::Eac3SettingsProperty

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

Overview

The settings for an EAC3 audio encode in the output.

The parent of this entity is AudioCodecSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attenuation_control: nil, bitrate: nil, bitstream_mode: nil, coding_mode: nil, dc_filter: nil, dialnorm: nil, drc_line: nil, drc_rf: nil, lfe_control: nil, lfe_filter: nil, lo_ro_center_mix_level: nil, lo_ro_surround_mix_level: nil, lt_rt_center_mix_level: nil, lt_rt_surround_mix_level: nil, metadata_control: nil, passthrough_control: nil, phase_control: nil, stereo_downmix: nil, surround_ex_mode: nil, surround_mode: nil) ⇒ Eac3SettingsProperty

Returns a new instance of Eac3SettingsProperty.

Parameters:

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

    When set to attenuate3Db, applies a 3 dB attenuation to the surround channels.

  • bitrate (Numeric, nil) (defaults to: nil) —

    The average bitrate in bits/second.

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

    Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream.

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

    The Dolby Digital Plus coding mode.

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

    When set to enabled, activates a DC highpass filter for all input channels.

  • dialnorm (Numeric, nil) (defaults to: nil) —

    Sets the dialnorm for the output.

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

    Sets the Dolby dynamic range compression profile.

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

    Sets the profile for heavy Dolby dynamic range compression, ensuring that the instantaneous signal peaks do not exceed specified levels.

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

    When encoding 3/2 audio, setting to lfe enables the LFE channel.

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

    When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding.

  • lo_ro_center_mix_level (Numeric, nil) (defaults to: nil) —

    The Left only/Right only center mix level.

  • lo_ro_surround_mix_level (Numeric, nil) (defaults to: nil) —

    The Left only/Right only surround mix level.

  • lt_rt_center_mix_level (Numeric, nil) (defaults to: nil) —

    The Left total/Right total center mix level.

  • lt_rt_surround_mix_level (Numeric, nil) (defaults to: nil) —

    The Left total/Right total surround mix level.

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

    When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data.

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

    When set to whenPossible, input DD+ audio will be passed through if it is present on the input.

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

    When set to shift90Degrees, applies a 90-degree phase shift to the surround channels.

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

    A stereo downmix preference.

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

    When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

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

    When encoding 2/0 audio, sets whether Dolby Surround is matrix-encoded into the two channels.



4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
 
# File 'media_live/cfn_channel.rb', line 4796

def initialize(attenuation_control: nil, bitrate: nil, bitstream_mode: nil, coding_mode: nil, dc_filter: nil, dialnorm: nil, drc_line: nil, drc_rf: nil, lfe_control: nil, lfe_filter: nil, lo_ro_center_mix_level: nil, lo_ro_surround_mix_level: nil, lt_rt_center_mix_level: nil, lt_rt_surround_mix_level: nil, metadata_control: nil, passthrough_control: nil, phase_control: nil, stereo_downmix: nil, surround_ex_mode: nil, surround_mode: nil)
  @attenuation_control = attenuation_control
  Jsii::Type.check_type(@attenuation_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attenuationControl") unless @attenuation_control.nil?
  @bitrate = bitrate
  Jsii::Type.check_type(@bitrate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "bitrate") unless @bitrate.nil?
  @bitstream_mode = bitstream_mode
  Jsii::Type.check_type(@bitstream_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bitstreamMode") unless @bitstream_mode.nil?
  @coding_mode = coding_mode
  Jsii::Type.check_type(@coding_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "codingMode") unless @coding_mode.nil?
  @dc_filter = dc_filter
  Jsii::Type.check_type(@dc_filter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dcFilter") unless @dc_filter.nil?
  @dialnorm = dialnorm
  Jsii::Type.check_type(@dialnorm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "dialnorm") unless @dialnorm.nil?
  @drc_line = drc_line
  Jsii::Type.check_type(@drc_line, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "drcLine") unless @drc_line.nil?
  @drc_rf = drc_rf
  Jsii::Type.check_type(@drc_rf, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "drcRf") unless @drc_rf.nil?
  @lfe_control = lfe_control
  Jsii::Type.check_type(@lfe_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lfeControl") unless @lfe_control.nil?
  @lfe_filter = lfe_filter
  Jsii::Type.check_type(@lfe_filter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lfeFilter") unless @lfe_filter.nil?
  @lo_ro_center_mix_level = lo_ro_center_mix_level
  Jsii::Type.check_type(@lo_ro_center_mix_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "loRoCenterMixLevel") unless @lo_ro_center_mix_level.nil?
  @lo_ro_surround_mix_level = lo_ro_surround_mix_level
  Jsii::Type.check_type(@lo_ro_surround_mix_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "loRoSurroundMixLevel") unless @lo_ro_surround_mix_level.nil?
  @lt_rt_center_mix_level = lt_rt_center_mix_level
  Jsii::Type.check_type(@lt_rt_center_mix_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ltRtCenterMixLevel") unless @lt_rt_center_mix_level.nil?
  @lt_rt_surround_mix_level = lt_rt_surround_mix_level
  Jsii::Type.check_type(@lt_rt_surround_mix_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "ltRtSurroundMixLevel") unless @lt_rt_surround_mix_level.nil?
  @metadata_control = metadata_control
  Jsii::Type.check_type(@metadata_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metadataControl") unless @metadata_control.nil?
  @passthrough_control = passthrough_control
  Jsii::Type.check_type(@passthrough_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "passthroughControl") unless @passthrough_control.nil?
  @phase_control = phase_control
  Jsii::Type.check_type(@phase_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "phaseControl") unless @phase_control.nil?
  @stereo_downmix = stereo_downmix
  Jsii::Type.check_type(@stereo_downmix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stereoDownmix") unless @stereo_downmix.nil?
  @surround_ex_mode = surround_ex_mode
  Jsii::Type.check_type(@surround_ex_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "surroundExMode") unless @surround_ex_mode.nil?
  @surround_mode = surround_mode
  Jsii::Type.check_type(@surround_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "surroundMode") unless @surround_mode.nil?
end

Instance Attribute Details

#attenuation_control ⇒ String? (readonly)

When set to attenuate3Db, applies a 3 dB attenuation to the surround channels.

Used only for the 3/2 coding mode.

Returns:

  • (String, nil)

See Also:



4845
4846
4847
 
# File 'media_live/cfn_channel.rb', line 4845

def attenuation_control
  @attenuation_control
end

#bitrate ⇒ Numeric? (readonly)

The average bitrate in bits/second.

Valid bitrates depend on the coding mode.

Returns:

  • (Numeric, nil)

See Also:



4852
4853
4854
 
# File 'media_live/cfn_channel.rb', line 4852

def bitrate
  @bitrate
end

#bitstream_mode ⇒ String? (readonly)

Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream.

For more information, see ATSC A/52-2012 (Annex E).

Returns:

  • (String, nil)

See Also:



4859
4860
4861
 
# File 'media_live/cfn_channel.rb', line 4859

def bitstream_mode
  @bitstream_mode
end

#coding_mode ⇒ String? (readonly)

The Dolby Digital Plus coding mode.

This mode determines the number of channels.

Returns:

  • (String, nil)

See Also:



4866
4867
4868
 
# File 'media_live/cfn_channel.rb', line 4866

def coding_mode
  @coding_mode
end

#dc_filter ⇒ String? (readonly)

When set to enabled, activates a DC highpass filter for all input channels.

Returns:

  • (String, nil)

See Also:



4871
4872
4873
 
# File 'media_live/cfn_channel.rb', line 4871

def dc_filter
  @dc_filter
end

#dialnorm ⇒ Numeric? (readonly)

Sets the dialnorm for the output.

If blank and the input audio is Dolby Digital Plus, dialnorm will be passed through.

Returns:

  • (Numeric, nil)

See Also:



4878
4879
4880
 
# File 'media_live/cfn_channel.rb', line 4878

def dialnorm
  @dialnorm
end

#drc_line ⇒ String? (readonly)

Sets the Dolby dynamic range compression profile.

Returns:

  • (String, nil)

See Also:



4883
4884
4885
 
# File 'media_live/cfn_channel.rb', line 4883

def drc_line
  @drc_line
end

#drc_rf ⇒ String? (readonly)

Sets the profile for heavy Dolby dynamic range compression, ensuring that the instantaneous signal peaks do not exceed specified levels.

Returns:

  • (String, nil)

See Also:



4888
4889
4890
 
# File 'media_live/cfn_channel.rb', line 4888

def drc_rf
  @drc_rf
end

#lfe_control ⇒ String? (readonly)

When encoding 3/2 audio, setting to lfe enables the LFE channel.

Returns:

  • (String, nil)

See Also:



4893
4894
4895
 
# File 'media_live/cfn_channel.rb', line 4893

def lfe_control
  @lfe_control
end

#lfe_filter ⇒ String? (readonly)

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding.

Valid only with a codingMode32 coding mode.

Returns:

  • (String, nil)

See Also:



4900
4901
4902
 
# File 'media_live/cfn_channel.rb', line 4900

def lfe_filter
  @lfe_filter
end

#lo_ro_center_mix_level ⇒ Numeric? (readonly)

The Left only/Right only center mix level.

Used only for the 3/2 coding mode.

Returns:

  • (Numeric, nil)

See Also:



4907
4908
4909
 
# File 'media_live/cfn_channel.rb', line 4907

def lo_ro_center_mix_level
  @lo_ro_center_mix_level
end

#lo_ro_surround_mix_level ⇒ Numeric? (readonly)

The Left only/Right only surround mix level.

Used only for a 3/2 coding mode.

Returns:

  • (Numeric, nil)

See Also:



4914
4915
4916
 
# File 'media_live/cfn_channel.rb', line 4914

def lo_ro_surround_mix_level
  @lo_ro_surround_mix_level
end

#lt_rt_center_mix_level ⇒ Numeric? (readonly)

The Left total/Right total center mix level.

Used only for a 3/2 coding mode.

Returns:

  • (Numeric, nil)

See Also:



4921
4922
4923
 
# File 'media_live/cfn_channel.rb', line 4921

def lt_rt_center_mix_level
  @lt_rt_center_mix_level
end

#lt_rt_surround_mix_level ⇒ Numeric? (readonly)

The Left total/Right total surround mix level.

Used only for the 3/2 coding mode.

Returns:

  • (Numeric, nil)

See Also:



4928
4929
4930
 
# File 'media_live/cfn_channel.rb', line 4928

def lt_rt_surround_mix_level
  @lt_rt_surround_mix_level
end

#metadata_control ⇒ String? (readonly)

When set to followInput, encoder metadata is sourced from the DD, DD+, or DolbyE decoder that supplies this audio data.

If the audio is not supplied from one of these streams, then the static metadata settings are used.

Returns:

  • (String, nil)

See Also:



4935
4936
4937
 
# File 'media_live/cfn_channel.rb', line 4935

def metadata_control
  @metadata_control
end

#passthrough_control ⇒ String? (readonly)

When set to whenPossible, input DD+ audio will be passed through if it is present on the input.

This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.

Returns:

  • (String, nil)

See Also:



4942
4943
4944
 
# File 'media_live/cfn_channel.rb', line 4942

def passthrough_control
  @passthrough_control
end

#phase_control ⇒ String? (readonly)

When set to shift90Degrees, applies a 90-degree phase shift to the surround channels.

Used only for a 3/2 coding mode.

Returns:

  • (String, nil)

See Also:



4949
4950
4951
 
# File 'media_live/cfn_channel.rb', line 4949

def phase_control
  @phase_control
end

#stereo_downmix ⇒ String? (readonly)

A stereo downmix preference.

Used only for the 3/2 coding mode.

Returns:

  • (String, nil)

See Also:



4956
4957
4958
 
# File 'media_live/cfn_channel.rb', line 4956

def stereo_downmix
  @stereo_downmix
end

#surround_ex_mode ⇒ String? (readonly)

When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

Returns:

  • (String, nil)

See Also:



4961
4962
4963
 
# File 'media_live/cfn_channel.rb', line 4961

def surround_ex_mode
  @surround_ex_mode
end

#surround_mode ⇒ String? (readonly)

When encoding 2/0 audio, sets whether Dolby Surround is matrix-encoded into the two channels.

Returns:

  • (String, nil)

See Also:



4966
4967
4968
 
# File 'media_live/cfn_channel.rb', line 4966

def surround_mode
  @surround_mode
end

Class Method Details

.jsii_properties ⇒ Object 



4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
 
# File 'media_live/cfn_channel.rb', line 4968

def self.jsii_properties
  {
    :attenuation_control => "attenuationControl",
    :bitrate => "bitrate",
    :bitstream_mode => "bitstreamMode",
    :coding_mode => "codingMode",
    :dc_filter => "dcFilter",
    :dialnorm => "dialnorm",
    :drc_line => "drcLine",
    :drc_rf => "drcRf",
    :lfe_control => "lfeControl",
    :lfe_filter => "lfeFilter",
    :lo_ro_center_mix_level => "loRoCenterMixLevel",
    :lo_ro_surround_mix_level => "loRoSurroundMixLevel",
    :lt_rt_center_mix_level => "ltRtCenterMixLevel",
    :lt_rt_surround_mix_level => "ltRtSurroundMixLevel",
    :metadata_control => "metadataControl",
    :passthrough_control => "passthroughControl",
    :phase_control => "phaseControl",
    :stereo_downmix => "stereoDownmix",
    :surround_ex_mode => "surroundExMode",
    :surround_mode => "surroundMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
 
# File 'media_live/cfn_channel.rb', line 4993

def to_jsii
  result = {}
  result.merge!({
    "attenuationControl" => @attenuation_control,
    "bitrate" => @bitrate,
    "bitstreamMode" => @bitstream_mode,
    "codingMode" => @coding_mode,
    "dcFilter" => @dc_filter,
    "dialnorm" => @dialnorm,
    "drcLine" => @drc_line,
    "drcRf" => @drc_rf,
    "lfeControl" => @lfe_control,
    "lfeFilter" => @lfe_filter,
    "loRoCenterMixLevel" => @lo_ro_center_mix_level,
    "loRoSurroundMixLevel" => @lo_ro_surround_mix_level,
    "ltRtCenterMixLevel" => @lt_rt_center_mix_level,
    "ltRtSurroundMixLevel" => @lt_rt_surround_mix_level,
    "metadataControl" => @metadata_control,
    "passthroughControl" => @passthrough_control,
    "phaseControl" => @phase_control,
    "stereoDownmix" => @stereo_downmix,
    "surroundExMode" => @surround_ex_mode,
    "surroundMode" => @surround_mode,
  })
  result.compact
end