AWS CDK Reference

Appearance

v2.273.0

CaptionDestination Class ​

The output caption format for a caption encode.

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

Stability
Experimental
Source
lib/caption-settings.ts

Example ​

ts
// 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 ​

ts
new CaptionDestination()
python
CaptionDestination()
java
new CaptionDestination()
csharp
new CaptionDestination()
go
NewCaptionDestination()

Methods ​

arib(): CaptionDestination // chainable@staticmethod def arib() -> CaptionDestinationpublic static CaptionDestination arib()public static CaptionDestination Arib()func Arib() CaptionDestinationstatic#
ARIB captions.
burnIn(props?: BurnInDestinationProps): CaptionDestination // chainable@staticmethod def burn_in(props: typing.Optional[BurnInDestinationProps] = None) -> CaptionDestinationpublic static CaptionDestination burnIn(BurnInDestinationProps props)public static CaptionDestination BurnIn(BurnInDestinationProps? props = null)func BurnIn(Props BurnInDestinationProps) CaptionDestinationstatic#
Burned-in captions rendered into the video.
dvbSub(props?: DvbSubDestinationProps): CaptionDestination // chainable@staticmethod def dvb_sub(props: typing.Optional[DvbSubDestinationProps] = None) -> CaptionDestinationpublic static CaptionDestination dvbSub(DvbSubDestinationProps props)public static CaptionDestination DvbSub(DvbSubDestinationProps? props = null)func DvbSub(Props DvbSubDestinationProps) CaptionDestinationstatic#
DVB-Sub bitmap captions.
ebuTtD(props?: EbuTtDDestinationProps): CaptionDestination // chainable@staticmethod def ebu_tt_d(props: typing.Optional[EbuTtDDestinationProps] = None) -> CaptionDestinationpublic static CaptionDestination ebuTtD(EbuTtDDestinationProps props)public static CaptionDestination EbuTtD(EbuTtDDestinationProps? props = null)func EbuTtD(Props EbuTtDDestinationProps) CaptionDestinationstatic#
EBU-TT-D sidecar captions.
embedded(): CaptionDestination // chainable@staticmethod def embedded() -> CaptionDestinationpublic static CaptionDestination embedded()public static CaptionDestination Embedded()func Embedded() CaptionDestinationstatic#
Embedded (CEA-608/708) captions.
embeddedPlusScte20(): CaptionDestination // chainable@staticmethod def embedded_plus_scte20() -> CaptionDestinationpublic static CaptionDestination embeddedPlusScte20()public static CaptionDestination EmbeddedPlusScte20()func EmbeddedPlusScte20() CaptionDestinationstatic#
Embedded plus SCTE-20 captions.
rtmpCaptionInfo(): CaptionDestination // chainable@staticmethod def rtmp_caption_info() -> CaptionDestinationpublic static CaptionDestination rtmpCaptionInfo()public static CaptionDestination RtmpCaptionInfo()func RtmpCaptionInfo() CaptionDestinationstatic#
RTMP CaptionInfo captions.
scte20PlusEmbedded(): CaptionDestination // chainable@staticmethod def scte20_plus_embedded() -> CaptionDestinationpublic static CaptionDestination scte20PlusEmbedded()public static CaptionDestination Scte20PlusEmbedded()func Scte20PlusEmbedded() CaptionDestinationstatic#
SCTE-20 plus embedded captions.
smpteTt(): CaptionDestination // chainable@staticmethod def smpte_tt() -> CaptionDestinationpublic static CaptionDestination smpteTt()public static CaptionDestination SmpteTt()func SmpteTt() CaptionDestinationstatic#
SMPTE-TT sidecar captions.
teletext(): CaptionDestination // chainable@staticmethod def teletext() -> CaptionDestinationpublic static CaptionDestination teletext()public static CaptionDestination Teletext()func Teletext() CaptionDestinationstatic#
Teletext captions.
ttml(props?: TtmlDestinationProps): CaptionDestination // chainable@staticmethod def ttml(props: typing.Optional[TtmlDestinationProps] = None) -> CaptionDestinationpublic static CaptionDestination ttml(TtmlDestinationProps props)public static CaptionDestination Ttml(TtmlDestinationProps? props = null)func Ttml(Props TtmlDestinationProps) CaptionDestinationstatic#
TTML sidecar captions.
webvtt(props?: WebvttDestinationProps): CaptionDestination // chainable@staticmethod def webvtt(props: typing.Optional[WebvttDestinationProps] = None) -> CaptionDestinationpublic static CaptionDestination webvtt(WebvttDestinationProps props)public static CaptionDestination Webvtt(WebvttDestinationProps? props = null)func Webvtt(Props WebvttDestinationProps) CaptionDestinationstatic#
WebVTT sidecar captions.