interface CaptionEncodeProps 🔹

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

Properties for a caption encode configuration.

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,
  }),
});

Properties

Name	Type	Description
captionSelectorName🔹	string	The name of the caption selector in the input to use as the source.
destination🔹	CaptionDestination	The output caption format.
name🔹	string	A unique name for this caption encode.
accessibility?🔹	CaptionAccessibility	Whether this caption track implements accessibility features.
captionDashRoles?🔹	CaptionDashRole[]	The DASH roles to assign to this captions output.
dvbDashAccessibility?🔹	DvbDashAccessibility	DVB DASH accessibility signaling for this captions output.
languageCode?🔹	string	The ISO 639-2 language code for the captions (e.g. 'eng', 'spa').
languageDescription?🔹	string	Human-readable description of the captions (e.g. 'English', 'Spanish').

---

captionSelectorName🔹

Type: string

The name of the caption selector in the input to use as the source.

---

destination🔹

Type: CaptionDestination

The output caption format.

Use the CaptionDestination factory methods (e.g. CaptionDestination.burnIn(), .webvtt(), .embedded()).

---

name🔹

Type: string

A unique name for this caption encode.

---

accessibility?🔹

Type: CaptionAccessibility (optional, default: The captions do not implement accessibility features)

Whether this caption track implements accessibility features.

---

captionDashRoles?🔹

Type: CaptionDashRole[] (optional, default: no DASH roles)

The DASH roles to assign to this captions output.

Applies only when the output is configured for DVB DASH accessibility signaling.

---

dvbDashAccessibility?🔹

Type: DvbDashAccessibility (optional, default: no DVB DASH accessibility signaling)

DVB DASH accessibility signaling for this captions output.

---

languageCode?🔹

Type: string (optional, default: no language code)

The ISO 639-2 language code for the captions (e.g. 'eng', 'spa').

---

languageDescription?🔹

Type: string (optional, default: no language description)

Human-readable description of the captions (e.g. 'English', 'Spanish').