Package software.amazon.awscdk.services.medialive.alpha

Interface CaptionFontStyleProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
BurnInDestinationProps, DvbSubDestinationProps
All Known Implementing Classes:
BurnInDestinationProps.Jsii$Proxy, CaptionFontStyleProps.Jsii$Proxy, DvbSubDestinationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:40.952Z") @Stability(Experimental) public interface CaptionFontStyleProps extends software.amazon.jsii.JsiiSerializable
(experimental) Font and positioning settings for a rendered caption output (burn-in or DVB-Sub).

Example: 

 // 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;
 CaptionFontStyleProps captionFontStyleProps = CaptionFontStyleProps.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();

  • Method Details

    • getAlignment

      @Stability(Experimental) @Nullable default CaptionAlignment getAlignment()
      (experimental) Caption alignment.

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

      Default: CaptionAlignment.CENTERED

    • getBackgroundColor

      @Stability(Experimental) @Nullable default CaptionBackgroundColor getBackgroundColor()
      (experimental) The color of the rectangle behind the captions.

      Default: - service default

    • getBackgroundOpacity

      @Stability(Experimental) @Nullable default Number getBackgroundOpacity()
      (experimental) The opacity of the background rectangle (0 transparent .. 255 opaque).

      Default: - service default

    • getFont

      @Stability(Experimental) @Nullable default FileLocation getFont()
      (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

    • getFontColor

      @Stability(Experimental) @Nullable default CaptionFontColor getFontColor()
      (experimental) The color of the burned-in captions.

      Default: CaptionFontColor.WHITE

    • getFontOpacity

      @Stability(Experimental) @Nullable default Number getFontOpacity()
      (experimental) The opacity of the burned-in captions (0 transparent .. 255 opaque).

      Default: 255

    • getFontResolution

      @Stability(Experimental) @Nullable default Number getFontResolution()
      (experimental) The font resolution in DPI.

      Default: 96

    • getFontSize

      @Stability(Experimental) @Nullable default CaptionFontSize getFontSize()
      (experimental) Font size — CaptionFontSize.AUTO to scale with the output, or CaptionFontSize.of(points) for an exact size in points.

      Default: CaptionFontSize.AUTO

    • getOutlineColor

      @Stability(Experimental) @Nullable default CaptionOutlineColor getOutlineColor()
      (experimental) The font outline color.

      Default: CaptionOutlineColor.BLACK

    • getOutlineSize

      @Stability(Experimental) @Nullable default Number getOutlineSize()
      (experimental) The font outline size in pixels.

      Default: 2

    • getShadowColor

      @Stability(Experimental) @Nullable default CaptionShadowColor getShadowColor()
      (experimental) The color of the shadow cast by the captions.

      Default: CaptionShadowColor.NONE

    • getShadowOpacity

      @Stability(Experimental) @Nullable default Number getShadowOpacity()
      (experimental) The opacity of the shadow (0 transparent .. 255 opaque).

      Default: 0

    • getShadowXOffset

      @Stability(Experimental) @Nullable default Number getShadowXOffset()
      (experimental) The horizontal offset of the shadow in pixels (negative shifts left).

      Default: - service default

    • getShadowYOffset

      @Stability(Experimental) @Nullable default Number getShadowYOffset()
      (experimental) The vertical offset of the shadow in pixels (negative shifts up).

      Default: - service default

    • getSubtitleRows

      @Stability(Experimental) @Nullable default String getSubtitleRows()
      (experimental) For Teletext input, the number of lines for the captions bitmap.

      Default: - service default

    • getTeletextGridControl

      @Stability(Experimental) @Nullable default CaptionTeletextGridControl getTeletextGridControl()
      (experimental) Whether a fixed grid is used to generate the subtitle bitmap (Teletext input).

      Default: CaptionTeletextGridControl.FIXED

    • getXPosition

      @Stability(Experimental) @Nullable default Number getXPosition()
      (experimental) The horizontal position of the captions in pixels from the left.

      Default: - determined by `alignment`

    • getYPosition

      @Stability(Experimental) @Nullable default Number getYPosition()
      (experimental) The vertical position of the captions in pixels from the top.

      Default: - positioned towards the bottom

    • builder

      @Stability(Experimental) static CaptionFontStyleProps.Builder builder()
      Returns:
      a CaptionFontStyleProps.Builder of CaptionFontStyleProps