Skip to main content
Documentation - Limelight Interface Architect
Video Text Overlay Component
Limelight Interface Architect - Video Text Overlay Component

Video Text Overlay Component

The video text overlay provides a method to overlay text onto a live video stream.  The text can be dynamic and is fully Unicode compliant.  It also supports multiple lines by adding "\n" in the character stream to force a new line.  Text can be horizontally aligned left, middle, right and vertically aligned top, center, bottom.  It can be any color and have an optional translucent background to aid in clarity depending on the video stream. To use this component, simply drag it onto a Video Display Component and it will embed itself under that control.

Video overlay controls only work with the base Video Display component

See the example video stream below with the default text overlay:

Example Video Display Component with Video Text Overlay Component Embedded

Properties

NAME TYPE R/W DESCRIPTION
Color Color R/W Text color
FontBold Boolean R/W Font bold attribute
FontCase Enumeration R/W Forces the text to be upper, lower or mixed case
FontFamily String R/W Name of the font to use for the text
FontItalic Boolean R/W Font italic attribute
FontSize Integer R/W Font size in points (e.g. 12 = 12 pt.)
LinkPropertyText String R/W The name of the server or local text property (See Component Linking for more details)
Margins Enumeration R/W Allows adjusting the margins for the text based on default position (all margins default to 3 pixels)
Name String R/W The component's unique name (must be unique within a page)
OverlayAlphaLevel Byte R/W The alpha or transparency of the text over the video (and layers that sit below it)
OverlayOpacity Byte R/W The transparency of the background to enhance readability
Text String R/W The displayed text
TextAlign Enumeration R/W Determines where the text box will be displayed (9 choices)
TextVisible Boolean R/W Turns on or off the text in the overlay
All properties are displayed with spaces for clarity in reading.  The actual property name has no spaces so when using them for linking they are concatenated.

 

Related Topics

About

Strasis Systems, LLC is a provider of software for command and control centers, data visualization, security and systems integration.