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

Experimental

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

CaptionAlignment Class

Caption alignment for burn-in and DVB-Sub outputs.

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

CENTEREDCaptionAlignmentcenteredCaptionAlignmentCENTEREDCaptionAlignmentCENTEREDCaptionAlignmentCENTEREDCaptionAlignmentrequiredstatic#

Center the captions.

LEFTCaptionAlignmentleftCaptionAlignmentLEFTCaptionAlignmentLEFTCaptionAlignmentLEFTCaptionAlignmentrequiredstatic#

Left-align the captions.

SMARTCaptionAlignmentsmartCaptionAlignmentSMARTCaptionAlignmentSMARTCaptionAlignmentSMARTCaptionAlignmentrequiredstatic#

Smart: left-justify live subtitles, center-justify pre-recorded subtitles.

valuestringvaluestrvalueStringValuestringValue*stringrequired#

The underlying string value passed to CloudFormation.

Methods

of(value: string): CaptionAlignment // chainable@staticmethod def of(value: str) -> CaptionAlignmentpublic static CaptionAlignment of(String value)public static CaptionAlignment Of(string value)func Of(Value *string) CaptionAlignmentstatic#

A value not yet modelled by AWS CDK.