Class: AWSCDK::MediaLive::CfnChannel::AudioDescriptionProperty

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

Overview

The encoding information for one output audio.

The parent of this entity is EncoderSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(audio_dash_roles: nil, audio_normalization_settings: nil, audio_selector_name: nil, audio_type: nil, audio_type_control: nil, audio_watermarking_settings: nil, codec_settings: nil, dvb_dash_accessibility: nil, language_code: nil, language_code_control: nil, name: nil, remix_settings: nil, stream_name: nil) ⇒ AudioDescriptionProperty

Returns a new instance of AudioDescriptionProperty.

Parameters:

  • audio_dash_roles (Array<String>, nil) (defaults to: nil)
  • audio_normalization_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::AudioNormalizationSettingsProperty, nil) (defaults to: nil) —

    The advanced audio normalization settings.

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

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

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

    Applies only if audioTypeControl is useConfigured.

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

    Determines how audio type is determined.

  • audio_watermarking_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::AudioWatermarkSettingsProperty, nil) (defaults to: nil) —

    Settings to configure one or more solutions that insert audio watermarks in the audio encode.

  • codec_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::AudioCodecSettingsProperty, nil) (defaults to: nil) —

    The audio codec settings.

  • dvb_dash_accessibility (String, nil) (defaults to: nil)
  • language_code (String, nil) (defaults to: nil) —

    Indicates the language of the audio output track.

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

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

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

    The name of this AudioDescription.

  • remix_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::RemixSettingsProperty, nil) (defaults to: nil) —

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

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

    Used for Microsoft Smooth and Apple HLS outputs.



1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'media_live/cfn_channel.rb', line 1550

