Overview

On-Screen Display (OSD) allows a Decoder to display text over the current video output. OSD messages can be used for room identification, notifications, troubleshooting, testing, and system automation.

This feature is supported on Omega Series, Ultra Series, and MaxColor Series Decoders.

Before You Begin

• Ensure you can access the Decoder using either Telnet or the HTTP API.
• OSD commands are executed on the Decoder connected to the display where the message should appear.
• For instructions on accessing a Decoder, see How to Access a Just Add Power Device.

Message Appearance

OSD messages can be displayed using either center or left alignment. Font size is specified by the command and does not automatically scale with the output resolution. As a result, the same font size appears progressively smaller on higher-resolution displays.

Text box on 720p video

Text box on 1080p video

Text box on 4K video

Displaying an OSD Message

OSD messages can be displayed using either the HTTP API or the command line, depending on the firmware version and integration method.

Command Line

Execute the following command on the Decoder to display an OSD message.

osd "$STRING" [-c RRGGBB] [-s SIZE] [-a left|center] [-t TIME]

Only the message text ($STRING) is required. All other options are optional and use their default values when omitted.

Option	Description	Default
"$STRING"	Text to display. Enclose the message in quotation marks.	Required
-c RRGGBB	Sets the text color using a six-digit hexadecimal RGB value.	00FF00 (Green)
-s SIZE	Sets the font size from 1 to 250.	30
-a left -a center	Sets the text alignment.	center
-t TIME	Displays the message for the specified number of seconds.	Remains displayed until removed.

Examples

Display a Message

osd "Doorbell"

Display White Text

osd "Doorbell" -c FFFFFF

Display a Larger, Left-Aligned Message

osd "Conference Room" -a left -s 50

Display a Message for 10 Seconds

osd "Presentation Starting" -t 10

HTTP API

Devices running B1.X.X or newer support OSD control through the HTTP API.

Endpoint

POST /command/osd

Example JSON Body

{
  "align": "left",
  "color": "98DD3F",
  "opacity": 100,
  "size": 30,
  "string": "Doorbell",
  "timeout": 10
}

Property	Description	Default
string	Text to display.	Required
color	Text color using a six-digit hexadecimal RGB value.	00FF00
size	Sets the font size from 1 to 250.	30
align	left or center.	center
timeout	Number of seconds to display the message before it is automatically removed.	0 (persistent)
opacity	Background opacity percentage.	100

Display a Message

POST /command/osd

{
  "string": "Doorbell"
}

Other OSD Functions

Additional OSD functions are available to identify Decoders, display diagnostic information, and remove OSD messages.

Command Line

Function	Command	Example	Description
Turn Off OSD	osd -x [seconds]	osd -x 10	If [seconds] is specified, wait that many seconds before turning off OSD. Example waits 10 seconds after the command is sent to turn off OSD.
Display Debug Information	osd -d	osd -d	Displays diagnostic information, including the current video resolution.
Identify All Decoders	osd -i [off]	osd -i osd -i off	Displays the hostname and IP address on every visible Decoder. off option turns off the text.

HTTP API

Devices running B1.X.X or newer also support OSD identification through the HTTP API.

Endpoint

POST /command/osd

Enable Identification

{
  "identify": "on"
}

Displays each visible Decoder's IP address and MAC address for easy identification.

Disable Identification

{
  "identify": "off"
}

Removes the identification display from every visible Decoder.