> **Experimental**
>
> `@aws-cdk/aws-medialive-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# BurnInDestinationProps

Properties for burn-in captions.

Extends: BurnInDestinationProps
Extends: CaptionFontStyleProps

- Stability: [Experimental](/cdk/api/stability.html)
- Source: [`lib/caption-settings.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0-alpha.0/packages/@aws-cdk/aws-medialive-alpha/lib/caption-settings.ts#L361)

## 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

- `alignment`: [CaptionAlignment](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionAlignment.html) = CaptionAlignment.CENTERED — Caption alignment.

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

- `backgroundColor`: [CaptionBackgroundColor](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionBackgroundColor.html) — The color of the rectangle behind the captions.

  **Default:** service default

- `backgroundOpacity`: number — The opacity of the background rectangle (0 transparent .. 255 opaque).

  **Default:** service default

- `font`: [FileLocation](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.FileLocation.html) — 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

- `fontColor`: [CaptionFontColor](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionFontColor.html) = CaptionFontColor.WHITE — The color of the burned-in captions.

- `fontOpacity`: number = 255 — The opacity of the burned-in captions (0 transparent .. 255 opaque).

- `fontResolution`: number = 96 — The font resolution in DPI.

- `fontSize`: [CaptionFontSize](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionFontSize.html) = CaptionFontSize.AUTO — Font size — `CaptionFontSize.AUTO` to scale with the output, or `CaptionFontSize.of(points)` for an exact size in points.

- `outlineColor`: [CaptionOutlineColor](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionOutlineColor.html) = CaptionOutlineColor.BLACK — The font outline color.

- `outlineSize`: number = 2 — The font outline size in pixels.

- `shadowColor`: [CaptionShadowColor](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionShadowColor.html) = CaptionShadowColor.NONE — The color of the shadow cast by the captions.

- `shadowOpacity`: number = 0 — The opacity of the shadow (0 transparent .. 255 opaque).

- `shadowXOffset`: number — The horizontal offset of the shadow in pixels (negative shifts left).

  **Default:** service default

- `shadowYOffset`: number — The vertical offset of the shadow in pixels (negative shifts up).

  **Default:** service default

- `subtitleRows`: string — For Teletext input, the number of lines for the captions bitmap.

  **Default:** service default

- `teletextGridControl`: [CaptionTeletextGridControl](/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionTeletextGridControl.html) = CaptionTeletextGridControl.FIXED — Whether a fixed grid is used to generate the subtitle bitmap (Teletext input).

- `xPosition`: number — The horizontal position of the captions in pixels from the left.

  **Default:** determined by `alignment`

- `yPosition`: number — The vertical position of the captions in pixels from the top.

  **Default:** positioned towards the bottom