Class: AWSCDK::MediaLive::CfnChannel::CaptionDescriptionProperty

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

Overview

The encoding information for output captions.

The parent of this entity is EncoderSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(accessibility: nil, caption_dash_roles: nil, caption_selector_name: nil, destination_settings: nil, dvb_dash_accessibility: nil, language_code: nil, language_description: nil, name: nil) ⇒ CaptionDescriptionProperty

Returns a new instance of CaptionDescriptionProperty.

Parameters:

  • accessibility (String, nil) (defaults to: nil)
  • caption_dash_roles (Array<String>, nil) (defaults to: nil)
  • caption_selector_name (String, nil) (defaults to: nil) —

    Specifies which input captions selector to use as a captions source when generating output captions.

  • destination_settings (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::CaptionDestinationSettingsProperty, nil) (defaults to: nil) —

    Additional settings for a captions destination that depend on the destination type.

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

    An ISO 639-2 three-digit code.

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

    Human-readable information to indicate the captions that are available for players (for example, English or Spanish).

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

    The name of the captions description.



3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
 
# File 'media_live/cfn_channel.rb', line 3274

def initialize(accessibility: nil, caption_dash_roles: nil, caption_selector_name: nil, destination_settings: nil, dvb_dash_accessibility: nil, language_code: nil, language_description: nil, name: nil)
  @accessibility = accessibility
  Jsii::Type.check_type(@accessibility, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "accessibility") unless @accessibility.nil?
  @caption_dash_roles = caption_dash_roles
  Jsii::Type.check_type(@caption_dash_roles, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "captionDashRoles") unless @caption_dash_roles.nil?
  @caption_selector_name = caption_selector_name
  Jsii::Type.check_type(@caption_selector_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "captionSelectorName") unless @caption_selector_name.nil?
  @destination_settings = destination_settings.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::CaptionDestinationSettingsProperty.new(**destination_settings.transform_keys(&:to_sym)) : destination_settings
  Jsii::Type.check_type(@destination_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5DYXB0aW9uRGVzdGluYXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "destinationSettings") unless @destination_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_description = language_description
  Jsii::Type.check_type(@language_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "languageDescription") unless @language_description.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
end

Instance Attribute Details

#accessibility ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



3295
3296
3297
 
# File 'media_live/cfn_channel.rb', line 3295

def accessibility
  @accessibility
end

#caption_dash_roles ⇒ Array<String>? (readonly)

Returns:

  • (Array<String>, nil)

See Also:



3298
3299
3300
 
# File 'media_live/cfn_channel.rb', line 3298

def caption_dash_roles
  @caption_dash_roles
end

#caption_selector_name ⇒ String? (readonly)

Specifies which input captions selector to use as a captions source when generating output captions.

This field should match a captionSelector name.

Returns:

  • (String, nil)

See Also:



3305
3306
3307
 
# File 'media_live/cfn_channel.rb', line 3305

def caption_selector_name
  @caption_selector_name
end

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

Additional settings for a captions destination that depend on the destination type.

Returns:

See Also:



3310
3311
3312
 
# File 'media_live/cfn_channel.rb', line 3310

def destination_settings
  @destination_settings
end

#dvb_dash_accessibility ⇒ String? (readonly)

Returns:

  • (String, nil)

See Also:



3313
3314
3315
 
# File 'media_live/cfn_channel.rb', line 3313

def dvb_dash_accessibility
  @dvb_dash_accessibility
end

#language_code ⇒ String? (readonly)

An ISO 639-2 three-digit code.

For more information, see http://www.loc.gov/standards/iso639-2/.

Returns:

  • (String, nil)

See Also:



3320
3321
3322
 
# File 'media_live/cfn_channel.rb', line 3320

def language_code
  @language_code
end

#language_description ⇒ String? (readonly)

Human-readable information to indicate the captions that are available for players (for example, English or Spanish).

Returns:

  • (String, nil)

See Also:



3325
3326
3327
 
# File 'media_live/cfn_channel.rb', line 3325

def language_description
  @language_description
end

#name ⇒ String? (readonly)

The name of the captions description.

The name is used to associate a captions description with an output. Names must be unique within a channel.

Returns:

  • (String, nil)

See Also:



3332
3333
3334
 
# File 'media_live/cfn_channel.rb', line 3332

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
 
# File 'media_live/cfn_channel.rb', line 3334

def self.jsii_properties
  {
    :accessibility => "accessibility",
    :caption_dash_roles => "captionDashRoles",
    :caption_selector_name => "captionSelectorName",
    :destination_settings => "destinationSettings",
    :dvb_dash_accessibility => "dvbDashAccessibility",
    :language_code => "languageCode",
    :language_description => "languageDescription",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
 
# File 'media_live/cfn_channel.rb', line 3347

def to_jsii
  result = {}
  result.merge!({
    "accessibility" => @accessibility,
    "captionDashRoles" => @caption_dash_roles,
    "captionSelectorName" => @caption_selector_name,
    "destinationSettings" => @destination_settings,
    "dvbDashAccessibility" => @dvb_dash_accessibility,
    "languageCode" => @language_code,
    "languageDescription" => @language_description,
    "name" => @name,
  })
  result.compact
end