interface CaptionDescriptionProperty

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.CfnChannel.CaptionDescriptionProperty
Java	software.amazon.awscdk.services.medialive.CfnChannel.CaptionDescriptionProperty
Python	aws_cdk.aws_medialive.CfnChannel.CaptionDescriptionProperty
TypeScript	@aws-cdk/aws-medialive » CfnChannel » CaptionDescriptionProperty

The encoding information for output captions.

The parent of this entity is EncoderSettings.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive from '@aws-cdk/aws-medialive';
const captionDescriptionProperty: medialive.CfnChannel.CaptionDescriptionProperty = {
  accessibility: 'accessibility',
  captionSelectorName: 'captionSelectorName',
  destinationSettings: {
    aribDestinationSettings: { },
    burnInDestinationSettings: {
      alignment: 'alignment',
      backgroundColor: 'backgroundColor',
      backgroundOpacity: 123,
      font: {
        passwordParam: 'passwordParam',
        uri: 'uri',
        username: 'username',
      },
      fontColor: 'fontColor',
      fontOpacity: 123,
      fontResolution: 123,
      fontSize: 'fontSize',
      outlineColor: 'outlineColor',
      outlineSize: 123,
      shadowColor: 'shadowColor',
      shadowOpacity: 123,
      shadowXOffset: 123,
      shadowYOffset: 123,
      teletextGridControl: 'teletextGridControl',
      xPosition: 123,
      yPosition: 123,
    },
    dvbSubDestinationSettings: {
      alignment: 'alignment',
      backgroundColor: 'backgroundColor',
      backgroundOpacity: 123,
      font: {
        passwordParam: 'passwordParam',
        uri: 'uri',
        username: 'username',
      },
      fontColor: 'fontColor',
      fontOpacity: 123,
      fontResolution: 123,
      fontSize: 'fontSize',
      outlineColor: 'outlineColor',
      outlineSize: 123,
      shadowColor: 'shadowColor',
      shadowOpacity: 123,
      shadowXOffset: 123,
      shadowYOffset: 123,
      teletextGridControl: 'teletextGridControl',
      xPosition: 123,
      yPosition: 123,
    },
    ebuTtDDestinationSettings: {
      copyrightHolder: 'copyrightHolder',
      fillLineGap: 'fillLineGap',
      fontFamily: 'fontFamily',
      styleControl: 'styleControl',
    },
    embeddedDestinationSettings: { },
    embeddedPlusScte20DestinationSettings: { },
    rtmpCaptionInfoDestinationSettings: { },
    scte20PlusEmbeddedDestinationSettings: { },
    scte27DestinationSettings: { },
    smpteTtDestinationSettings: { },
    teletextDestinationSettings: { },
    ttmlDestinationSettings: {
      styleControl: 'styleControl',
    },
    webvttDestinationSettings: {
      styleControl: 'styleControl',
    },
  },
  languageCode: 'languageCode',
  languageDescription: 'languageDescription',
  name: 'name',
};

Properties

Name	Type	Description
accessibility?	string	CfnChannel.CaptionDescriptionProperty.Accessibility.
captionSelectorName?	string	Specifies which input captions selector to use as a captions source when generating output captions.
destinationSettings?	IResolvable | CaptionDestinationSettingsProperty	Additional settings for a captions destination that depend on the destination type.
languageCode?	string	An ISO 639-2 three-digit code.
languageDescription?	string	Human-readable information to indicate the captions that are available for players (for example, English or Spanish).
name?	string	The name of the captions description.

---

accessibility?

Type: string (optional)

CfnChannel.CaptionDescriptionProperty.Accessibility.

---

captionSelectorName?

Type: string (optional)

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

This field should match a captionSelector name.

---

destinationSettings?

Type: IResolvable | CaptionDestinationSettingsProperty (optional)

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

---

languageCode?

Type: string (optional)

An ISO 639-2 three-digit code.

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

---

languageDescription?

Type: string (optional)

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

---

name?

Type: string (optional)

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.