class CaptionSelector 🔹

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

A caption selector that identifies which captions to extract from the input.

Create with the static factory methods — one per caption source format.

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 (protected)

super(name: string)

Parameters

• name string

Properties

Name	Type	Description
name🔹	string	The name of this caption selector, used to associate it with caption outputs.

---

name🔹

Type: string

The name of this caption selector, used to associate it with caption outputs.

Unique within a channel.

Methods

Name	Description
static ancillary(name, options?)🔹	Select ancillary captions.
static arib(name)🔹	Select ARIB captions.
static byLanguage(name, languageCode)🔹	Select captions by language code (no specific source format).
static dvbSub(name, options?)🔹	Select DVB-Sub (image-based) captions.
static embedded(name, options?)🔹	Select embedded (CEA-608/708) captions.
static scte20(name, options?)🔹	Select SCTE-20 captions.
static scte27(name, options?)🔹	Select SCTE-27 (image-based) captions.
static smartSubtitle(name, options?)🔹	Select smart subtitles generated by Elemental Inference.
static teletext(name, options?)🔹	Select Teletext captions.

---

static ancillary(name, options?)🔹

public static ancillary(name: string, options?: AncillaryCaptionSourceOptions): CaptionSelector

Parameters

• name string
• options AncillaryCaptionSourceOptions

Returns

• CaptionSelector

Select ancillary captions.

---

static arib(name)🔹

public static arib(name: string): CaptionSelector

Parameters

• name string

Returns

• CaptionSelector

Select ARIB captions.

---

static byLanguage(name, languageCode)🔹

public static byLanguage(name: string, languageCode: string): CaptionSelector

Parameters

• name string
• languageCode string

Returns

• CaptionSelector

Select captions by language code (no specific source format).

---

static dvbSub(name, options?)🔹

public static dvbSub(name: string, options?: DvbSubCaptionSourceOptions): CaptionSelector

Parameters

• name string
• options DvbSubCaptionSourceOptions

Returns

• CaptionSelector

Select DVB-Sub (image-based) captions.

---

static embedded(name, options?)🔹

public static embedded(name: string, options?: EmbeddedCaptionSourceOptions): CaptionSelector

Parameters

• name string
• options EmbeddedCaptionSourceOptions

Returns

• CaptionSelector

Select embedded (CEA-608/708) captions.

---

static scte20(name, options?)🔹

public static scte20(name: string, options?: Scte20CaptionSourceOptions): CaptionSelector

Parameters

• name string
• options Scte20CaptionSourceOptions

Returns

• CaptionSelector

Select SCTE-20 captions.

---

static scte27(name, options?)🔹

public static scte27(name: string, options?: Scte27CaptionSourceOptions): CaptionSelector

Parameters

• name string
• options Scte27CaptionSourceOptions

Returns

• CaptionSelector

Select SCTE-27 (image-based) captions.

---

static smartSubtitle(name, options?)🔹

public static smartSubtitle(name: string, options?: SmartSubtitleSourceOptions): CaptionSelector

Parameters

• name string
• options SmartSubtitleSourceOptions

Returns

• CaptionSelector

Select smart subtitles generated by Elemental Inference.

---

static teletext(name, options?)🔹

public static teletext(name: string, options?: TeletextCaptionSourceOptions): CaptionSelector

Parameters

• name string
• options TeletextCaptionSourceOptions

Returns

• CaptionSelector

Select Teletext captions.