Package software.amazon.awscdk.services.medialive.alpha

Class CaptionSelector

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.medialive.alpha.CaptionSelector

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.957Z")
@Stability(Experimental)
public abstract class CaptionSelector
extends software.amazon.jsii.JsiiObject

(experimental) 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)
 CaptionSelector captionSelector = CaptionSelector.embedded("captions");
 // WebVTT captions — packaged alongside the video encode in the same output
 EncodeConfiguration webvtt = EncodeConfiguration.caption(CaptionEncodeProps.builder()
         .name("eng_webvtt")
         .captionSelectorName(captionSelector.getName())
         .languageCode("eng")
         .languageDescription("English")
         .destination(CaptionDestination.webvtt())
         .build());
 // Burned-in captions — rendered into the video, styled via the burn-in options
 EncodeConfiguration burnIn = EncodeConfiguration.caption(CaptionEncodeProps.builder()
         .name("eng_burnin")
         .captionSelectorName(captionSelector.getName())
         .destination(CaptionDestination.burnIn(BurnInDestinationProps.builder()
                 .alignment(CaptionAlignment.CENTERED)
                 .fontColor(CaptionFontColor.WHITE)
                 .outlineColor(CaptionOutlineColor.BLACK)
                 .fontSize(CaptionFontSize.AUTO)
                 .build()))
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CaptionSelector(String name)
protected	CaptionSelector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CaptionSelector(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static CaptionSelector	ancillary(String name)	(experimental) Select ancillary captions.
static CaptionSelector	ancillary(String name, AncillaryCaptionSourceOptions options)	(experimental) Select ancillary captions.
static CaptionSelector	arib(String name)	(experimental) Select ARIB captions.
static CaptionSelector	byLanguage(String name, String languageCode)	(experimental) Select captions by language code (no specific source format).
static CaptionSelector	dvbSub(String name)	(experimental) Select DVB-Sub (image-based) captions.
static CaptionSelector	dvbSub(String name, DvbSubCaptionSourceOptions options)	(experimental) Select DVB-Sub (image-based) captions.
static CaptionSelector	embedded(String name)	(experimental) Select embedded (CEA-608/708) captions.
static CaptionSelector	embedded(String name, EmbeddedCaptionSourceOptions options)	(experimental) Select embedded (CEA-608/708) captions.
String	getName()	(experimental) The name of this caption selector, used to associate it with caption outputs.
static CaptionSelector	scte20(String name)	(experimental) Select SCTE-20 captions.
static CaptionSelector	scte20(String name, Scte20CaptionSourceOptions options)	(experimental) Select SCTE-20 captions.
static CaptionSelector	scte27(String name)	(experimental) Select SCTE-27 (image-based) captions.
static CaptionSelector	scte27(String name, Scte27CaptionSourceOptions options)	(experimental) Select SCTE-27 (image-based) captions.
static CaptionSelector	smartSubtitle(String name)	(experimental) Select smart subtitles generated by Elemental Inference.
static CaptionSelector	smartSubtitle(String name, SmartSubtitleSourceOptions options)	(experimental) Select smart subtitles generated by Elemental Inference.
static CaptionSelector	teletext(String name)	(experimental) Select Teletext captions.
static CaptionSelector	teletext(String name, TeletextCaptionSourceOptions options)	(experimental) Select Teletext captions.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

CaptionSelector

protected CaptionSelector(software.amazon.jsii.JsiiObjectRef objRef)

CaptionSelector

protected CaptionSelector(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CaptionSelector

@Stability(Experimental)
protected CaptionSelector(@NotNull
 String name)

Parameters:

name - This parameter is required.

Method Details

ancillary

@Stability(Experimental)
@NotNull
public static CaptionSelector ancillary(@NotNull
 String name,
 @Nullable
 AncillaryCaptionSourceOptions options)

(experimental) Select ancillary captions.

Parameters:

name - This parameter is required.

options -

ancillary

@Stability(Experimental)
@NotNull
public static CaptionSelector ancillary(@NotNull
 String name)

(experimental) Select ancillary captions.

Parameters:

name - This parameter is required.

arib

@Stability(Experimental)
@NotNull
public static CaptionSelector arib(@NotNull
 String name)

(experimental) Select ARIB captions.

Parameters:

name - This parameter is required.

byLanguage

@Stability(Experimental)
@NotNull
public static CaptionSelector byLanguage(@NotNull
 String name,
 @NotNull
 String languageCode)

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

Parameters:

name - This parameter is required.

languageCode - This parameter is required.

dvbSub

@Stability(Experimental)
@NotNull
public static CaptionSelector dvbSub(@NotNull
 String name,
 @Nullable
 DvbSubCaptionSourceOptions options)

(experimental) Select DVB-Sub (image-based) captions.

Parameters:

name - This parameter is required.

options -

dvbSub

@Stability(Experimental)
@NotNull
public static CaptionSelector dvbSub(@NotNull
 String name)

(experimental) Select DVB-Sub (image-based) captions.

Parameters:

name - This parameter is required.

embedded

@Stability(Experimental)
@NotNull
public static CaptionSelector embedded(@NotNull
 String name,
 @Nullable
 EmbeddedCaptionSourceOptions options)

(experimental) Select embedded (CEA-608/708) captions.

Parameters:

name - This parameter is required.

options -

embedded

@Stability(Experimental)
@NotNull
public static CaptionSelector embedded(@NotNull
 String name)

(experimental) Select embedded (CEA-608/708) captions.

Parameters:

name - This parameter is required.

scte20

@Stability(Experimental)
@NotNull
public static CaptionSelector scte20(@NotNull
 String name,
 @Nullable
 Scte20CaptionSourceOptions options)

(experimental) Select SCTE-20 captions.

Parameters:

name - This parameter is required.

options -

scte20

@Stability(Experimental)
@NotNull
public static CaptionSelector scte20(@NotNull
 String name)

(experimental) Select SCTE-20 captions.

Parameters:

name - This parameter is required.

scte27

@Stability(Experimental)
@NotNull
public static CaptionSelector scte27(@NotNull
 String name,
 @Nullable
 Scte27CaptionSourceOptions options)

(experimental) Select SCTE-27 (image-based) captions.

Parameters:

name - This parameter is required.

options -

scte27

@Stability(Experimental)
@NotNull
public static CaptionSelector scte27(@NotNull
 String name)

(experimental) Select SCTE-27 (image-based) captions.

Parameters:

name - This parameter is required.

smartSubtitle

@Stability(Experimental)
@NotNull
public static CaptionSelector smartSubtitle(@NotNull
 String name,
 @Nullable
 SmartSubtitleSourceOptions options)

(experimental) Select smart subtitles generated by Elemental Inference.

Parameters:

name - This parameter is required.

options -

smartSubtitle

@Stability(Experimental)
@NotNull
public static CaptionSelector smartSubtitle(@NotNull
 String name)

(experimental) Select smart subtitles generated by Elemental Inference.

Parameters:

name - This parameter is required.

teletext

@Stability(Experimental)
@NotNull
public static CaptionSelector teletext(@NotNull
 String name,
 @Nullable
 TeletextCaptionSourceOptions options)

(experimental) Select Teletext captions.

Parameters:

name - This parameter is required.

options -

teletext

@Stability(Experimental)
@NotNull
public static CaptionSelector teletext(@NotNull
 String name)

(experimental) Select Teletext captions.

Parameters:

name - This parameter is required.

getName

@Stability(Experimental)
@NotNull
public String getName()

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

Unique within a channel.