Struct aws_sdk_mediaconvert::types::BurninDestinationSettings

#[non_exhaustive]
pub struct BurninDestinationSettings {

    pub alignment: Option<BurninSubtitleAlignment>,
    pub apply_font_color: Option<BurninSubtitleApplyFontColor>,
    pub background_color: Option<BurninSubtitleBackgroundColor>,
    pub background_opacity: Option<i32>,
    pub fallback_font: Option<BurninSubtitleFallbackFont>,
    pub font_color: Option<BurninSubtitleFontColor>,
    pub font_file_bold: Option<String>,
    pub font_file_bold_italic: Option<String>,
    pub font_file_italic: Option<String>,
    pub font_file_regular: Option<String>,
    pub font_opacity: Option<i32>,
    pub font_resolution: Option<i32>,
    pub font_script: Option<FontScript>,
    pub font_size: Option<i32>,
    pub hex_font_color: Option<String>,
    pub outline_color: Option<BurninSubtitleOutlineColor>,
    pub outline_size: Option<i32>,
    pub shadow_color: Option<BurninSubtitleShadowColor>,
    pub shadow_opacity: Option<i32>,
    pub shadow_x_offset: Option<i32>,
    pub shadow_y_offset: Option<i32>,
    pub style_passthrough: Option<BurnInSubtitleStylePassthrough>,
    pub teletext_spacing: Option<BurninSubtitleTeletextSpacing>,
    pub x_position: Option<i32>,
    pub y_position: Option<i32>,
}

Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

alignment: Option<BurninSubtitleAlignment>

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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.

apply_font_color: Option<BurninSubtitleApplyFontColor>

Ignore this setting unless Style passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

background_color: Option<BurninSubtitleBackgroundColor>

Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present.

background_opacity: Option<i32>

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.

fallback_font: Option<BurninSubtitleFallbackFont>

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn’t support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

font_color: Option<BurninSubtitleFontColor>

Specify the color of the burned-in captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present.

font_file_bold: Option<String>

Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file.

font_file_bold_italic: Option<String>

Specify a bold italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and an italic font file.

font_file_italic: Option<String>

Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file.

font_file_regular: Option<String>

Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file.

font_opacity: Option<i32>

Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.

font_resolution: Option<i32>

Specify the Font resolution in DPI (dots per inch).

font_script: Option<FontScript>

Set Font script to Automatically determined, or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

font_size: Option<i32>

Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

hex_font_color: Option<String>

Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.

outline_color: Option<BurninSubtitleOutlineColor>

Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present.

outline_size: Option<i32>

Specify the Outline size of the caption text, in pixels. Leave Outline size blank and set Style passthrough to enabled to use the outline size data from your input captions, if present.

shadow_color: Option<BurninSubtitleShadowColor>

Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present.

shadow_opacity: Option<i32>

Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to Enabled, leave Shadow opacity blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.

shadow_x_offset: Option<i32>

Specify 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.

shadow_y_offset: Option<i32>

Specify 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. Leave Shadow y-offset blank and set Style passthrough to enabled to use the shadow y-offset data from your input captions, if present.

style_passthrough: Option<BurnInSubtitleStylePassthrough>

To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.

teletext_spacing: Option<BurninSubtitleTeletextSpacing>

Specify whether the text spacing 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 for closed captions.

x_position: Option<i32>

Specify the horizontal position of the captions, 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.

y_position: Option<i32>

Specify the vertical position of the captions, 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.

Implementations

impl BurninDestinationSettings

pub fn alignment(&self) -> Option<&BurninSubtitleAlignment>

Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign 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.

pub fn apply_font_color(&self) -> Option<&BurninSubtitleApplyFontColor>

Ignore this setting unless Style passthrough is set to Enabled and Font color set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color for additional font color controls. When you choose White text only, or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.

pub fn background_color(&self) -> Option<&BurninSubtitleBackgroundColor>

Specify the color of the rectangle behind the captions. Leave background color blank and set Style passthrough to enabled to use the background color data from your input captions, if present.

pub fn background_opacity(&self) -> Option<i32>

Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.

pub fn fallback_font(&self) -> Option<&BurninSubtitleFallbackFont>

Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn’t support. When you set Fallback font to best match, or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.

pub fn font_color(&self) -> Option<&BurninSubtitleFontColor>

Specify the color of the burned-in captions text. Leave Font color blank and set Style passthrough to enabled to use the font color data from your input captions, if present.

pub fn font_file_bold(&self) -> Option<&str>

Specify a bold TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, an italic, and a bold italic font file.

pub fn font_file_bold_italic(&self) -> Option<&str>

Specify a bold italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and an italic font file.

pub fn font_file_italic(&self) -> Option<&str>

Specify an italic TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a regular, a bold, and a bold italic font file.

pub fn font_file_regular(&self) -> Option<&str>

Specify a regular TrueType font file to use when rendering your output captions. Enter an S3, HTTP, or HTTPS URL. When you do, you must also separately specify a bold, an italic, and a bold italic font file.

pub fn font_opacity(&self) -> Option<i32>

Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.

pub fn font_resolution(&self) -> Option<i32>

Specify the Font resolution in DPI (dots per inch).

pub fn font_script(&self) -> Option<&FontScript>

Set Font script to Automatically determined, or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.

pub fn font_size(&self) -> Option<i32>

Specify the Font size in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.

pub fn hex_font_color(&self) -> Option<&str>

Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.

pub fn outline_color(&self) -> Option<&BurninSubtitleOutlineColor>

Specify font outline color. Leave Outline color blank and set Style passthrough to enabled to use the font outline color data from your input captions, if present.

pub fn outline_size(&self) -> Option<i32>

Specify the Outline size of the caption text, in pixels. Leave Outline size blank and set Style passthrough to enabled to use the outline size data from your input captions, if present.

pub fn shadow_color(&self) -> Option<&BurninSubtitleShadowColor>

Specify the color of the shadow cast by the captions. Leave Shadow color blank and set Style passthrough to enabled to use the shadow color data from your input captions, if present.

pub fn shadow_opacity(&self) -> Option<i32>

Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough is set to Enabled, leave Shadow opacity blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.

pub fn shadow_x_offset(&self) -> Option<i32>

Specify 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.

pub fn shadow_y_offset(&self) -> Option<i32>

Specify 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. Leave Shadow y-offset blank and set Style passthrough to enabled to use the shadow y-offset data from your input captions, if present.

pub fn style_passthrough(&self) -> Option<&BurnInSubtitleStylePassthrough>

To use the available style, color, and position information from your input captions: Set Style passthrough to Enabled. Note that MediaConvert uses default settings for any missing style or position information in your input captions To ignore the style and position information from your input captions and use default settings: Leave blank or keep the default value, Disabled. Default settings include white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings. You can also override any fonts by manually specifying custom font files.

pub fn teletext_spacing(&self) -> Option<&BurninSubtitleTeletextSpacing>

Specify whether the text spacing 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 for closed captions.

pub fn x_position(&self) -> Option<i32>

Specify the horizontal position of the captions, 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.

pub fn y_position(&self) -> Option<i32>

Specify the vertical position of the captions, 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.

impl BurninDestinationSettings

pub fn builder() -> BurninDestinationSettingsBuilder

Creates a new builder-style object to manufacture BurninDestinationSettings.

Trait Implementations

impl Clone for BurninDestinationSettings

fn clone(&self) -> BurninDestinationSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BurninDestinationSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BurninDestinationSettings

fn eq(&self, other: &BurninDestinationSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BurninDestinationSettings