AWS CDK Reference

Appearance

v2.274.0

DvbSubDestinationSettingsProperty Struct ​

The settings for DVB Sub captions in the output.

The parent of this entity is CaptionDestinationSettings.

Source
Generated code
Type last changed
v2.217.0 · 25 Sep 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_medialive as medialive } from 'aws-cdk-lib';
const dvbSubDestinationSettingsProperty: medialive.CfnChannel.DvbSubDestinationSettingsProperty = {
  alignment: 'alignment',
  backgroundColor: 'backgroundColor',
  backgroundOpacity: 123,
  font: {
    passwordParam: 'passwordParam',
    uri: 'uri',
    username: 'username',
  },
  fontColor: 'fontColor',
  fontOpacity: 123,
  fontResolution: 123,
  fontSize: 'fontSize',
  outlineColor: 'outlineColor',
  outlineSize: 123,
  shadowColor: 'shadowColor',
  shadowOpacity: 123,
  shadowXOffset: 123,
  shadowYOffset: 123,
  subtitleRows: 'subtitleRows',
  teletextGridControl: 'teletextGridControl',
  xPosition: 123,
  yPosition: 123,
};

Properties ​

alignmentoptionalstringalignmentoptionalstralignmentoptionalStringAlignmentoptionalstringAlignmentoptional*string#
If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output.
notes

Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting "smart" justification left-justifies live subtitles and center-justifies pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

backgroundColoroptionalstringbackground_coloroptionalstrbackgroundColoroptionalStringBackgroundColoroptionalstringBackgroundColoroptional*string#
Specifies the color of the rectangle behind the captions.

All burn-in and DVB-Sub font settings must match.

backgroundOpacityoptionalnumberbackground_opacityoptionalint | floatbackgroundOpacityoptionalNumberBackgroundOpacityoptionaldoubleBackgroundOpacityoptional*float64#
Specifies the opacity of the background rectangle.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

fontoptionalIResolvable | CfnChannel.InputLocationPropertyfontoptionaltyping.Union[IResolvable, InputLocationProperty]fontoptionalIResolvableFontoptionalIResolvableFontoptionalinterface{}#
The external font file that is used for captions burn-in.
notes

The file extension must be .ttf or .tte. Although you can select output fonts for many different types of input captions, embedded, STL, and Teletext sources use a strict grid system. Using external fonts with these captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.

fontColoroptionalstringfont_coloroptionalstrfontColoroptionalStringFontColoroptionalstringFontColoroptional*string#
Specifies the color of the burned-in captions.

This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

fontOpacityoptionalnumberfont_opacityoptionalint | floatfontOpacityoptionalNumberFontOpacityoptionaldoubleFontOpacityoptional*float64#
Specifies the opacity of the burned-in captions.

255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

fontResolutionoptionalnumberfont_resolutionoptionalint | floatfontResolutionoptionalNumberFontResolutionoptionaldoubleFontResolutionoptional*float64#
The font resolution in DPI (dots per inch).

The default is 96 dpi. All burn-in and DVB-Sub font settings must match.

fontSizeoptionalstringfont_sizeoptionalstrfontSizeoptionalStringFontSizeoptionalstringFontSizeoptional*string#
When set to auto, fontSize scales depending on the size of the output.

Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.

outlineColoroptionalstringoutline_coloroptionalstroutlineColoroptionalStringOutlineColoroptionalstringOutlineColoroptional*string#
Specifies the font outline color.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

outlineSizeoptionalnumberoutline_sizeoptionalint | floatoutlineSizeoptionalNumberOutlineSizeoptionaldoubleOutlineSizeoptional*float64#
Specifies the font outline size in pixels.

This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

shadowColoroptionalstringshadow_coloroptionalstrshadowColoroptionalStringShadowColoroptionalstringShadowColoroptional*string#
Specifies the color of the shadow that is cast by the captions.

All burn-in and DVB-Sub font settings must match.

shadowOpacityoptionalnumbershadow_opacityoptionalint | floatshadowOpacityoptionalNumberShadowOpacityoptionaldoubleShadowOpacityoptional*float64#
Specifies the opacity of the shadow.

255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

shadowXOffsetoptionalnumbershadow_x_offsetoptionalint | floatshadowXOffsetoptionalNumberShadowXOffsetoptionaldoubleShadowXOffsetoptional*float64#
Specifies the horizontal offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.

shadowYOffsetoptionalnumbershadow_y_offsetoptionalint | floatshadowYOffsetoptionalNumberShadowYOffsetoptionaldoubleShadowYOffsetoptional*float64#
Specifies the vertical offset of the shadow relative to the captions in pixels.

A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.

subtitleRowsoptionalstringsubtitle_rowsoptionalstrsubtitleRowsoptionalStringSubtitleRowsoptionalstringSubtitleRowsoptional*string#
teletextGridControloptionalstringteletext_grid_controloptionalstrteletextGridControloptionalStringTeletextGridControloptionalstringTeletextGridControloptional*string#
Controls whether a fixed grid size is used to generate the output subtitles bitmap.

This applies to only Teletext inputs and DVB-Sub/Burn-in outputs.

xPositionoptionalnumberx_positionoptionalint | floatxPositionoptionalNumberXPositionoptionaldoubleXPositionoptional*float64#
Specifies the horizontal position of the captions relative to the left side of the output in pixels.
notes

A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal captions position is determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.

yPositionoptionalnumbery_positionoptionalint | floatyPositionoptionalNumberYPositionoptionaldoubleYPositionoptional*float64#
Specifies the vertical position of the captions relative to the top of the output in pixels.
notes

A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the captions are positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.