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.
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
accessibilityoptionalCaptionAccessibilityaccessibilityoptionalCaptionAccessibilityaccessibilityoptionalCaptionAccessibilityAccessibilityoptionalCaptionAccessibilityAccessibilityoptionalCaptionAccessibility#Whether this caption track implements accessibility features.
Default: The captions do not implement accessibility features
captionDashRolesoptionalCaptionDashRole[]caption_dash_rolesoptionaltyping.List[CaptionDashRole]captionDashRolesoptionalList<CaptionDashRole>CaptionDashRolesoptionalCaptionDashRole[]CaptionDashRolesoptional*[]CaptionDashRole#The DASH roles to assign to this captions output.
Default: no DASH roles
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()).
dvbDashAccessibilityoptionalDvbDashAccessibilitydvb_dash_accessibilityoptionalDvbDashAccessibilitydvbDashAccessibilityoptionalDvbDashAccessibilityDvbDashAccessibilityoptionalDvbDashAccessibilityDvbDashAccessibilityoptionalDvbDashAccessibility#DVB DASH accessibility signaling for this captions output.
Default: no DVB DASH accessibility signaling
languageCodeoptionalstringlanguage_codeoptionalstrlanguageCodeoptionalStringLanguageCodeoptionalstringLanguageCodeoptional*string#The ISO 639-2 language code for the captions (e.g. 'eng', 'spa').
Default: no language code
languageDescriptionoptionalstringlanguage_descriptionoptionalstrlanguageDescriptionoptionalStringLanguageDescriptionoptionalstringLanguageDescriptionoptional*string#Human-readable description of the captions (e.g. 'English', 'Spanish').
Default: no language description
A unique name for this caption encode.