LDWS Video Endpoints

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

Retrieves information about the specified video output.

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

Response Body

• resolutions resolutions[ ]: An array of information about the graphics, output, video resolution. Returns result values for height and width.

• edid_identity: Parses the above string in a JSON format for readability. Requires an HDMI output connected to the player and a display.

• edid string: Returns the EDID read string of the display connected to the player. If power save is on, zeroes will be returned

• status:

  • audioBitsPerSample int: The number of bits per audio sample

  • audioChannelCount int: The number of audio channels in the output

  • audioFormat string: The format of the audio output. A "PCM" value indicates that the player is sending decoded output.

  • audioSampleRate int: The audio sample rate (in hertz)

  • eotf string: The current electro-optical transfer function (EOTF) used by the display. The following are possible values:

    • "HDR (GAMMA)"

    • "SDR (GAMMA)"

    • "SMPTE 2084 (PQ)"

    • "Future (BBC/NHK)"

    • "unspecified"

  • outputPowered bool: A flag indicating whether the display device is on (i.e. RX powered) 

  • outputPresent bool: A flag indicating whether the HDMI output is connected to a display device or not.

  • unstable bool: A flag indicating whether the display signal is unstable or stable

• modes: List of all available video modes on the player.

• activeMode: Information about the active video mode on the player

• bestMode string: The best video mode for the player. The HDMI connector must be attached because it gets details from EDID result.

• configuredMode: The configured video mode on the player. This can be different than activeMode.

• powerSaveStatus bool: This value indicates the power save status of the display connected to the player.

Response Example

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

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

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

Response Example

result is the EDID string result

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

Retrieves the power status of 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

Response Body

• is_connected bool: A flag indicating whether the monitor is connected to the HDMI output on the player

• is_powered bool: A flag indicating whether the monitor is on (for example, RX powered) 

• enabled bool: A flag indicating whether power-save mode has been enabled on the HDMI/VGA output

Response Example

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

This is an example request body that enables the power-save mode:

Response Example

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

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

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

Response Body

Returns an array of video mode objects, each of which contain the following parameters:

• modeName string: The mode (for example, “1920x1080x60p”)

• colorDepth string: The color depth of the video signal

• colorSpace string: The color space of the video signal (“rgb”, "yuv420", or "yuv422")

• dropFrame bool: Whether or not the video timecode uses drop frame

• frequency int: The frame rate of the video output

• width int: The width of the video output

• height int: The height of the video output

• graphicsPlaneWidth int: The width of the graphics plane

• graphicsPlaneHeight int: The height of the graphics plane

• interlaced bool:  Whether or not the video output is interlaced

• overscan bool: Whether or not the video output is using an overscan setting or not

• preferred bool: Whether or not video is the preferred mode

Response Example

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

Retrieves the current video mode on the specified video output. 

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.

Query String Parameters

Each of these parameters delivers a different mode value:

• best int optional: If set to 1, this returns the best mode

• active int optional: If set to 1, this returns the active mode

• configured int optional: If set to 1, this returns the configured mode

Request Example

The example request parameters and headers are set as follows:

• :connector is set to hdmi

• :device is set to 0

• best is set to 1

Response Body

• isAutoMode bool: Whether the mode is set to “auto”

• name string: The name of the video mode. Same as mode.modeName below.

• width string: The width value of the video mode.

• height string: The height value of the video mode.

• frames string: The frame rate value of the video mode.

• scan string: The scan character value of the video mode.

• mode object: The currently configured video mode on the video output with following parameters -

  • modeName string: The mode (for example, “1920x1080x60p”)

  • colorDepth string: The color depth of the video signal

  • colorSpace string: The color space of the video signal ("rgb", "yuv420", or "yuv422")

  • dropFrame bool: Whether or not the video timecode uses drop frame

  • frequency int: The frame rate of the video output

  • width int: The width of the video output

  • height int: The height of the video output

  • graphicsPlaneWidth int: The width of the graphics plane

  • graphicsPlaneHeight int: The height of the graphics plane

  • interlaced bool:  Whether or not the video output is interlaced

  • overscan bool: Whether or not the video output is using an overscan setting or not

  • preferred bool: Whether or not video is the preferred mode

Response Example

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 modeName parameter is required.

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 Body

A video mode object containing the following value(s):

• modeName string required: The mode (for example, “1920x1080x60p”). See Supported Video Modes for a list of the possible valid strings for your player

• colorDepth string optional: The color depth of the video signal

• colorSpace string optional: The color space of the video signal (“rgb”, "yuv420", or "yuv422")

• dropFrame bool optional: Whether or not the video timecode uses drop frame

• frequency int optional: The frame rate of the video output

• width int optional: The width of the video output

• height int optional: The height of the video output

• graphicsPlaneWidth int optional: The width of the graphics plane

• graphicsPlaneHeight int optional: The height of the graphics plane

• interlaced bool optional:  Whether or not the video output is interlaced

• overscan bool optional: Whether or not the video output is using an overscan setting or not

• preferred bool optional: Whether or not video is the preferred mode

Request Example

This is the example request body:

Response Body

The server will return a success or error message. A successful response will almost always cause a reboot which will be indicated in the response.

• successbool: Whether or not the operation was successful

• rebootbool: Whether or not the player is rebooting

Response Example