class CaptionDestination 🔹

Language	Type name
.NET	Amazon.CDK.AWS.MediaLive.Alpha.CaptionDestination
Go	github.com/aws/aws-cdk-go/awsmedialivealpha/v2#CaptionDestination
Java	software.amazon.awscdk.services.medialive.alpha.CaptionDestination
Python	aws_cdk.aws_medialive_alpha.CaptionDestination
TypeScript (source)	@aws-cdk/aws-medialive-alpha » CaptionDestination

The output caption format for a caption encode.

Use the static factory methods to select one of the supported destination types.

Example

// Define a caption selector on the input attachment (see Input Attachment Settings below)
const captionSelector = medialive.CaptionSelector.embedded('captions');

// WebVTT captions — packaged alongside the video encode in the same output
const webvtt = medialive.EncodeConfiguration.caption({
  name: 'eng_webvtt',
  captionSelectorName: captionSelector.name,
  languageCode: 'eng',
  languageDescription: 'English',
  destination: medialive.CaptionDestination.webvtt(),
});

// Burned-in captions — rendered into the video, styled via the burn-in options
const burnIn = medialive.EncodeConfiguration.caption({
  name: 'eng_burnin',
  captionSelectorName: captionSelector.name,
  destination: medialive.CaptionDestination.burnIn({
    alignment: medialive.CaptionAlignment.CENTERED,
    fontColor: medialive.CaptionFontColor.WHITE,
    outlineColor: medialive.CaptionOutlineColor.BLACK,
    fontSize: medialive.CaptionFontSize.AUTO,
  }),
});

Initializer

new CaptionDestination()

Methods

Name	Description
static arib()🔹	ARIB captions.
static burnIn(props?)🔹	Burned-in captions rendered into the video.
static dvbSub(props?)🔹	DVB-Sub bitmap captions.
static ebuTtD(props?)🔹	EBU-TT-D sidecar captions.
static embedded()🔹	Embedded (CEA-608/708) captions.
static embeddedPlusScte20()🔹	Embedded plus SCTE-20 captions.
static rtmpCaptionInfo()🔹	RTMP CaptionInfo captions.
static scte20PlusEmbedded()🔹	SCTE-20 plus embedded captions.
static smpteTt()🔹	SMPTE-TT sidecar captions.
static teletext()🔹	Teletext captions.
static ttml(props?)🔹	TTML sidecar captions.
static webvtt(props?)🔹	WebVTT sidecar captions.

---

static arib()🔹

public static arib(): CaptionDestination

Returns

• CaptionDestination

ARIB captions.

---

static burnIn(props?)🔹

public static burnIn(props?: BurnInDestinationProps): CaptionDestination

Parameters

• props BurnInDestinationProps

Returns

• CaptionDestination

Burned-in captions rendered into the video.

---

static dvbSub(props?)🔹

public static dvbSub(props?: DvbSubDestinationProps): CaptionDestination

Parameters

• props DvbSubDestinationProps

Returns

• CaptionDestination

DVB-Sub bitmap captions.

---

static ebuTtD(props?)🔹

public static ebuTtD(props?: EbuTtDDestinationProps): CaptionDestination

Parameters

• props EbuTtDDestinationProps

Returns

• CaptionDestination

EBU-TT-D sidecar captions.

---

static embedded()🔹

public static embedded(): CaptionDestination

Returns

• CaptionDestination

Embedded (CEA-608/708) captions.

---

static embeddedPlusScte20()🔹

public static embeddedPlusScte20(): CaptionDestination

Returns

• CaptionDestination

Embedded plus SCTE-20 captions.

---

static rtmpCaptionInfo()🔹

public static rtmpCaptionInfo(): CaptionDestination

Returns

• CaptionDestination

RTMP CaptionInfo captions.

---

static scte20PlusEmbedded()🔹

public static scte20PlusEmbedded(): CaptionDestination

Returns

• CaptionDestination

SCTE-20 plus embedded captions.

---

static smpteTt()🔹

public static smpteTt(): CaptionDestination

Returns

• CaptionDestination

SMPTE-TT sidecar captions.

---

static teletext()🔹

public static teletext(): CaptionDestination

Returns

• CaptionDestination

Teletext captions.

---

static ttml(props?)🔹

public static ttml(props?: TtmlDestinationProps): CaptionDestination

Parameters

• props TtmlDestinationProps

Returns

• CaptionDestination

TTML sidecar captions.

---

static webvtt(props?)🔹

public static webvtt(props?: WebvttDestinationProps): CaptionDestination

Parameters

• props WebvttDestinationProps

Returns

• CaptionDestination

WebVTT sidecar captions.