CaptionEncodeProps

class aws_cdk.aws_medialive_alpha.CaptionEncodeProps(*, caption_selector_name, destination, name, accessibility=None, caption_dash_roles=None, dvb_dash_accessibility=None, language_code=None, language_description=None)

Bases: object

(experimental) Properties for a caption encode configuration.

Parameters:

  • caption_selector_name (str) – (experimental) The name of the caption selector in the input to use as the source.

  • destination (CaptionDestination) – (experimental) The output caption format. Use the CaptionDestination factory methods (e.g. CaptionDestination.burnIn(), .webvtt(), .embedded()).

  • name (str) – (experimental) A unique name for this caption encode.

  • accessibility (Optional[CaptionAccessibility]) – (experimental) Whether this caption track implements accessibility features. Default: - The captions do not implement accessibility features

  • caption_dash_roles (Optional[Sequence[CaptionDashRole]]) – (experimental) The DASH roles to assign to this captions output. Applies only when the output is configured for DVB DASH accessibility signaling. Default: - no DASH roles

  • dvb_dash_accessibility (Optional[DvbDashAccessibility]) – (experimental) DVB DASH accessibility signaling for this captions output. Default: - no DVB DASH accessibility signaling

  • language_code (Optional[str]) – (experimental) The ISO 639-2 language code for the captions (e.g. ‘eng’, ‘spa’). Default: - no language code

  • language_description (Optional[str]) – (experimental) Human-readable description of the captions (e.g. ‘English’, ‘Spanish’). Default: - no language description

Stability:

experimental

ExampleMetadata:

infused

Example:

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

# WebVTT captions — packaged alongside the video encode in the same output
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
    )
)

Attributes

accessibility

(experimental) Whether this caption track implements accessibility features.

Default:

  • The captions do not implement accessibility features

Stability:

experimental

caption_dash_roles

(experimental) The DASH roles to assign to this captions output.

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

Default:

  • no DASH roles

Stability:

experimental

caption_selector_name

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

Stability:

experimental

destination

(experimental) The output caption format.

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

Stability:

experimental

dvb_dash_accessibility

(experimental) DVB DASH accessibility signaling for this captions output.

Default:

  • no DVB DASH accessibility signaling

Stability:

experimental

language_code

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

Default:

  • no language code

Stability:

experimental

language_description

(experimental) Human-readable description of the captions (e.g. ‘English’, ‘Spanish’).

Default:

  • no language description

Stability:

experimental

name

(experimental) A unique name for this caption encode.

Stability:

experimental