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

Interface CaptionEncodeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CaptionEncodeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:40.949Z")
@Stability(Experimental)
public interface CaptionEncodeProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a caption encode configuration.

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

Modifier and Type	Interface	Description
static final class	CaptionEncodeProps.Builder	A builder for CaptionEncodeProps
static final class	CaptionEncodeProps.Jsii$Proxy	An implementation for CaptionEncodeProps

Method Summary

Modifier and Type	Method	Description
static CaptionEncodeProps.Builder	builder()
default CaptionAccessibility	getAccessibility()	(experimental) Whether this caption track implements accessibility features.
default List<CaptionDashRole>	getCaptionDashRoles()	(experimental) The DASH roles to assign to this captions output.
String	getCaptionSelectorName()	(experimental) The name of the caption selector in the input to use as the source.
CaptionDestination	getDestination()	(experimental) The output caption format.
default DvbDashAccessibility	getDvbDashAccessibility()	(experimental) DVB DASH accessibility signaling for this captions output.
default String	getLanguageCode()	(experimental) The ISO 639-2 language code for the captions (e.g.
default String	getLanguageDescription()	(experimental) Human-readable description of the captions (e.g.
String	getName()	(experimental) A unique name for this caption encode.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCaptionSelectorName

@Stability(Experimental)
@NotNull
String getCaptionSelectorName()

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

getDestination

@Stability(Experimental)
@NotNull
CaptionDestination getDestination()

(experimental) The output caption format.

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

getName

@Stability(Experimental)
@NotNull
String getName()

(experimental) A unique name for this caption encode.

getAccessibility

@Stability(Experimental)
@Nullable
default CaptionAccessibility getAccessibility()

(experimental) Whether this caption track implements accessibility features.

Default: - The captions do not implement accessibility features

getCaptionDashRoles

@Stability(Experimental)
@Nullable
default List<CaptionDashRole> getCaptionDashRoles()

(experimental) The DASH roles to assign to this captions output.

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

Default: - no DASH roles

getDvbDashAccessibility

@Stability(Experimental)
@Nullable
default DvbDashAccessibility getDvbDashAccessibility()

(experimental) DVB DASH accessibility signaling for this captions output.

Default: - no DVB DASH accessibility signaling

getLanguageCode

@Stability(Experimental)
@Nullable
default String getLanguageCode()

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

Default: - no language code

getLanguageDescription

@Stability(Experimental)
@Nullable
default String getLanguageDescription()

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

Default: - no language description

builder

@Stability(Experimental)
static CaptionEncodeProps.Builder builder()

Returns:

a CaptionEncodeProps.Builder of CaptionEncodeProps