View a markdown version of this page

AWS::MediaLive::Channel CaptionDescription - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::MediaLive::Channel CaptionDescription

The encoding information for output captions.

The parent of this entity is EncoderSettings.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "Accessibility" : String, "CaptionDashRoles" : [ String, ... ], "CaptionSelectorName" : String, "DestinationSettings" : CaptionDestinationSettings, "DvbDashAccessibility" : String, "LanguageCode" : String, "LanguageDescription" : String, "Name" : String }

Properties

Accessibility

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.

Required: No

Type: String

Update requires: No interruption

CaptionDashRoles

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

Required: No

Type: Array of String

Update requires: No interruption

CaptionSelectorName

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

Required: No

Type: String

Update requires: No interruption

DestinationSettings

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

Required: No

Type: CaptionDestinationSettings

Update requires: No interruption

DvbDashAccessibility

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

Required: No

Type: String

Update requires: No interruption

LanguageCode

An ISO 639-2 three-digit code. For more information, see http://www.loc.gov/standards/iso639-2/.

Required: No

Type: String

Update requires: No interruption

LanguageDescription

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

Required: No

Type: String

Update requires: No interruption

Name

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.

Required: No

Type: String

Update requires: No interruption