2.57 configuration/video-outputs/{index}

GET

Get the video output with a specified ID.

Responses
200GET successful.
404Resource does not exist.
Response (application/json): object
MemberTypeDescription
connected
boolean

Indicates if a screen is currently connected to this output.

read-only

enabled
boolean

Indicates if this output is enabled.

Since version: 2.7

id
integerread-only
modelName
string

Model name of the screen connected to this output.

Since version: 2.9

read-only

position
integer

Determines the position for this output. This value switches the monitors in 'Extended video mode'. Only the CX-50 Gen2 devices support a value different than one. All other device types have a single display output. C-5/C-10/CX-20 and CX-30 Gen2 do support two outputs, but only one can be active at the same time.

Example: 1

Since version: 2.10

preferredResolution
string

The preferred resolution of the screen connected to this output.

Example: 1920x1080

read-only

resolution
string

The requested resolution for this output. If this parameter is set to 'Auto', the native resolution (see nativeHorizontalResolution and nativeVerticalResolution) of the display will be used. A manual resolution that is listed under SupportedResolutions can be set in the format [hor]x[ver].

Example: Auto

supportedResolutions
array

Supported resolutions for the screen currently connected to this output.

Example: ['Auto', '1280x720', '1920x1080']

read-only

vendorName
string

Vendor name of the screen connected to this output.

Since version: 2.9

read-only

PATCH

Change the output.

Request body (application/json): object
MemberTypeDescription
connected
boolean

Indicates if a screen is currently connected to this output.

read-only

enabled
boolean

Indicates if this output is enabled.

Since version: 2.7

id
integerread-only
modelName
string

Model name of the screen connected to this output.

Since version: 2.9

read-only

position
integer

Determines the position for this output. This value switches the monitors in 'Extended video mode'. Only the CX-50 Gen2 devices support a value different than one. All other device types have a single display output. C-5/C-10/CX-20 and CX-30 Gen2 do support two outputs, but only one can be active at the same time.

Example: 1

Since version: 2.10

preferredResolution
string

The preferred resolution of the screen connected to this output.

Example: 1920x1080

read-only

resolution
string

The requested resolution for this output. If this parameter is set to 'Auto', the native resolution (see nativeHorizontalResolution and nativeVerticalResolution) of the display will be used. A manual resolution that is listed under SupportedResolutions can be set in the format [hor]x[ver].

Example: Auto

supportedResolutions
array

Supported resolutions for the screen currently connected to this output.

Example: ['Auto', '1280x720', '1920x1080']

read-only

vendorName
string

Vendor name of the screen connected to this output.

Since version: 2.9

read-only

Responses
200PATCH successful.