class Aws::MediaConvert::Types::DvbSubDestinationSettings

Settings related to DVB-Sub captions. Set up DVB-Sub captions in the same output as your video. For more information, see docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to DVB_SUB.

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

data as a hash:

    {
      alignment: "CENTERED", # accepts CENTERED, LEFT
      background_color: "NONE", # accepts NONE, BLACK, WHITE
      background_opacity: 1,
      dds_handling: "NONE", # accepts NONE, SPECIFIED, NO_DISPLAY_WINDOW
      dds_x_coordinate: 1,
      dds_y_coordinate: 1,
      font_color: "WHITE", # accepts WHITE, BLACK, YELLOW, RED, GREEN, BLUE
      font_opacity: 1,
      font_resolution: 1,
      font_script: "AUTOMATIC", # accepts AUTOMATIC, HANS, HANT
      font_size: 1,
      height: 1,
      outline_color: "BLACK", # accepts BLACK, WHITE, YELLOW, RED, GREEN, BLUE
      outline_size: 1,
      shadow_color: "NONE", # accepts NONE, BLACK, WHITE
      shadow_opacity: 1,
      shadow_x_offset: 1,
      shadow_y_offset: 1,
      subtitling_type: "HEARING_IMPAIRED", # accepts HEARING_IMPAIRED, STANDARD
      teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL
      width: 1,
      x_position: 1,
      y_position: 1,
    }

@!attribute [rw] alignment

If no explicit x\_position or y\_position 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.
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] 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 blank is equivalent to
setting it to 0 (transparent). All burn-in and DVB-Sub font settings
must match.
@return [Integer]

@!attribute [rw] dds_handling

Specify how MediaConvert handles the display definition segment
(DDS). Keep the default, None (NONE), to exclude the DDS from this
set of captions. Choose No display window (NO\_DISPLAY\_WINDOW) to
have MediaConvert include the DDS but not include display window
data. In this case, MediaConvert writes that information to the page
composition segment (PCS) instead. Choose Specify (SPECIFIED) to
have MediaConvert set up the display window based on the values that
you specify in related job settings. For video resolutions that are
576 pixels or smaller in height, MediaConvert doesn't include the
DDS, regardless of the value you choose for DDS handling
(ddsHandling). In this case, it doesn't write the display window
data to the PCS either. Related settings: Use the settings DDS
x-coordinate (ddsXCoordinate) and DDS y-coordinate (ddsYCoordinate)
to specify the offset between the top left corner of the display
window and the top left corner of the video frame. All burn-in and
DVB-Sub font settings must match.
@return [String]

@!attribute [rw] dds_x_coordinate

Use this setting, along with DDS y-coordinate (ddsYCoordinate), to
specify the upper left corner of the display definition segment
(DDS) display window. With this setting, specify the distance, in
pixels, between the left side of the frame and the left side of the
DDS display window. Keep the default value, 0, to have MediaConvert
automatically choose this offset. Related setting: When you use this
setting, you must set DDS handling (ddsHandling) to a value other
than None (NONE). MediaConvert uses these values to determine
whether to write page position data to the DDS or to the page
composition segment (PCS). All burn-in and DVB-Sub font settings
must match.
@return [Integer]

@!attribute [rw] dds_y_coordinate

Use this setting, along with DDS x-coordinate (ddsXCoordinate), to
specify the upper left corner of the display definition segment
(DDS) display window. With this setting, specify the distance, in
pixels, between the top of the frame and the top of the DDS display
window. Keep the default value, 0, to have MediaConvert
automatically choose this offset. Related setting: When you use this
setting, you must set DDS handling (ddsHandling) to a value other
than None (NONE). MediaConvert uses these values to determine
whether to write page position data to the DDS or to the page
composition segment (PCS). All burn-in and DVB-Sub font settings
must match.
@return [Integer]

@!attribute [rw] font_color

Specifies the color of the DVB-SUB 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_script

Provide the font script, using an ISO 15924 script code, if the
LanguageCode is not sufficient for determining the script type.
Where LanguageCode or CustomLanguageCode is sufficient, use
"AUTOMATIC" or leave unset. This is used to help determine the
appropriate font for rendering DVB-Sub captions.
@return [String]

@!attribute [rw] font_size

A positive integer indicates the exact font size in points. Set to 0
for automatic font size selection. All burn-in and DVB-Sub font
settings must match.
@return [Integer]

@!attribute [rw] height

Specify the height, in pixels, of this set of DVB-Sub captions. The
default value is 576 pixels. Related setting: When you use this
setting, you must set DDS handling (ddsHandling) to a value other
than None (NONE). All burn-in and DVB-Sub font settings must match.
@return [Integer]

@!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 blank 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] subtitling_type

Specify whether your DVB subtitles are standard or for hearing
impaired. Choose hearing impaired if your subtitles include audio
descriptions and dialogue. Choose standard if your subtitles include
only dialogue.
@return [String]

@!attribute [rw] teletext_spacing

Only applies to jobs with input captions in Teletext or STL formats.
Specify whether the spacing between letters in your captions is set
by the captions grid or varies depending on letter width. Choose
fixed grid to conform to the spacing specified in the captions file
more accurately. Choose proportional to make the text easier to read
if the captions are closed caption.
@return [String]

@!attribute [rw] width

Specify the width, in pixels, of this set of DVB-Sub captions. The
default value is 720 pixels. Related setting: When you use this
setting, you must set DDS handling (ddsHandling) to a value other
than None (NONE). All burn-in and DVB-Sub font settings must match.
@return [Integer]

@!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 x\_position 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.
@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
y\_position 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.
@return [Integer]

@see docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/DvbSubDestinationSettings AWS API Documentation

Constants

SENSITIVE