Experimental
@aws-cdk/aws-medialive-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
CaptionFontStyleProps Struct
Font and positioning settings for a rendered caption output (burn-in or DVB-Sub).
Example
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 captionFontStyleProps: medialive_alpha.CaptionFontStyleProps = {
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,
};
Properties
alignmentoptionalCaptionAlignmentalignmentoptionalCaptionAlignmentalignmentoptionalCaptionAlignmentAlignmentoptionalCaptionAlignmentAlignmentoptionalCaptionAlignment= CaptionAlignment.CENTERED#Caption alignment.
With explicit x/y positions, the font is justified relative to them.
backgroundColoroptionalCaptionBackgroundColorbackground_coloroptionalCaptionBackgroundColorbackgroundColoroptionalCaptionBackgroundColorBackgroundColoroptionalCaptionBackgroundColorBackgroundColoroptionalCaptionBackgroundColor#The color of the rectangle behind the captions.
Default: service default
backgroundOpacityoptionalnumberbackground_opacityoptionalint | floatbackgroundOpacityoptionalNumberBackgroundOpacityoptionaldoubleBackgroundOpacityoptional*float64#The opacity of the background rectangle (0 transparent .. 255 opaque).
Default: service default
fontoptionalFileLocationfontoptionalFileLocationfontoptionalFileLocationFontoptionalFileLocationFontoptionalFileLocation#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
fontColoroptionalCaptionFontColorfont_coloroptionalCaptionFontColorfontColoroptionalCaptionFontColorFontColoroptionalCaptionFontColorFontColoroptionalCaptionFontColor= CaptionFontColor.WHITE#The color of the burned-in captions.
fontOpacityoptionalnumberfont_opacityoptionalint | floatfontOpacityoptionalNumberFontOpacityoptionaldoubleFontOpacityoptional*float64= 255#The opacity of the burned-in captions (0 transparent .. 255 opaque).
fontResolutionoptionalnumberfont_resolutionoptionalint | floatfontResolutionoptionalNumberFontResolutionoptionaldoubleFontResolutionoptional*float64= 96#The font resolution in DPI.
fontSizeoptionalCaptionFontSizefont_sizeoptionalCaptionFontSizefontSizeoptionalCaptionFontSizeFontSizeoptionalCaptionFontSizeFontSizeoptionalCaptionFontSize= CaptionFontSize.AUTO#Font size — `CaptionFontSize.AUTO` to scale with the output, or `CaptionFontSize.of(points)` for an exact size in points.
outlineColoroptionalCaptionOutlineColoroutline_coloroptionalCaptionOutlineColoroutlineColoroptionalCaptionOutlineColorOutlineColoroptionalCaptionOutlineColorOutlineColoroptionalCaptionOutlineColor= CaptionOutlineColor.BLACK#The font outline color.
outlineSizeoptionalnumberoutline_sizeoptionalint | floatoutlineSizeoptionalNumberOutlineSizeoptionaldoubleOutlineSizeoptional*float64= 2#The font outline size in pixels.
shadowColoroptionalCaptionShadowColorshadow_coloroptionalCaptionShadowColorshadowColoroptionalCaptionShadowColorShadowColoroptionalCaptionShadowColorShadowColoroptionalCaptionShadowColor= CaptionShadowColor.NONE#The color of the shadow cast by the captions.
shadowOpacityoptionalnumbershadow_opacityoptionalint | floatshadowOpacityoptionalNumberShadowOpacityoptionaldoubleShadowOpacityoptional*float64= 0#The opacity of the shadow (0 transparent .. 255 opaque).
shadowXOffsetoptionalnumbershadow_x_offsetoptionalint | floatshadowXOffsetoptionalNumberShadowXOffsetoptionaldoubleShadowXOffsetoptional*float64#The horizontal offset of the shadow in pixels (negative shifts left).
Default: service default
shadowYOffsetoptionalnumbershadow_y_offsetoptionalint | floatshadowYOffsetoptionalNumberShadowYOffsetoptionaldoubleShadowYOffsetoptional*float64#The vertical offset of the shadow in pixels (negative shifts up).
Default: service default
subtitleRowsoptionalstringsubtitle_rowsoptionalstrsubtitleRowsoptionalStringSubtitleRowsoptionalstringSubtitleRowsoptional*string#For Teletext input, the number of lines for the captions bitmap.
Default: service default
teletextGridControloptionalCaptionTeletextGridControlteletext_grid_controloptionalCaptionTeletextGridControlteletextGridControloptionalCaptionTeletextGridControlTeletextGridControloptionalCaptionTeletextGridControlTeletextGridControloptionalCaptionTeletextGridControl= CaptionTeletextGridControl.FIXED#Whether a fixed grid is used to generate the subtitle bitmap (Teletext input).
xPositionoptionalnumberx_positionoptionalint | floatxPositionoptionalNumberXPositionoptionaldoubleXPositionoptional*float64#The horizontal position of the captions in pixels from the left.
Default: determined by alignment
yPositionoptionalnumbery_positionoptionalint | floatyPositionoptionalNumberYPositionoptionaldoubleYPositionoptional*float64#The vertical position of the captions in pixels from the top.
Default: positioned towards the bottom