video

set video manages the display mode and video output parameters of one or more receiver devices.

Usually unnecessary

DisplayNet Manager and the connect command usually make set video unnecessary, because connect accepts the same video arguments when routing.

Command Type	SDVoE
Minimum Version	2.1.x

Usage

set <target> video <display_mode> [size <width> <height>] [fps <rate>] [vic <code>] [quantization_range <range>]

Arguments

Argument	Required	Description
target	Yes	Hostname or MAC address of the receiver device(s).
display_mode	Yes	The display mode to set. See Display modes.
size, fps, vic, quantization_range	No	Video format parameters, valid in the scaled modes. See Video parameters.

Display modes

Mode	Keyword	Behavior
Genlock	genlock	Synchronized, zero-frame-latency, full screen 1:1
Genlock Scaling	genlock_scaling	Zero-frame-latency full screen with scaling
Fast Switch	fastswitch	Fast switched full screen; aspect ratio preserved with black bars as needed
Fast Switch (crop)	fastswitch crop	Fast switched; image cropped to preserve the aspect ratio
Fast Switch (stretch)	fastswitch stretch	Fast switched; image stretched to fill the screen regardless of aspect ratio
Genlock Wall	wall	Genlocked (synchronized) video wall mode
Fast Switch Wall	wall_fs	Fast switched video wall mode
Multiview	multiview	Managed by the DisplayNet mtv command, which adds functionality on top of this mode

Video parameters

Valid for HDMI signals in genlock_scaling, wall, wall_fs, and fastswitch modes:

Parameter	Value	Description
size	<width> <height>	Output resolution in pixels, e.g. size 1920 1080
fps	<rate>	Output frame rate, e.g. fps 60
vic	<code>	Video Identification Code of the desired format. See Video Identification Codes
quantization_range	See below	Output color quantization range. Defaults to STANDARD

Quantization value	Description
STANDARD	Appropriate quantization range for the video format, as defined by the CEA-861-F standard
AUTO	Same as STANDARD, but explicitly states FULL or LIMITED in the AVI InfoFrame. Works around some monitor issues
LIMITED	Force limited quantization range
FULL	Force full quantization range

Identifying a video format

A minimum set of arguments is required to uniquely identify a video format:

By VIC

If the desired format has a supported Video Identification Code, the VIC alone is sufficient, and timings and other parameters are retrieved automatically. Where a VIC maps to two frame rates, the ambiguity resolves as: 24Hz/23.98Hz → 24Hz; 30Hz/29.97Hz → 29.97Hz; 60Hz/59.94Hz → 59.94Hz.

By VIC and frame rate

As above, with the frame-rate ambiguity resolved explicitly via fps.

By resolution and frame rate

size plus fps is sufficient for formats with a supported VIC.

Examples

Set a receiver to genlock
set 001ec0f04d9c video genlock

Set a video format by VIC code
set 001ec0f04d9c video fastswitch vic 16

Set a video format by resolution and frame rate
set d88039631d77 video fastswitch stretch size 3840 2160 fps 60

Return value

set 001ec0f04d9c video fastswitch size 1920 1080 fps 60
{
  "status": "PROCESSING",
  "request_id": 57,
  "result": null,
  "error": null
}

Notifications

set 001ec0f04d9c video genlock
{
  "status": "NOTIFICATION",
  "request_id": null,
  "result": {
    "events": [
      {
        "device_id": "001ec0f04d9c",
        "event_id": 178,
        "event_type": "SETTINGS_CHANGED",
        "timestamp": 1460660784,
        "request_id": 178
      }
    ]
  },
  "error": null
}

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	/api/device/{target}
Role	Governed by the device lock rather than by a DisplayNet role

POST /api/device/{target}

{
  "op": "set:video",
  "display_mode": "String",
  "video": "VideoFormatArgument (conditional)"
}

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

See also

• connect: accepts the same video parameters while routing
• mtv: manages the multiview display mode
• wall: manages the wall display modes