class Aws::MediaConvert::Types::BurninDestinationSettings
Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.
@note When making an API call, you may pass BurninDestinationSettings
data as a hash: { alignment: "CENTERED", # accepts CENTERED, LEFT background_color: "NONE", # accepts NONE, BLACK, WHITE background_opacity: 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, 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, teletext_spacing: "FIXED_GRID", # accepts FIXED_GRID, PROPORTIONAL 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] 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_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 burn-in 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] 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] 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] 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/BurninDestinationSettings AWS API Documentation
Constants
- SENSITIVE