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.

Placeholder documentation for DvbSubDestinationSettings

Inheritance Hierarchy

System.Object
  Amazon.MediaLive.Model.DvbSubDestinationSettings

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

Syntax

C#
public class DvbSubDestinationSettings

The DvbSubDestinationSettings type exposes the following members

Constructors

NameDescription
Public Method DvbSubDestinationSettings()

Properties

NameTypeDescription
Public Property Alignment Amazon.MediaLive.DvbSubDestinationAlignment

Gets and sets the property 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. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.

Public Property BackgroundColor Amazon.MediaLive.DvbSubDestinationBackgroundColor

Gets and sets the property BackgroundColor. Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

Public Property BackgroundOpacity System.Int32

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

Public Property Font Amazon.MediaLive.Model.InputLocation

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

Public Property FontColor Amazon.MediaLive.DvbSubDestinationFontColor

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

Public Property FontOpacity System.Int32

Gets and sets the property FontOpacity. Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

Public Property FontResolution System.Int32

Gets and sets the property FontResolution. Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

Public Property FontSize System.String

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

Public Property OutlineColor Amazon.MediaLive.DvbSubDestinationOutlineColor

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

Public Property OutlineSize System.Int32

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

Public Property ShadowColor Amazon.MediaLive.DvbSubDestinationShadowColor

Gets and sets the property ShadowColor. Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

Public Property ShadowOpacity System.Int32

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

Public Property ShadowXOffset System.Int32

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

Public Property ShadowYOffset System.Int32

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

Public Property TeletextGridControl Amazon.MediaLive.DvbSubDestinationTeletextGridControl

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

Public Property XPosition System.Int32

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

Public Property YPosition System.Int32

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms