Creates a text overlay or image overlay for a video stream.
<overlay
template = "string"
position = "X<int>Y<int>"
size = "X<int>Y<int>"
delay = "seconds"
layer = "positive int"
borderwidth = "positive int"
bordercolor = "string"
timeout = "seconds"
bgcolor = "string"
/>
Attribute |
Data Type |
Required? |
Default |
Description |
bgcolor |
string or integer |
no |
transparent |
Background color of the overlay area. Values are: red, blue, green, yellow, magenta, cyan, white, black, transparent or an unsigned integer. If a color enumeration is used, the color will be opaque. If an integer is specified, use the format 0xRRGGBBTT, where RR is a 2-digit hexadecimal value for the red component, GG is for the green component, BB is for the blue component, and TT is the value for the transparency component. Transparent can be used as a color or specified in the TT of the bitmask. |
bordercolor |
string or integer |
no |
black |
Border color of the overlay area. Values are: red, blue, green, yellow, magenta, cyan, white, black, transparent or an unsigned integer. If a color enumeration is used, the color will be opaque. If an integer is specified, use the format 0xRRGGBBTT, where RR is a 2-digit hexadecimal value for the red component, GG is for the green component, BB is for the blue component, and TT is the value for the transparency component. Transparent can be used as a color or specified in the TT of the bitmask. |
borderwidth |
positive integer |
no |
0 |
Border width of the overlay area given in pixels. |
delay |
integer |
no |
0 |
Delays the start of the overlay until a specified number of seconds has passed from the start of the video stream. |
layer |
positive integer |
no |
0 |
The order in which overlays are displayed when multiple overlays are specified. An overlay with a higher number (such as 5) is displayed on top of an overlay with a lower number (such as 4). When using multiple overlays, be careful that the overlays do not overlap and render the text unreadable. By default, the same layer value is used for all overlays. |
position |
integer |
yes |
[none] |
The X coordinate and Y coordinate of the upper left-hand corner of the overlay area, given as a percentage of the background video frame. |
size |
integer |
yes |
[none] |
The height (X coordinate) and width (Y coordinate) of the overlay area, given as a percentage of the background video frame. |
template |
string |
no |
[none] | URI (in http:// or file:/// format) to an XML file that defines a text overlay or image overlay. |
timeout |
positive integer |
no |
0 |
Stops displaying the overlay after a specified number of seconds has passed from the start of the video stream. A value of 0 means that no timeout will occur. |