/AWS1/CL_MDLBURNINDSTSETTINGS

Burn In Destination Settings

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_alignment TYPE /AWS1/MDLBURNINALIGNMENT /AWS1/MDLBURNINALIGNMENT

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. All burn-in and DVB-Sub font settings must match.

iv_backgroundcolor TYPE /AWS1/MDLBURNINBACKGROUNDCOLOR /AWS1/MDLBURNINBACKGROUNDCOLOR

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

iv_backgroundopacity TYPE /AWS1/MDL__INTEGERMIN0MAX255 /AWS1/MDL__INTEGERMIN0MAX255

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

io_font TYPE REF TO /AWS1/CL_MDLINPUTLOCATION /AWS1/CL_MDLINPUTLOCATION

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.

iv_fontcolor TYPE /AWS1/MDLBURNINFONTCOLOR /AWS1/MDLBURNINFONTCOLOR

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.

iv_fontopacity TYPE /AWS1/MDL__INTEGERMIN0MAX255 /AWS1/MDL__INTEGERMIN0MAX255

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

iv_fontresolution TYPE /AWS1/MDL__INTEGERMIN96MAX600 /AWS1/MDL__INTEGERMIN96MAX600

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

iv_fontsize TYPE /AWS1/MDL__STRING /AWS1/MDL__STRING

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.

iv_outlinecolor TYPE /AWS1/MDLBURNINOUTLINECOLOR /AWS1/MDLBURNINOUTLINECOLOR

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.

iv_outlinesize TYPE /AWS1/MDL__INTEGERMIN0MAX10 /AWS1/MDL__INTEGERMIN0MAX10

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.

iv_shadowcolor TYPE /AWS1/MDLBURNINSHADOWCOLOR /AWS1/MDLBURNINSHADOWCOLOR

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

iv_shadowopacity TYPE /AWS1/MDL__INTEGERMIN0MAX255 /AWS1/MDL__INTEGERMIN0MAX255

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

iv_shadowxoffset TYPE /AWS1/MDL__INTEGER /AWS1/MDL__INTEGER

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.

iv_shadowyoffset TYPE /AWS1/MDL__INTEGER /AWS1/MDL__INTEGER

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.

iv_teletextgridcontrol TYPE /AWS1/MDLBURNINTELETEXTGRIDCTL /AWS1/MDLBURNINTELETEXTGRIDCTL

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.

iv_xposition TYPE /AWS1/MDL__INTEGERMIN0 /AWS1/MDL__INTEGERMIN0

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. All burn-in and DVB-Sub font settings must match.

iv_yposition TYPE /AWS1/MDL__INTEGERMIN0 /AWS1/MDL__INTEGERMIN0

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. All burn-in and DVB-Sub font settings must match.

iv_subtitlerows TYPE /AWS1/MDLBURNINDSTSUBTITLEROWS /AWS1/MDLBURNINDSTSUBTITLEROWS

Applies only when the input captions are Teletext and the output captions are DVB-Sub or Burn-In. Choose the number of lines for the captions bitmap. The captions bitmap is 700 wide × 576 high and will be laid over the video. For example, a value of 16 divides the bitmap into 16 lines, with each line 36 pixels high (16 × 36 = 576). The default is 24 (24 pixels high). Enter the same number in every encode in every output that converts the same Teletext source to DVB-Sub or Burn-in.

---

Queryable Attributes

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. All burn-in and DVB-Sub font settings must match.

Accessible with the following methods

Method	Description
GET_ALIGNMENT()	Getter for ALIGNMENT, with configurable default
ASK_ALIGNMENT()	Getter for ALIGNMENT w/ exceptions if field has no value
HAS_ALIGNMENT()	Determine if ALIGNMENT has a value

BackgroundColor

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

Accessible with the following methods

Method	Description
GET_BACKGROUNDCOLOR()	Getter for BACKGROUNDCOLOR, with configurable default
ASK_BACKGROUNDCOLOR()	Getter for BACKGROUNDCOLOR w/ exceptions if field has no val
HAS_BACKGROUNDCOLOR()	Determine if BACKGROUNDCOLOR has a value

BackgroundOpacity

Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Accessible with the following methods

Method	Description
GET_BACKGROUNDOPACITY()	Getter for BACKGROUNDOPACITY, with configurable default
ASK_BACKGROUNDOPACITY()	Getter for BACKGROUNDOPACITY w/ exceptions if field has no v
HAS_BACKGROUNDOPACITY()	Determine if BACKGROUNDOPACITY has a value

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.

Accessible with the following methods

Method	Description
GET_FONT()	Getter for FONT

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.

Accessible with the following methods

Method	Description
GET_FONTCOLOR()	Getter for FONTCOLOR, with configurable default
ASK_FONTCOLOR()	Getter for FONTCOLOR w/ exceptions if field has no value
HAS_FONTCOLOR()	Determine if FONTCOLOR has a value

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.

