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

Properties for DVB-Sub captions.

Extends: [CaptionFontStyleProps](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionFontStyleProps.html)
Used as argument in: [CaptionDestination.dvbSub](https://docs.aws.amazon.com/cdk/api/v2/docs/@aws-cdk_aws-medialive-alpha.CaptionDestination.html#dvbsub)

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

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as medialive_alpha from '@aws-cdk/aws-medialive-alpha';

declare const captionAlignment: medialive_alpha.CaptionAlignment;
declare const captionBackgroundColor: medialive_alpha.CaptionBackgroundColor;
declare const captionFontColor: medialive_alpha.CaptionFontColor;
declare const captionFontSize: medialive_alpha.CaptionFontSize;
declare const captionOutlineColor: medialive_alpha.CaptionOutlineColor;
declare const captionShadowColor: medialive_alpha.CaptionShadowColor;
declare const captionTeletextGridControl: medialive_alpha.CaptionTeletextGridControl;
declare const fileLocation: medialive_alpha.FileLocation;
const dvbSubDestinationProps: medialive_alpha.DvbSubDestinationProps = {
  alignment: captionAlignment,
  backgroundColor: captionBackgroundColor,
  backgroundOpacity: 123,
  font: fileLocation,
  fontColor: captionFontColor,
  fontOpacity: 123,
  fontResolution: 123,
  fontSize: captionFontSize,
  outlineColor: captionOutlineColor,
  outlineSize: 123,
  shadowColor: captionShadowColor,
  shadowOpacity: 123,
  shadowXOffset: 123,
  shadowYOffset: 123,
  subtitleRows: 'subtitleRows',
  teletextGridControl: captionTeletextGridControl,
  xPosition: 123,
  yPosition: 123,
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_medialive_alpha as medialive_alpha

# caption_alignment: medialive_alpha.CaptionAlignment
# caption_background_color: medialive_alpha.CaptionBackgroundColor
# caption_font_color: medialive_alpha.CaptionFontColor
# caption_font_size: medialive_alpha.CaptionFontSize
# caption_outline_color: medialive_alpha.CaptionOutlineColor
# caption_shadow_color: medialive_alpha.CaptionShadowColor
# caption_teletext_grid_control: medialive_alpha.CaptionTeletextGridControl
# file_location: medialive_alpha.FileLocation

dvb_sub_destination_props = medialive_alpha.DvbSubDestinationProps(
    alignment=caption_alignment,
    background_color=caption_background_color,
    background_opacity=123,
    font=file_location,
    font_color=caption_font_color,
    font_opacity=123,
    font_resolution=123,
    font_size=caption_font_size,
    outline_color=caption_outline_color,
    outline_size=123,
    shadow_color=caption_shadow_color,
    shadow_opacity=123,
    shadow_x_offset=123,
    shadow_y_offset=123,
    subtitle_rows="subtitleRows",
    teletext_grid_control=caption_teletext_grid_control,
    x_position=123,
    y_position=123
)
```

Java:

```java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.medialive.alpha.*;

CaptionAlignment captionAlignment;
CaptionBackgroundColor captionBackgroundColor;
CaptionFontColor captionFontColor;
CaptionFontSize captionFontSize;
CaptionOutlineColor captionOutlineColor;
CaptionShadowColor captionShadowColor;
CaptionTeletextGridControl captionTeletextGridControl;
FileLocation fileLocation;

DvbSubDestinationProps dvbSubDestinationProps = DvbSubDestinationProps.builder()
        .alignment(captionAlignment)
        .backgroundColor(captionBackgroundColor)
        .backgroundOpacity(123)
        .font(fileLocation)
        .fontColor(captionFontColor)
        .fontOpacity(123)
        .fontResolution(123)
        .fontSize(captionFontSize)
        .outlineColor(captionOutlineColor)
        .outlineSize(123)
        .shadowColor(captionShadowColor)
        .shadowOpacity(123)
        .shadowXOffset(123)
        .shadowYOffset(123)
        .subtitleRows("subtitleRows")
        .teletextGridControl(captionTeletextGridControl)
        .xPosition(123)
        .yPosition(123)
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.AWS.MediaLive.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive.Alpha;

CaptionAlignment captionAlignment;
CaptionBackgroundColor captionBackgroundColor;
CaptionFontColor captionFontColor;
CaptionFontSize captionFontSize;
CaptionOutlineColor captionOutlineColor;
CaptionShadowColor captionShadowColor;
CaptionTeletextGridControl captionTeletextGridControl;
FileLocation fileLocation;

var dvbSubDestinationProps = new DvbSubDestinationProps {
    Alignment = captionAlignment,
    BackgroundColor = captionBackgroundColor,
    BackgroundOpacity = 123,
    Font = fileLocation,
    FontColor = captionFontColor,
    FontOpacity = 123,
    FontResolution = 123,
    FontSize = captionFontSize,
    OutlineColor = captionOutlineColor,
    OutlineSize = 123,
    ShadowColor = captionShadowColor,
    ShadowOpacity = 123,
    ShadowXOffset = 123,
    ShadowYOffset = 123,
    SubtitleRows = "subtitleRows",
    TeletextGridControl = captionTeletextGridControl,
    XPosition = 123,
    YPosition = 123
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awsmedialivealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import medialive_alpha "github.com/aws/aws-cdk-go/awsmedialivealpha"

var captionAlignment CaptionAlignment
var captionBackgroundColor CaptionBackgroundColor
var captionFontColor CaptionFontColor
var captionFontSize CaptionFontSize
var captionOutlineColor CaptionOutlineColor
var captionShadowColor CaptionShadowColor
var captionTeletextGridControl CaptionTeletextGridControl
var fileLocation FileLocation

dvbSubDestinationProps := &DvbSubDestinationProps{
	Alignment: captionAlignment,
	BackgroundColor: captionBackgroundColor,
	BackgroundOpacity: jsii.Number(123),
	Font: fileLocation,
	FontColor: captionFontColor,
	FontOpacity: jsii.Number(123),
	FontResolution: jsii.Number(123),
	FontSize: captionFontSize,
	OutlineColor: captionOutlineColor,
	OutlineSize: jsii.Number(123),
	ShadowColor: captionShadowColor,
	ShadowOpacity: jsii.Number(123),
	ShadowXOffset: jsii.Number(123),
	ShadowYOffset: jsii.Number(123),
	SubtitleRows: jsii.String("subtitleRows"),
	TeletextGridControl: captionTeletextGridControl,
	XPosition: jsii.Number(123),
	YPosition: jsii.Number(123),
}
```

## Properties

- `alignment`: [CaptionAlignment](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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](https://docs.aws.amazon.com/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
