class Aws::MediaLive::Types::BurnInDestinationSettings

Burn In Destination Settings

@note When making an API call, you may pass BurnInDestinationSettings

data as a hash:

    {
      alignment: "CENTERED", # accepts CENTERED, LEFT, SMART
      background_color: "BLACK", # accepts BLACK, NONE, WHITE
      background_opacity: 1,
      font: {
        password_param: "__string",
        uri: "__string", # required
        username: "__string",
      },
      font_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
      font_opacity: 1,
      font_resolution: 1,
      font_size: "__string",
      outline_color: "BLACK", # accepts BLACK, BLUE, GREEN, RED, WHITE, YELLOW
      outline_size: 1,
      shadow_color: "BLACK", # accepts BLACK, NONE, WHITE
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      teletext_grid_control: "FIXED", # accepts FIXED, SCALED
      x_position: 1,
      y_position: 1,
    }

@!attribute [rw] 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. All burn-in and DVB-Sub font
settings must match.
@return [String]

@!attribute [rw] background_color

Specifies the color of the rectangle behind the captions. All
burn-in and DVB-Sub font settings must match.
@return [String]

@!attribute [rw] background_opacity

Specifies the opacity of the background rectangle. 255 is opaque; 0
is transparent. Leaving this parameter out is equivalent to setting
it to 0 (transparent). All burn-in and DVB-Sub font settings must
match.
@return [Integer]

@!attribute [rw] 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.
@return [Types::InputLocation]

@!attribute [rw] font_color

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.
@return [String]

@!attribute [rw] font_opacity

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is
transparent. All burn-in and DVB-Sub font settings must match.
@return [Integer]

@!attribute [rw] font_resolution

Font resolution in DPI (dots per inch); default is 96 dpi. All
burn-in and DVB-Sub font settings must match.
@return [Integer]

@!attribute [rw] font_size

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.
@return [String]

@!attribute [rw] outline_color

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.
@return [String]

@!attribute [rw] outline_size

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.
@return [Integer]

@!attribute [rw] shadow_color

Specifies the color of the shadow cast by the captions. All burn-in
and DVB-Sub font settings must match.
@return [String]

@!attribute [rw] shadow_opacity

Specifies the opacity of the shadow. 255 is opaque; 0 is
transparent. Leaving this parameter out is equivalent to setting it
to 0 (transparent). All burn-in and DVB-Sub font settings must
match.
@return [Integer]

@!attribute [rw] shadow_x_offset

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.
@return [Integer]

@!attribute [rw] shadow_y_offset

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.
@return [Integer]

@!attribute [rw] teletext_grid_control

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.
@return [String]

@!attribute [rw] x_position

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. All burn-in and DVB-Sub
font settings must match.
@return [Integer]

@!attribute [rw] y_position

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. All burn-in and DVB-Sub font settings must
match.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/BurnInDestinationSettings AWS API Documentation

Constants

SENSITIVE