BurnInDestinationProps

class aws_cdk.aws_medialive_alpha.BurnInDestinationProps(*, alignment=None, background_color=None, background_opacity=None, font=None, font_color=None, font_opacity=None, font_resolution=None, font_size=None, outline_color=None, outline_size=None, shadow_color=None, shadow_opacity=None, shadow_x_offset=None, shadow_y_offset=None, subtitle_rows=None, teletext_grid_control=None, x_position=None, y_position=None)

Bases: CaptionFontStyleProps

(experimental) Properties for burn-in captions.

Parameters:

  • alignment (Optional[CaptionAlignment]) – (experimental) Caption alignment. With explicit x/y positions, the font is justified relative to them. Default: CaptionAlignment.CENTERED

  • background_color (Optional[CaptionBackgroundColor]) – (experimental) The color of the rectangle behind the captions. Default: - service default

  • background_opacity (Union[int, float, None]) – (experimental) The opacity of the background rectangle (0 transparent .. 255 opaque). Default: - service default

  • font (Optional[FileLocation]) – (experimental) An external font file (.ttf or .tte) used for burn-in. Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url). Default: - service default font

  • font_color (Optional[CaptionFontColor]) – (experimental) The color of the burned-in captions. Default: CaptionFontColor.WHITE

  • font_opacity (Union[int, float, None]) – (experimental) The opacity of the burned-in captions (0 transparent .. 255 opaque). Default: 255

  • font_resolution (Union[int, float, None]) – (experimental) The font resolution in DPI. Default: 96

  • font_size (Optional[CaptionFontSize]) – (experimental) Font size — CaptionFontSize.AUTO to scale with the output, or CaptionFontSize.of(points) for an exact size in points. Default: CaptionFontSize.AUTO

  • outline_color (Optional[CaptionOutlineColor]) – (experimental) The font outline color. Default: CaptionOutlineColor.BLACK

  • outline_size (Union[int, float, None]) – (experimental) The font outline size in pixels. Default: 2

  • shadow_color (Optional[CaptionShadowColor]) – (experimental) The color of the shadow cast by the captions. Default: CaptionShadowColor.NONE

  • shadow_opacity (Union[int, float, None]) – (experimental) The opacity of the shadow (0 transparent .. 255 opaque). Default: 0

  • shadow_x_offset (Union[int, float, None]) – (experimental) The horizontal offset of the shadow in pixels (negative shifts left). Default: - service default

  • shadow_y_offset (Union[int, float, None]) – (experimental) The vertical offset of the shadow in pixels (negative shifts up). Default: - service default

  • subtitle_rows (Optional[str]) – (experimental) For Teletext input, the number of lines for the captions bitmap. Default: - service default

  • teletext_grid_control (Optional[CaptionTeletextGridControl]) – (experimental) Whether a fixed grid is used to generate the subtitle bitmap (Teletext input). Default: CaptionTeletextGridControl.FIXED

  • x_position (Union[int, float, None]) – (experimental) The horizontal position of the captions in pixels from the left. Default: - determined by alignment

  • y_position (Union[int, float, None]) – (experimental) The vertical position of the captions in pixels from the top. Default: - positioned towards the bottom

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

alignment

(experimental) Caption alignment.

With explicit x/y positions, the font is justified relative to them.

Default:

CaptionAlignment.CENTERED

Stability:

experimental

background_color

(experimental) The color of the rectangle behind the captions.

Default:

  • service default

Stability:

experimental

background_opacity

(experimental) The opacity of the background rectangle (0 transparent .. 255 opaque).

Default:

  • service default

Stability:

experimental

font

(experimental) An external font file (.ttf or .tte) used for burn-in. Provide a FileLocation referencing an S3 bucket (FileLocation.fromBucket, which auto-grants read access) or a URL (FileLocation.url).

Default:

  • service default font

Stability:

experimental

font_color

(experimental) The color of the burned-in captions.

Default:

CaptionFontColor.WHITE

Stability:

experimental

font_opacity

(experimental) The opacity of the burned-in captions (0 transparent .. 255 opaque).

Default:

255

Stability:

experimental

font_resolution

(experimental) The font resolution in DPI.

Default:

96

Stability:

experimental

font_size

(experimental) Font size — CaptionFontSize.AUTO to scale with the output, or CaptionFontSize.of(points) for an exact size in points.

Default:

CaptionFontSize.AUTO

Stability:

experimental

outline_color

(experimental) The font outline color.

Default:

CaptionOutlineColor.BLACK

Stability:

experimental

outline_size

(experimental) The font outline size in pixels.

Default:

2

Stability:

experimental

shadow_color

(experimental) The color of the shadow cast by the captions.

Default:

CaptionShadowColor.NONE

Stability:

experimental

shadow_opacity

(experimental) The opacity of the shadow (0 transparent .. 255 opaque).

Default:

0

Stability:

experimental

shadow_x_offset

(experimental) The horizontal offset of the shadow in pixels (negative shifts left).

Default:

  • service default

Stability:

experimental

shadow_y_offset

(experimental) The vertical offset of the shadow in pixels (negative shifts up).

Default:

  • service default

Stability:

experimental

subtitle_rows

(experimental) For Teletext input, the number of lines for the captions bitmap.

Default:

  • service default

Stability:

experimental

teletext_grid_control

(experimental) Whether a fixed grid is used to generate the subtitle bitmap (Teletext input).

Default:

CaptionTeletextGridControl.FIXED

Stability:

experimental

x_position

(experimental) The horizontal position of the captions in pixels from the left.

Default:

  • determined by alignment

Stability:

experimental

y_position

(experimental) The vertical position of the captions in pixels from the top.

Default:

  • positioned towards the bottom

Stability:

experimental