Package software.amazon.awssdk.services.medialive.model

Interface DvbSubDestinationSettings.Builder

    • Method Detail

      • alignment

        DvbSubDestinationSettings.Builder alignment​(String alignment)
        If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        alignment - If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationAlignment, DvbSubDestinationAlignment

      • alignment

        DvbSubDestinationSettings.Builder alignment​(DvbSubDestinationAlignment alignment)
        If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        alignment - If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationAlignment, DvbSubDestinationAlignment

      • backgroundOpacity

        DvbSubDestinationSettings.Builder backgroundOpacity​(Integer backgroundOpacity)
        Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
        Parameters:
        backgroundOpacity - Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • font

        DvbSubDestinationSettings.Builder font​(InputLocation font)
        External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        font - External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fontColor

        DvbSubDestinationSettings.Builder fontColor​(String fontColor)
        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 caption stream. All burn-in and DVB-Sub font settings must match.
        Parameters:
        fontColor - 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 caption stream. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationFontColor, DvbSubDestinationFontColor

      • fontColor

        DvbSubDestinationSettings.Builder fontColor​(DvbSubDestinationFontColor fontColor)
        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 caption stream. All burn-in and DVB-Sub font settings must match.
        Parameters:
        fontColor - 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 caption stream. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationFontColor, DvbSubDestinationFontColor

      • fontOpacity

        DvbSubDestinationSettings.Builder fontOpacity​(Integer fontOpacity)
        Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
        Parameters:
        fontOpacity - Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fontResolution

        DvbSubDestinationSettings.Builder fontResolution​(Integer fontResolution)
        Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
        Parameters:
        fontResolution - Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fontSize

        DvbSubDestinationSettings.Builder fontSize​(String fontSize)
        When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
        Parameters:
        fontSize - When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outlineColor

        DvbSubDestinationSettings.Builder outlineColor​(String outlineColor)
        Specifies 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        outlineColor - Specifies 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationOutlineColor, DvbSubDestinationOutlineColor

      • outlineColor

        DvbSubDestinationSettings.Builder outlineColor​(DvbSubDestinationOutlineColor outlineColor)
        Specifies 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        outlineColor - Specifies 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationOutlineColor, DvbSubDestinationOutlineColor

      • outlineSize

        DvbSubDestinationSettings.Builder outlineSize​(Integer outlineSize)
        Specifies 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        outlineSize - Specifies 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shadowColor

        DvbSubDestinationSettings.Builder shadowColor​(String shadowColor)
        Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
        Parameters:
        shadowColor - Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationShadowColor, DvbSubDestinationShadowColor

      • shadowOpacity

        DvbSubDestinationSettings.Builder shadowOpacity​(Integer shadowOpacity)
        Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
        Parameters:
        shadowOpacity - Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shadowXOffset

        DvbSubDestinationSettings.Builder shadowXOffset​(Integer shadowXOffset)
        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.
        Parameters:
        shadowXOffset - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • shadowYOffset

        DvbSubDestinationSettings.Builder shadowYOffset​(Integer shadowYOffset)
        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.
        Parameters:
        shadowYOffset - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • teletextGridControl

        DvbSubDestinationSettings.Builder teletextGridControl​(String teletextGridControl)
        Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
        Parameters:
        teletextGridControl - Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DvbSubDestinationTeletextGridControl, DvbSubDestinationTeletextGridControl

      • xPosition

        DvbSubDestinationSettings.Builder xPosition​(Integer xPosition)
        Specifies the horizontal position of the caption relative to the left side of the output in pixels. 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 caption position will be 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        xPosition - Specifies the horizontal position of the caption relative to the left side of the output in pixels. 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 caption position will be 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • yPosition

        DvbSubDestinationSettings.Builder yPosition​(Integer yPosition)
        Specifies the vertical position of the caption relative to the top of the output in pixels. 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 caption will be 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. All burn-in and DVB-Sub font settings must match.
        Parameters:
        yPosition - Specifies the vertical position of the caption relative to the top of the output in pixels. 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 caption will be 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. All burn-in and DVB-Sub font settings must match.
        Returns:
        Returns a reference to this object so that method calls can be chained together.