@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
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,
  }),
});

# Define a caption selector on the input attachment (see Input Attachment Settings below)
caption_selector = medialive.CaptionSelector.embedded("captions")

# WebVTT captions
webvtt = medialive.EncodeConfiguration.caption(
    name="eng_webvtt",
    caption_selector_name=caption_selector.name,
    language_code="eng",
    language_description="English",
    destination=medialive.CaptionDestination.webvtt()
)

# Burned-in captions — rendered into the video, styled via the burn-in options
burn_in = medialive.EncodeConfiguration.caption(
    name="eng_burnin",
    caption_selector_name=caption_selector.name,
    destination=medialive.CaptionDestination.burn_in(
        alignment=medialive.CaptionAlignment.CENTERED,
        font_color=medialive.CaptionFontColor.WHITE,
        outline_color=medialive.CaptionOutlineColor.BLACK,
        font_size=medialive.CaptionFontSize.AUTO
    )
)

// Define a caption selector on the input attachment (see Input Attachment Settings below)
CaptionSelector captionSelector = CaptionSelector.embedded("captions");

// WebVTT captions
EncodeConfiguration webvtt = EncodeConfiguration.caption(CaptionEncodeProps.builder()
        .name("eng_webvtt")
        .captionSelectorName(captionSelector.getName())
        .languageCode("eng")
        .languageDescription("English")
        .destination(CaptionDestination.webvtt())
        .build());

// Burned-in captions — rendered into the video, styled via the burn-in options
EncodeConfiguration burnIn = EncodeConfiguration.caption(CaptionEncodeProps.builder()
        .name("eng_burnin")
        .captionSelectorName(captionSelector.getName())
        .destination(CaptionDestination.burnIn(BurnInDestinationProps.builder()
                .alignment(CaptionAlignment.CENTERED)
                .fontColor(CaptionFontColor.WHITE)
                .outlineColor(CaptionOutlineColor.BLACK)
                .fontSize(CaptionFontSize.AUTO)
                .build()))
        .build());

// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// Define a caption selector on the input attachment (see Input Attachment Settings below)
var captionSelector = CaptionSelector.Embedded("captions");

// WebVTT captions
var webvtt = EncodeConfiguration.Caption(new CaptionEncodeProps {
    Name = "eng_webvtt",
    CaptionSelectorName = captionSelector.Name,
    LanguageCode = "eng",
    LanguageDescription = "English",
    Destination = CaptionDestination.Webvtt()
});

// Burned-in captions — rendered into the video, styled via the burn-in options
var burnIn = EncodeConfiguration.Caption(new CaptionEncodeProps {
    Name = "eng_burnin",
    CaptionSelectorName = captionSelector.Name,
    Destination = CaptionDestination.BurnIn(new BurnInDestinationProps {
        Alignment = CaptionAlignment.CENTERED,
        FontColor = CaptionFontColor.WHITE,
        OutlineColor = CaptionOutlineColor.BLACK,
        FontSize = CaptionFontSize.AUTO
    })
});

// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// Define a caption selector on the input attachment (see Input Attachment Settings below)
captionSelector := medialive.CaptionSelector_Embedded(jsii.String("captions"))

// WebVTT captions
webvtt := medialive.EncodeConfiguration_Caption(&CaptionEncodeProps{
	Name: jsii.String("eng_webvtt"),
	CaptionSelectorName: captionSelector.Name,
	LanguageCode: jsii.String("eng"),
	LanguageDescription: jsii.String("English"),
	Destination: medialive.CaptionDestination_Webvtt(),
})

// Burned-in captions — rendered into the video, styled via the burn-in options
burnIn := medialive.EncodeConfiguration_Caption(&CaptionEncodeProps{
	Name: jsii.String("eng_burnin"),
	CaptionSelectorName: captionSelector.*Name,
	Destination: medialive.CaptionDestination_BurnIn(&BurnInDestinationProps{
		Alignment: medialive.CaptionAlignment_CENTERED(),
		FontColor: medialive.CaptionFontColor_WHITE(),
		OutlineColor: medialive.CaptionOutlineColor_BLACK(),
		FontSize: medialive.CaptionFontSize_AUTO(),
	}),
})

Properties

accessibility?optionalCaptionAccessibilityaccessibility?optionalCaptionAccessibilityaccessibility?optionalCaptionAccessibilityAccessibility?optionalCaptionAccessibilityAccessibility?optionalCaptionAccessibility#

Whether this caption track implements accessibility features.

Default: The captions do not implement accessibility features

captionDashRoles?optionalCaptionDashRole[]caption_dash_roles?optionaltyping.List[CaptionDashRole]captionDashRoles?optionalList<CaptionDashRole>CaptionDashRoles?optionalCaptionDashRole[]CaptionDashRoles?optional*[]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()).

dvbDashAccessibility?optionalDvbDashAccessibilitydvb_dash_accessibility?optionalDvbDashAccessibilitydvbDashAccessibility?optionalDvbDashAccessibilityDvbDashAccessibility?optionalDvbDashAccessibilityDvbDashAccessibility?optionalDvbDashAccessibility#

DVB DASH accessibility signaling for this captions output.

Default: no DVB DASH accessibility signaling

languageCode?optionalstringlanguage_code?optionalstrlanguageCode?optionalStringLanguageCode?optionalstringLanguageCode?optional*string#

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

Default: no language code

languageDescription?optionalstringlanguage_description?optionalstrlanguageDescription?optionalStringLanguageDescription?optionalstringLanguageDescription?optional*string#

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

Default: no language description

namestringnamestrnameStringNamestringName*stringrequired#

A unique name for this caption encode.