Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
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
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,
}),
});
python
# Define a caption selector on the input attachment (see Input Attachment Settings below)
caption_selector = medialive.CaptionSelector.embedded("captions")
# WebVTT captions
webvtt = medialive.EncodeConfiguration.caption(
name="eng_webvtt",
caption_selector_name=caption_selector.name,
language_code="eng",
language_description="English",
destination=medialive.CaptionDestination.webvtt()
)
# Burned-in captions — rendered into the video, styled via the burn-in options
burn_in = medialive.EncodeConfiguration.caption(
name="eng_burnin",
caption_selector_name=caption_selector.name,
destination=medialive.CaptionDestination.burn_in(
alignment=medialive.CaptionAlignment.CENTERED,
font_color=medialive.CaptionFontColor.WHITE,
outline_color=medialive.CaptionOutlineColor.BLACK,
font_size=medialive.CaptionFontSize.AUTO
)
)
java
// Define a caption selector on the input attachment (see Input Attachment Settings below)
CaptionSelector captionSelector = CaptionSelector.embedded("captions");
// WebVTT captions
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());
csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// Define a caption selector on the input attachment (see Input Attachment Settings below)
var captionSelector = CaptionSelector.Embedded("captions");
// WebVTT captions
var webvtt = EncodeConfiguration.Caption(new CaptionEncodeProps {
Name = "eng_webvtt",
CaptionSelectorName = captionSelector.Name,
LanguageCode = "eng",
LanguageDescription = "English",
Destination = CaptionDestination.Webvtt()
});
// Burned-in captions — rendered into the video, styled via the burn-in options
var burnIn = EncodeConfiguration.Caption(new CaptionEncodeProps {
Name = "eng_burnin",
CaptionSelectorName = captionSelector.Name,
Destination = CaptionDestination.BurnIn(new BurnInDestinationProps {
Alignment = CaptionAlignment.CENTERED,
FontColor = CaptionFontColor.WHITE,
OutlineColor = CaptionOutlineColor.BLACK,
FontSize = CaptionFontSize.AUTO
})
});
go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// Define a caption selector on the input attachment (see Input Attachment Settings below)
captionSelector := medialive.CaptionSelector_Embedded(jsii.String("captions"))
// WebVTT captions
webvtt := medialive.EncodeConfiguration_Caption(&CaptionEncodeProps{
Name: jsii.String("eng_webvtt"),
CaptionSelectorName: captionSelector.Name,
LanguageCode: jsii.String("eng"),
LanguageDescription: jsii.String("English"),
Destination: medialive.CaptionDestination_Webvtt(),
})
// Burned-in captions — rendered into the video, styled via the burn-in options
burnIn := medialive.EncodeConfiguration_Caption(&CaptionEncodeProps{
Name: jsii.String("eng_burnin"),
CaptionSelectorName: captionSelector.*Name,
Destination: medialive.CaptionDestination_BurnIn(&BurnInDestinationProps{
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() CaptionDestination static #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) CaptionDestination static #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) CaptionDestination static #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) CaptionDestination static #EBU-TT-D sidecar captions.
embedded(): CaptionDestination // chainable@staticmethod def embedded() -> CaptionDestinationpublic static CaptionDestination embedded()public static CaptionDestination Embedded()func Embedded() CaptionDestination static #Embedded (CEA-608/708) captions.
embeddedPlusScte20(): CaptionDestination // chainable@staticmethod def embedded_plus_scte20() -> CaptionDestinationpublic static CaptionDestination embeddedPlusScte20()public static CaptionDestination EmbeddedPlusScte20()func EmbeddedPlusScte20() CaptionDestination static #Embedded plus SCTE-20 captions.
rtmpCaptionInfo(): CaptionDestination // chainable@staticmethod def rtmp_caption_info() -> CaptionDestinationpublic static CaptionDestination rtmpCaptionInfo()public static CaptionDestination RtmpCaptionInfo()func RtmpCaptionInfo() CaptionDestination static #RTMP CaptionInfo captions.
scte20PlusEmbedded(): CaptionDestination // chainable@staticmethod def scte20_plus_embedded() -> CaptionDestinationpublic static CaptionDestination scte20PlusEmbedded()public static CaptionDestination Scte20PlusEmbedded()func Scte20PlusEmbedded() CaptionDestination static #SCTE-20 plus embedded captions.
smpteTt(): CaptionDestination // chainable@staticmethod def smpte_tt() -> CaptionDestinationpublic static CaptionDestination smpteTt()public static CaptionDestination SmpteTt()func SmpteTt() CaptionDestination static #SMPTE-TT sidecar captions.
teletext(): CaptionDestination // chainable@staticmethod def teletext() -> CaptionDestinationpublic static CaptionDestination teletext()public static CaptionDestination Teletext()func Teletext() CaptionDestination static #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) CaptionDestination static #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) CaptionDestination static #WebVTT sidecar captions.