Accessible with the following methods

Method	Description
GET_FONTOPACITY()	Getter for FONTOPACITY, with configurable default
ASK_FONTOPACITY()	Getter for FONTOPACITY w/ exceptions if field has no value
HAS_FONTOPACITY()	Determine if FONTOPACITY has a value

FontResolution

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

Accessible with the following methods

Method	Description
GET_FONTRESOLUTION()	Getter for FONTRESOLUTION, with configurable default
ASK_FONTRESOLUTION()	Getter for FONTRESOLUTION w/ exceptions if field has no valu
HAS_FONTRESOLUTION()	Determine if FONTRESOLUTION has a value

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.

Accessible with the following methods

Method	Description
GET_FONTSIZE()	Getter for FONTSIZE, with configurable default
ASK_FONTSIZE()	Getter for FONTSIZE w/ exceptions if field has no value
HAS_FONTSIZE()	Determine if FONTSIZE has a value

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.

Accessible with the following methods

Method	Description
GET_OUTLINECOLOR()	Getter for OUTLINECOLOR, with configurable default
ASK_OUTLINECOLOR()	Getter for OUTLINECOLOR w/ exceptions if field has no value
HAS_OUTLINECOLOR()	Determine if OUTLINECOLOR has a value

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.

Accessible with the following methods

Method	Description
GET_OUTLINESIZE()	Getter for OUTLINESIZE, with configurable default
ASK_OUTLINESIZE()	Getter for OUTLINESIZE w/ exceptions if field has no value
HAS_OUTLINESIZE()	Determine if OUTLINESIZE has a value

ShadowColor

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

Accessible with the following methods

Method	Description
GET_SHADOWCOLOR()	Getter for SHADOWCOLOR, with configurable default
ASK_SHADOWCOLOR()	Getter for SHADOWCOLOR w/ exceptions if field has no value
HAS_SHADOWCOLOR()	Determine if SHADOWCOLOR has a value

ShadowOpacity

Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.

Accessible with the following methods

Method	Description
GET_SHADOWOPACITY()	Getter for SHADOWOPACITY, with configurable default
ASK_SHADOWOPACITY()	Getter for SHADOWOPACITY w/ exceptions if field has no value
HAS_SHADOWOPACITY()	Determine if SHADOWOPACITY has a value

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.

Accessible with the following methods

Method	Description
GET_SHADOWXOFFSET()	Getter for SHADOWXOFFSET, with configurable default
ASK_SHADOWXOFFSET()	Getter for SHADOWXOFFSET w/ exceptions if field has no value
HAS_SHADOWXOFFSET()	Determine if SHADOWXOFFSET has a value

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.

Accessible with the following methods

Method	Description
GET_SHADOWYOFFSET()	Getter for SHADOWYOFFSET, with configurable default
ASK_SHADOWYOFFSET()	Getter for SHADOWYOFFSET w/ exceptions if field has no value
HAS_SHADOWYOFFSET()	Determine if SHADOWYOFFSET has a value

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.

Accessible with the following methods

Method	Description
GET_TELETEXTGRIDCONTROL()	Getter for TELETEXTGRIDCONTROL, with configurable default
ASK_TELETEXTGRIDCONTROL()	Getter for TELETEXTGRIDCONTROL w/ exceptions if field has no
HAS_TELETEXTGRIDCONTROL()	Determine if TELETEXTGRIDCONTROL has a value

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. All burn-in and DVB-Sub font settings must match.

Accessible with the following methods

Method	Description
GET_XPOSITION()	Getter for XPOSITION, with configurable default
ASK_XPOSITION()	Getter for XPOSITION w/ exceptions if field has no value
HAS_XPOSITION()	Determine if XPOSITION has a value

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. All burn-in and DVB-Sub font settings must match.

Accessible with the following methods

Method	Description
GET_YPOSITION()	Getter for YPOSITION, with configurable default
ASK_YPOSITION()	Getter for YPOSITION w/ exceptions if field has no value
HAS_YPOSITION()	Determine if YPOSITION has a value

SubtitleRows

Applies only when the input captions are Teletext and the output captions are DVB-Sub or Burn-In. Choose the number of lines for the captions bitmap. The captions bitmap is 700 wide × 576 high and will be laid over the video. For example, a value of 16 divides the bitmap into 16 lines, with each line 36 pixels high (16 × 36 = 576). The default is 24 (24 pixels high). Enter the same number in every encode in every output that converts the same Teletext source to DVB-Sub or Burn-in.

Accessible with the following methods

Method	Description
GET_SUBTITLEROWS()	Getter for SUBTITLEROWS, with configurable default
ASK_SUBTITLEROWS()	Getter for SUBTITLEROWS w/ exceptions if field has no value
HAS_SUBTITLEROWS()	Determine if SUBTITLEROWS has a value