Class: AWSCDK::MediaLive::CfnChannel::CaptionLanguageMappingProperty

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

Overview

Maps a captions channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.

The parent of this entity is HlsGroupSettings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(caption_channel: nil, language_code: nil, language_description: nil) ⇒ CaptionLanguageMappingProperty

Returns a new instance of CaptionLanguageMappingProperty.

Parameters:

  • caption_channel (Numeric, nil) (defaults to: nil)

    The closed caption channel being described by this CaptionLanguageMapping.

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

    A three-character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2).

  • language_description (String, nil) (defaults to: nil)

    The textual description of language.



3529
3530
3531
3532
3533
3534
3535
3536
# File 'media_live/cfn_channel.rb', line 3529

def initialize(caption_channel: nil, language_code: nil, language_description: nil)
  @caption_channel = caption_channel
  Jsii::Type.check_type(@caption_channel, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "captionChannel") unless @caption_channel.nil?
  @language_code = language_code
  Jsii::Type.check_type(@language_code, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageCode") unless @language_code.nil?
  @language_description = language_description
  Jsii::Type.check_type(@language_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageDescription") unless @language_description.nil?
end

Instance Attribute Details

#caption_channelNumeric? (readonly)

The closed caption channel being described by this CaptionLanguageMapping.

Each channel mapping must have a unique channel number (maximum of 4).



3544
3545
3546
# File 'media_live/cfn_channel.rb', line 3544

def caption_channel
  @caption_channel
end

#language_codeString? (readonly)

A three-character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2).



3549
3550
3551
# File 'media_live/cfn_channel.rb', line 3549

def language_code
  @language_code
end

#language_descriptionString? (readonly)

The textual description of language.



3554
3555
3556
# File 'media_live/cfn_channel.rb', line 3554

def language_description
  @language_description
end

Class Method Details

.jsii_propertiesObject



3556
3557
3558
3559
3560
3561
3562
# File 'media_live/cfn_channel.rb', line 3556

def self.jsii_properties
  {
    :caption_channel => "captionChannel",
    :language_code => "languageCode",
    :language_description => "languageDescription",
  }
end

Instance Method Details

#to_jsiiObject



3564
3565
3566
3567
3568
3569
3570
3571
3572
# File 'media_live/cfn_channel.rb', line 3564

def to_jsii
  result = {}
  result.merge!({
    "captionChannel" => @caption_channel,
    "languageCode" => @language_code,
    "languageDescription" => @language_description,
  })
  result.compact
end