Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note that :connector supports only HDMI® and that :device is the numeric index of the output, which is currently only 0.

GET /v1/video/:connector/output/:device/ 

Retrieves information about the specified video output.An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: 

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

Request Example

The example request parameters and headers are set as follows:

  • :connector is set to hdmi

  • :device is set to 0

http://192.168.4.43/api/v1/video/hdmi/output/0/

Endpoints:

Table of Contents
minLevel1
maxLevel2
outlinefalse
stylenone
typelist
printablefalse

GET /v1/video/:connector/output/:device/edid/ 

Returns the EDID information from a compatible monitor/television connected to the video output.

An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example:

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

Request Example

The example request parameters and headers are set as follows:

  • :connector is set to hdmi

  • :device is set to 0

 http://192.168.4.43/api/v1/video/hdmi/output/0/edid/

GET /v1/video/:connector/output/:device/power-save/ 

Retrieves the power status of the monitor connected to the player. 

An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: 

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

Request Example

The example request parameters and headers are set as follows:

  • :connector is set to hdmi

  • :device is set to 0

http://192.168.4.43/api/v1/video/hdmi/output/0/power-save/

PUT /v1/video/:connector/output/:device/power-save/ 

Enables or disables power-save mode on the monitor connected to the player.

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

Request Example

The example request parameters and headers are set as follows:

  • :connector is set to hdmi

  • :device is set to 0

http://192.168.4.43/api/v1/video/hdmi/output/0/power-save/

Request Body

  • enabled bool: Whether the power-save mode on the monitor is enabled or disabled 

GET /v1/video/:connector/output/:device/modes/ 

Returns a list of all available video modes on the specified video output.

An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: 

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

Request Example

The example request parameters and headers are set as follows:

  • :connector is set to hdmi

  • :device is set to 0

http://192.168.4.43/api/v1/video/hdmi/output/0/modes/

GET /v1/video/:connector/output/:device/mode/ 

Retrieves the current video mode on the specified video output. 

An example of :connector is “hdmi” (without the quotes), and an example of :device is “0”, for example: 

Segments

  • connector: The current value is always hdmi

  • device: This value is 0 for single-output Series 5 players and all Series 4 and older players. The value can be 0-3 for the XC4055, which has multiple outputs, and 0 or 1 for the XC2055 and XT2145.

http://192.168.4.43/api/v1/video/hdmi/output/0/mode/

Example

Code Block
GET /api/v1/video/hdmi/output/0/mode

PUT /v1/video/:connector/output/:device/mode/ 

Changes the video mode on the player. You should first send a GET request to find the body parameters of this API, but only the parameter below is required (all others are optional):

Request Body

Example

Code Block
PUT /api/v1/video/hdmi/output/0/mode/{"modeName": "1920x1080x50p"}

Endpoints:

Table of ContentsminLevel1maxLevel2outlinefalsestylenonetypelistprintablefalse