AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.MediaConvert.Model.BurninDestinationSettings

Namespace: Amazon.MediaConvert.Model
Assembly: AWSSDK.MediaConvert.dll
Version: 3.x.y.z

Syntax

C#
public class BurninDestinationSettings

The BurninDestinationSettings type exposes the following members

Constructors

NameDescription
Public Method BurninDestinationSettings()

Properties

NameTypeDescription
Public Property Alignment Amazon.MediaConvert.BurninSubtitleAlignment

Gets and sets the property Alignment. 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.

Public Property ApplyFontColor Amazon.MediaConvert.BurninSubtitleApplyFontColor

Gets and sets the property ApplyFontColor. 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.

Public Property BackgroundColor Amazon.MediaConvert.BurninSubtitleBackgroundColor

Gets and sets the property BackgroundColor. 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.

Public Property BackgroundOpacity System.Int32

Gets and sets the property BackgroundOpacity. 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.

Public Property FallbackFont Amazon.MediaConvert.BurninSubtitleFallbackFont

Gets and sets the property FallbackFont. 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.

Public Property FontColor Amazon.MediaConvert.BurninSubtitleFontColor

Gets and sets the property FontColor. 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.

Public Property FontFileBold System.String

Gets and sets the property FontFileBold. 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.

Public Property FontFileBoldItalic System.String

Gets and sets the property FontFileBoldItalic. 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.

Public Property FontFileItalic System.String

Gets and sets the property FontFileItalic. 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.

Public Property FontFileRegular System.String

Gets and sets the property FontFileRegular. 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.

Public Property FontOpacity System.Int32

Gets and sets the property FontOpacity. Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.

Public Property FontResolution System.Int32

Gets and sets the property FontResolution. Specify the Font resolution in DPI (dots per inch).

Public Property FontScript Amazon.MediaConvert.FontScript

Gets and sets the property 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.

Public Property FontSize System.Int32

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

Public Property HexFontColor System.String

Gets and sets the property HexFontColor. 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.

Public Property OutlineColor Amazon.MediaConvert.BurninSubtitleOutlineColor

Gets and sets the property OutlineColor. 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.

Public Property OutlineSize System.Int32

Gets and sets the property OutlineSize. 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.

Public Property ShadowColor Amazon.MediaConvert.BurninSubtitleShadowColor

Gets and sets the property ShadowColor. 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.

Public Property ShadowOpacity System.Int32

Gets and sets the property ShadowOpacity. 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.

Public Property ShadowXOffset System.Int32

Gets and sets the property ShadowXOffset. 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.

Public Property ShadowYOffset System.Int32

Gets and sets the property ShadowYOffset. 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.

Public Property StylePassthrough Amazon.MediaConvert.BurnInSubtitleStylePassthrough

Gets and sets the property StylePassthrough. 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.

Public Property TeletextSpacing Amazon.MediaConvert.BurninSubtitleTeletextSpacing

Gets and sets the property TeletextSpacing. 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.

Public Property XPosition System.Int32

Gets and sets the property XPosition. 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.

Public Property YPosition System.Int32

Gets and sets the property YPosition. 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5