@aws-cdk/aws-medialive-alpha.CaptionFontColor

Experimental

@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CaptionFontColor Class

Font color for burn-in and DVB-Sub captions.

Stability

Experimental

Source

lib/caption-settings.ts

Example

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

BLACKCaptionFontColorblackCaptionFontColorBLACKCaptionFontColorBLACKCaptionFontColorBLACKCaptionFontColorrequiredstatic#

Black.

BLUECaptionFontColorblueCaptionFontColorBLUECaptionFontColorBLUECaptionFontColorBLUECaptionFontColorrequiredstatic#

Blue.

GREENCaptionFontColorgreenCaptionFontColorGREENCaptionFontColorGREENCaptionFontColorGREENCaptionFontColorrequiredstatic#

Green.

REDCaptionFontColorredCaptionFontColorREDCaptionFontColorREDCaptionFontColorREDCaptionFontColorrequiredstatic#

Red.

valuestringvaluestrvalueStringValuestringValue*stringrequired#

The underlying string value passed to CloudFormation.

WHITECaptionFontColorwhiteCaptionFontColorWHITECaptionFontColorWHITECaptionFontColorWHITECaptionFontColorrequiredstatic#

White.

YELLOWCaptionFontColoryellowCaptionFontColorYELLOWCaptionFontColorYELLOWCaptionFontColorYELLOWCaptionFontColorrequiredstatic#

Yellow.

Methods

of(value: string): CaptionFontColor // chainable@staticmethod def of(value: str) -> CaptionFontColorpublic static CaptionFontColor of(String value)public static CaptionFontColor Of(string value)func Of(Value *string) CaptionFontColorstatic#

A value not yet modelled by AWS CDK.