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

Experimental

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

CaptionEncodeProps Struct

Properties for a caption encode configuration.

Stability

Experimental

Source

lib/encode-configuration.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

accessibilityCaptionAccessibilityaccessibilityCaptionAccessibilityaccessibilityCaptionAccessibilityAccessibilityCaptionAccessibilityAccessibilityCaptionAccessibility= The captions do not implement ac…#

Whether this caption track implements accessibility features.

default

Default: The captions do not implement accessibility features

captionDashRolesCaptionDashRole[]caption_dash_rolestyping.List[CaptionDashRole]captionDashRolesList<CaptionDashRole>CaptionDashRolesCaptionDashRole[]CaptionDashRoles*[]CaptionDashRole= no DASH roles#

The DASH roles to assign to this captions output.

Applies only when the output is configured for DVB DASH accessibility signaling.

captionSelectorNamestringcaption_selector_namestrcaptionSelectorNameStringCaptionSelectorNamestringCaptionSelectorName*stringrequired#

The name of the caption selector in the input to use as the source.

destinationCaptionDestinationdestinationCaptionDestinationdestinationCaptionDestinationDestinationCaptionDestinationDestinationCaptionDestinationrequired#

The output caption format.

Use the CaptionDestination factory methods (e.g. CaptionDestination.burnIn(), .webvtt(), .embedded()).

dvbDashAccessibilityDvbDashAccessibilitydvb_dash_accessibilityDvbDashAccessibilitydvbDashAccessibilityDvbDashAccessibilityDvbDashAccessibilityDvbDashAccessibilityDvbDashAccessibilityDvbDashAccessibility= no DVB DASH accessibility signal…#

DVB DASH accessibility signaling for this captions output.

default

Default: no DVB DASH accessibility signaling

languageCodestringlanguage_codestrlanguageCodeStringLanguageCodestringLanguageCode*string= no language code#

The ISO 639-2 language code for the captions (e.g. 'eng', 'spa').

languageDescriptionstringlanguage_descriptionstrlanguageDescriptionStringLanguageDescriptionstringLanguageDescription*string= no language description#

Human-readable description of the captions (e.g. 'English', 'Spanish').

namestringnamestrnameStringNamestringName*stringrequired#

A unique name for this caption encode.