Class: Aws::MediaLive::Types::CaptionDescription

Inherits:

Struct

• Object
• Struct
• Aws::MediaLive::Types::CaptionDescription

Defined in:

gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb

Overview

Caption Description

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #accessibility ⇒ String

  Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds.

• #caption_dash_roles ⇒ Array<String>

  Identifies the DASH roles to assign to this captions output.

• #caption_selector_name ⇒ String

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

• #destination_settings ⇒ Types::CaptionDestinationSettings

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

• #dvb_dash_accessibility ⇒ String

  Identifies DVB DASH accessibility signaling in this captions output.

• #language_code ⇒ String

  ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/.

• #language_description ⇒ String

  Human readable information to indicate captions available for players (eg. English, or Spanish).

• #name ⇒ String

  Name of the caption description.

Instance Attribute Details

#accessibility ⇒ String

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#caption_dash_roles ⇒ Array<String>

Identifies the DASH roles to assign to this captions output. Applies only when the captions output is configured for DVB DASH accessibility signaling.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#caption_selector_name ⇒ String

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#destination_settings ⇒ Types::CaptionDestinationSettings

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

Returns:

• (Types::CaptionDestinationSettings)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#dvb_dash_accessibility ⇒ String

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#language_description ⇒ String

Human readable information to indicate captions available for players (eg. English, or Spanish).

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

Returns:

• (String)

# File 'gems/aws-sdk-medialive/lib/aws-sdk-medialive/types.rb', line 1534

class CaptionDescription < Struct.new(
  :accessibility,
  :caption_selector_name,
  :destination_settings,
  :language_code,
  :language_description,
  :name,
  :caption_dash_roles,
  :dvb_dash_accessibility)
  SENSITIVE = []
  include Aws::Structure
end