Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
CaptionOutlineColor Class
Font outline color for burn-in and DVB-Sub captions.
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,
}),
});
Properties
BLACKCaptionOutlineColorblackCaptionOutlineColorBLACKCaptionOutlineColorBLACKCaptionOutlineColorBLACKCaptionOutlineColorstatic#Black.
BLUECaptionOutlineColorblueCaptionOutlineColorBLUECaptionOutlineColorBLUECaptionOutlineColorBLUECaptionOutlineColorstatic#Blue.
GREENCaptionOutlineColorgreenCaptionOutlineColorGREENCaptionOutlineColorGREENCaptionOutlineColorGREENCaptionOutlineColorstatic#Green.
REDCaptionOutlineColorredCaptionOutlineColorREDCaptionOutlineColorREDCaptionOutlineColorREDCaptionOutlineColorstatic#Red.
The underlying string value passed to CloudFormation.
WHITECaptionOutlineColorwhiteCaptionOutlineColorWHITECaptionOutlineColorWHITECaptionOutlineColorWHITECaptionOutlineColorstatic#White.
YELLOWCaptionOutlineColoryellowCaptionOutlineColorYELLOWCaptionOutlineColorYELLOWCaptionOutlineColorYELLOWCaptionOutlineColorstatic#Yellow.
Methods
of(value: string): CaptionOutlineColor // chainable@staticmethod def of(value: str) -> CaptionOutlineColorpublic static CaptionOutlineColor of(String value)public static CaptionOutlineColor Of(string value)func Of(Value *string) CaptionOutlineColorstatic#A value not yet modelled by AWS CDK.