Class CfnChannel.DvbSubDestinationSettingsProperty
The settings for DVB Sub captions in the output.
Inheritance
Namespace: Amazon.CDK.AWS.MediaLive
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DvbSubDestinationSettingsProperty : Object, CfnChannel.IDvbSubDestinationSettingsProperty
Syntax (vb)
Public Class DvbSubDestinationSettingsProperty
Inherits Object
Implements CfnChannel.IDvbSubDestinationSettingsProperty
Remarks
The parent of this entity is CaptionDestinationSettings.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaLive;
var dvbSubDestinationSettingsProperty = new DvbSubDestinationSettingsProperty {
Alignment = "alignment",
BackgroundColor = "backgroundColor",
BackgroundOpacity = 123,
Font = new InputLocationProperty {
PasswordParam = "passwordParam",
Uri = "uri",
Username = "username"
},
FontColor = "fontColor",
FontOpacity = 123,
FontResolution = 123,
FontSize = "fontSize",
OutlineColor = "outlineColor",
OutlineSize = 123,
ShadowColor = "shadowColor",
ShadowOpacity = 123,
ShadowXOffset = 123,
ShadowYOffset = 123,
TeletextGridControl = "teletextGridControl",
XPosition = 123,
YPosition = 123
};
Synopsis
Constructors
DvbSubDestinationSettingsProperty() |
Properties
Alignment | If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output. |
BackgroundColor | Specifies the color of the rectangle behind the captions. |
BackgroundOpacity | Specifies the opacity of the background rectangle. |
Font | The external font file that is used for captions burn-in. |
FontColor | Specifies the color of the burned-in captions. |
FontOpacity | Specifies the opacity of the burned-in captions. |
FontResolution | The font resolution in DPI (dots per inch). |
FontSize | When set to auto, fontSize scales depending on the size of the output. |
OutlineColor | Specifies the font outline color. |
OutlineSize | Specifies the font outline size in pixels. |
ShadowColor | Specifies the color of the shadow that is cast by the captions. |
ShadowOpacity | Specifies the opacity of the shadow. |
ShadowXOffset | Specifies the horizontal offset of the shadow relative to the captions in pixels. |
ShadowYOffset | Specifies the vertical offset of the shadow relative to the captions in pixels. |
TeletextGridControl | Controls whether a fixed grid size is used to generate the output subtitles bitmap. |
XPosition | Specifies the horizontal position of the captions relative to the left side of the output in pixels. |
YPosition | Specifies the vertical position of the captions relative to the top of the output in pixels. |
Constructors
DvbSubDestinationSettingsProperty()
public DvbSubDestinationSettingsProperty()
Properties
Alignment
If no explicit xPosition or yPosition is provided, setting the alignment to centered places the captions at the bottom center of the output.
public string Alignment { get; set; }
Property Value
System.String
Remarks
Similarly, setting a left alignment aligns captions to the bottom left of the output. If x and y positions are specified in conjunction with the alignment parameter, the font is justified (either left or centered) relative to those coordinates. Selecting "smart" justification left-justifies live subtitles and center-justifies 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 captions stream. All burn-in and DVB-Sub font settings must match.
BackgroundColor
Specifies the color of the rectangle behind the captions.
public string BackgroundColor { get; set; }
Property Value
System.String
Remarks
All burn-in and DVB-Sub font settings must match.
BackgroundOpacity
Specifies the opacity of the background rectangle.
public Nullable<double> BackgroundOpacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
Font
The external font file that is used for captions burn-in.
public object Font { get; set; }
Property Value
System.Object
Remarks
The file extension must be .ttf or .tte. Although you 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 captions sources could cause an unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
FontColor
Specifies the color of the burned-in captions.
public string FontColor { get; set; }
Property Value
System.String
Remarks
This option is not valid for source captions that are STL, 608/embedded, or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
FontOpacity
Specifies the opacity of the burned-in captions.
public Nullable<double> FontOpacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
FontResolution
The font resolution in DPI (dots per inch).
public Nullable<double> FontResolution { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default is 96 dpi. All burn-in and DVB-Sub font settings must match.
FontSize
When set to auto, fontSize scales depending on the size of the output.
public string FontSize { get; set; }
Property Value
System.String
Remarks
Providing a positive integer specifies the exact font size in points. All burn-in and DVB-Sub font settings must match.
OutlineColor
Specifies the font outline color.
public string OutlineColor { get; set; }
Property Value
System.String
Remarks
This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
OutlineSize
Specifies the font outline size in pixels.
public Nullable<double> OutlineSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This option is not valid for source captions that are either 608/embedded or Teletext. These source settings are already pre-defined by the captions stream. All burn-in and DVB-Sub font settings must match.
ShadowColor
Specifies the color of the shadow that is cast by the captions.
public string ShadowColor { get; set; }
Property Value
System.String
Remarks
All burn-in and DVB-Sub font settings must match.
ShadowOpacity
Specifies the opacity of the shadow.
public Nullable<double> ShadowOpacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
255 is opaque; 0 is transparent. Keeping this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
ShadowXOffset
Specifies the horizontal offset of the shadow relative to the captions in pixels.
public Nullable<double> ShadowXOffset { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
ShadowYOffset
Specifies the vertical offset of the shadow relative to the captions in pixels.
public Nullable<double> ShadowYOffset { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
TeletextGridControl
Controls whether a fixed grid size is used to generate the output subtitles bitmap.
public string TeletextGridControl { get; set; }
Property Value
System.String
Remarks
This applies to only Teletext inputs and DVB-Sub/Burn-in outputs.
XPosition
Specifies the horizontal position of the captions relative to the left side of the output in pixels.
public Nullable<double> XPosition { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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 captions position is 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 captions stream. All burn-in and DVB-Sub font settings must match.
YPosition
Specifies the vertical position of the captions relative to the top of the output in pixels.
public Nullable<double> YPosition { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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 captions are 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 captions stream. All burn-in and DVB-Sub font settings must match.