def initialize(audio_dash_roles: nil, audio_normalization_settings: nil, audio_selector_name: nil, audio_type: nil, audio_type_control: nil, audio_watermarking_settings: nil, codec_settings: nil, dvb_dash_accessibility: nil, language_code: nil, language_code_control: nil, name: nil, remix_settings: nil, stream_name: nil)
  @audio_dash_roles = audio_dash_roles
  Jsii::Type.check_type(@audio_dash_roles, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "audioDashRoles") unless @audio_dash_roles.nil?
  @audio_normalization_settings = audio_normalization_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::AudioNormalizationSettingsProperty.new(**audio_normalization_settings.transform_keys(&:to_sym)) : audio_normalization_settings
  Jsii::Type.check_type(@audio_normalization_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5BdWRpb05vcm1hbGl6YXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "audioNormalizationSettings") unless @audio_normalization_settings.nil?
  @audio_selector_name = audio_selector_name
  Jsii::Type.check_type(@audio_selector_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "audioSelectorName") unless @audio_selector_name.nil?
  @audio_type = audio_type
  Jsii::Type.check_type(@audio_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "audioType") unless @audio_type.nil?
  @audio_type_control = audio_type_control
  Jsii::Type.check_type(@audio_type_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "audioTypeControl") unless @audio_type_control.nil?
  @audio_watermarking_settings = audio_watermarking_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::AudioWatermarkSettingsProperty.new(**audio_watermarking_settings.transform_keys(&:to_sym)) : audio_watermarking_settings
  Jsii::Type.check_type(@audio_watermarking_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5BdWRpb1dhdGVybWFya1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "audioWatermarkingSettings") unless @audio_watermarking_settings.nil?
  @codec_settings = codec_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::AudioCodecSettingsProperty.new(**codec_settings.transform_keys(&:to_sym)) : codec_settings
  Jsii::Type.check_type(@codec_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5BdWRpb0NvZGVjU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "codecSettings") unless @codec_settings.nil?
  @dvb_dash_accessibility = dvb_dash_accessibility
  Jsii::Type.check_type(@dvb_dash_accessibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dvbDashAccessibility") unless @dvb_dash_accessibility.nil?
  @language_code = language_code
  Jsii::Type.check_type(@language_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageCode") unless @language_code.nil?
  @language_code_control = language_code_control
  Jsii::Type.check_type(@language_code_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageCodeControl") unless @language_code_control.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @remix_settings = remix_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::RemixSettingsProperty.new(**remix_settings.transform_keys(&:to_sym)) : remix_settings
  Jsii::Type.check_type(@remix_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5SZW1peFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "remixSettings") unless @remix_settings.nil?
  @stream_name = stream_name
  Jsii::Type.check_type(@stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamName") unless @stream_name.nil?
end

Instance Attribute Details

#audio_dash_roles ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



1581
1582
1583
 
# File 'media_live/cfn_channel.rb', line 1581

def audio_dash_roles
  @audio_dash_roles
end

#audio_normalization_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The advanced audio normalization settings.

Returns:

See Also:



1586
1587
1588
 
# File 'media_live/cfn_channel.rb', line 1586

def audio_normalization_settings
  @audio_normalization_settings
end

#audio_selector_name ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1591
1592
1593
 
# File 'media_live/cfn_channel.rb', line 1591

def audio_selector_name
  @audio_selector_name
end

#audio_type ⇒ String? (readonly)

Applies only if audioTypeControl is useConfigured.

The values for audioType are defined in ISO-IEC 13818-1.

Returns:

  • (String, nil)

See Also:



1598
1599
1600
 
# File 'media_live/cfn_channel.rb', line 1598

def audio_type
  @audio_type
end

#audio_type_control ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



1605
1606
1607
 
# File 'media_live/cfn_channel.rb', line 1605

def audio_type_control
  @audio_type_control
end

#audio_watermarking_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Settings to configure one or more solutions that insert audio watermarks in the audio encode.

Returns:

See Also:



1610
1611
1612
 
# File 'media_live/cfn_channel.rb', line 1610

def audio_watermarking_settings
  @audio_watermarking_settings
end

#codec_settings ⇒ AWSCDK::IResolvable, ... (readonly)

The audio codec settings.

Returns:

See Also:



1615
1616
1617
 
# File 'media_live/cfn_channel.rb', line 1615

def codec_settings
  @codec_settings
end

#dvb_dash_accessibility ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



1618
1619
1620
 
# File 'media_live/cfn_channel.rb', line 1618

def dvb_dash_accessibility
  @dvb_dash_accessibility
end

#language_code ⇒ String? (readonly)

Indicates the language of the audio output track.

Used only if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.

Returns:

  • (String, nil)

See Also:



1625
1626
1627
 
# File 'media_live/cfn_channel.rb', line 1625

def language_code
  @language_code
end

#language_code_control ⇒ String? (readonly)

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

The languageCode setting is used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input.

Returns:

  • (String, nil)

See Also:



1632
1633
1634
 
# File 'media_live/cfn_channel.rb', line 1632

def language_code_control
  @language_code_control
end

#name ⇒ String? (readonly)

The name of this AudioDescription.

Outputs use this name to uniquely identify this AudioDescription. Description names should be unique within this channel.

Returns:

  • (String, nil)

See Also:



1639
1640
1641
 
# File 'media_live/cfn_channel.rb', line 1639

def name
  @name
end

#remix_settings ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



1644
1645
1646
 
# File 'media_live/cfn_channel.rb', line 1644

def remix_settings
  @remix_settings
end

#stream_name ⇒ String? (readonly)

Used for Microsoft Smooth and Apple HLS outputs.

Indicates the name displayed by the player (for example, English or Director Commentary).

Returns:

  • (String, nil)

See Also:



1651
1652
1653
 
# File 'media_live/cfn_channel.rb', line 1651

def stream_name
  @stream_name
end

Class Method Details

.jsii_properties ⇒ Object 



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
 
# File 'media_live/cfn_channel.rb', line 1653

def self.jsii_properties
  {
    :audio_dash_roles => "audioDashRoles",
    :audio_normalization_settings => "audioNormalizationSettings",
    :audio_selector_name => "audioSelectorName",
    :audio_type => "audioType",
    :audio_type_control => "audioTypeControl",
    :audio_watermarking_settings => "audioWatermarkingSettings",
    :codec_settings => "codecSettings",
    :dvb_dash_accessibility => "dvbDashAccessibility",
    :language_code => "languageCode",
    :language_code_control => "languageCodeControl",
    :name => "name",
    :remix_settings => "remixSettings",
    :stream_name => "streamName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
 
# File 'media_live/cfn_channel.rb', line 1671

def to_jsii
  result = {}
  result.merge!({
    "audioDashRoles" => @audio_dash_roles,
    "audioNormalizationSettings" => @audio_normalization_settings,
    "audioSelectorName" => @audio_selector_name,
    "audioType" => @audio_type,
    "audioTypeControl" => @audio_type_control,
    "audioWatermarkingSettings" => @audio_watermarking_settings,
    "codecSettings" => @codec_settings,
    "dvbDashAccessibility" => @dvb_dash_accessibility,
    "languageCode" => @language_code,
    "languageCodeControl" => @language_code_control,
    "name" => @name,
    "remixSettings" => @remix_settings,
    "streamName" => @stream_name,
  })
  result.compact
end