Class ChannelEncoderSettingsCaptionDescriptionDestinationSettingsDvbSubDestinationSettings


  • public final class ChannelEncoderSettingsCaptionDescriptionDestinationSettingsDvbSubDestinationSettings
    extends java.lang.Object
    • Method Detail

      • alignment

        public java.util.Optional<java.lang.String> alignment()
        Returns:
        Justification of the caption text. When no explicit `xPosition` or `yPosition` is provided, `centered` places the captions at the bottom center of the output and `left` aligns captions to the bottom left. If `xPosition` and `yPosition` are given with the alignment parameter, the font is justified (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 caption stream.
      • backgroundColor

        public java.util.Optional<java.lang.String> backgroundColor()
        Returns:
        Color of the rectangle behind the captions.
      • backgroundOpacity

        public java.util.Optional<java.lang.Integer> backgroundOpacity()
        Returns:
        Opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent).
      • font

        public java.util.Optional<ChannelEncoderSettingsCaptionDescriptionDestinationSettingsDvbSubDestinationSettingsFont> font()
        Returns:
        External font file used for caption burn-in. 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 caption sources could cause unexpected display of proportional fonts. See `font` Block for details.
      • fontColor

        public java.util.Optional<java.lang.String> fontColor()
        Returns:
        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 caption stream.
      • fontOpacity

        public java.util.Optional<java.lang.Integer> fontOpacity()
        Returns:
        Opacity of the burned-in captions. 255 is opaque; 0 is transparent.
      • fontResolution

        public java.util.Optional<java.lang.Integer> fontResolution()
        Returns:
        Font resolution in DPI (dots per inch). Default is 96 dpi.
      • fontSize

        public java.util.Optional<java.lang.String> fontSize()
        Returns:
        When set to `auto`, font size scales depending on the size of the output. A positive integer sets the exact font size in points.
      • outlineColor

        public java.util.Optional<java.lang.String> outlineColor()
        Returns:
        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 caption stream.
      • outlineSize

        public java.util.Optional<java.lang.Integer> outlineSize()
        Returns:
        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 caption stream.
      • shadowColor

        public java.util.Optional<java.lang.String> shadowColor()
        Returns:
        Color of the shadow cast by the captions.
      • shadowOpacity

        public java.util.Optional<java.lang.Integer> shadowOpacity()
        Returns:
        Opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent).
      • shadowXOffset

        public java.util.Optional<java.lang.Integer> shadowXOffset()
        Returns:
        Horizontal offset, in pixels, of the shadow relative to the captions. A value of -2 results in a shadow offset 2 pixels to the left.
      • shadowYOffset

        public java.util.Optional<java.lang.Integer> shadowYOffset()
        Returns:
        Vertical offset, in pixels, of the shadow relative to the captions. A value of -2 results in a shadow offset 2 pixels above the text.
      • teletextGridControl

        public java.util.Optional<java.lang.String> teletextGridControl()
        Returns:
        Whether a fixed grid size is used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
      • xPosition

        public java.util.Optional<java.lang.Integer> xPosition()
        Returns:
        Horizontal position, in pixels, of the caption relative to the left side of the output. A value of 10 results in the captions starting 10 pixels from the left of the output. If no explicit `xPosition` is provided, the horizontal caption 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 caption stream.
      • yPosition

        public java.util.Optional<java.lang.Integer> yPosition()
        Returns:
        Vertical position, in pixels, of the caption relative to the top of the output. A value of 10 results in the captions starting 10 pixels from the top of the output. If no explicit `yPosition` is provided, the caption is 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 caption stream.