overlay

The overlay command shows or hides the identification overlay on DN-200 Series devices. Overlay appearance (color, size, position) is configured with the config command.

Command Type	DisplayNet
Minimum Version	3.x.x

Usage

overlay start <target> [<text>]
overlay stop <target>

Arguments

Argument	Required	Description
target	Yes	Device(s) to show or hide the overlay on. See Targets.
text	No	The text to display (start only). See Overlay text.

Targets

Value	Applies to
<device>	A single device, by hostname or MAC address
<device>,<device>,...	Each listed device
ALL_TX	All transmitter devices with overlay support
ALL_RX	All receiver devices with overlay support

When targeting a group, devices without overlay support are skipped automatically.

Overlay text

If omitted, the device's configured overlay text is used. The text may be a literal string or one of the following macros, which expand per device:

Macro	Displays
DEVICE_NAME	The device's name
DEVICE_MAC	The device's MAC address
DEVICE_ADDRESS	The device's IP address
DEVICE_STATUS	The device's status

Examples

Show the configured overlay on a device
overlay start dvdplayer

Show each transmitter's name on its stream
overlay start ALL_TX DEVICE_NAME

Hide the overlay again
overlay stop dvdplayer

Return value

overlay start dvdplayer
{
  "status": "SUCCESS",
  "request_id": null,
  "result": null,
  "error": null
}

Errors

Error	Cause
Invalid Parameters	No target was given
Invalid Device: <name>	A listed device did not match any device

Notifications

Turning overlays on generates a NOTIFICATION with a SETTINGS_CHANGED event on the affected devices. See Notifications.

REST API

Endpoint type	DisplayNet API command
Address	POST /api/displaynet/<operation>, or name the operation in the body of a POST /api/displaynet. See Sending commands.
Role	User

Subcommand	Operation	Parameters
start	overlay_start	device [options]*
stop	overlay_stop	device

A parameter in brackets is optional. A parameter marked * takes the remainder of the command line as one string. Pass the text exactly as you would type it on the TCI interface.

See also

• config: set overlay text, color, size, and position