rDWS Video Endpoints

Owned by BrightSign TechDocs
Feb 07, 2024
7 min read

Base URL for these endpoints:  https://ws.bsn.cloud/rest/v1/

_________________________________________________________________________

 

GET /video-mode/ 

Retrieves the currently active video mode on the player

Request Example

GET /rest/v1/video-mode/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json

Response Body

  • width int: The screen width

  • height int: The screen height

  • frames int: The framerate

  • scan string: The scan method of the video signal, which can be either progressive ("p") or interlaced ("i")

  • name string: The full name of the video mode (a full list of modes can be found here)

  • isAutoMode bool: A flag indicating whether the video mode was set using auto mode

  • mode mode{ }: A Mode object that gives additional information about the video output. This object can contain the following properties:

    • preferred bool: A flag indicating whether the video mode is the preferred mode

    • overscan bool: A flag indicating whether the video output is using an overscan setting or not

    • modeName string: The full name of the video mode (a full list of modes can be found here)

    • interlaced bool: A flag indicating whether the video output is interlaced (true) or progressive (false)

    • 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

    • frequency int: The frame rate of the video output

    • dropFrame bool: A flag indicating whether the video timecode utilizes drop frames

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

    • colorDepth string: The color depth of the video signal ("8bit", "10bit", or "12bit")

 

GET /video/{:connector}/output/{:device}/ 

Retrieves information about the specified video output

Segments

  • connector: The current value is always hdmi

  • device: This value in /video/ URLs is currently 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.

Request Example

GET /rest/v1/video/hdmi/output/0/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json

Response Body

The following fields will be present in the response:

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

  • attached bool: This value indicates if the HDMI® output is attached or not

  • 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.

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

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

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

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

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

  • status:

    • audioBitsPerSample int

    • audioChannelCount int

    • audioFormat string

    • audioSampleRate int

    • eotf string

    • outputPowered bool

    • outputPresent bool

    • unstable bool

 

GET /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 in /video/ URLs is currently 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.

Request Example

GET /rest/v1/video/hdmi/output/0/edid/?destinationType=player&destinationName={{deviceSerial}} HTTP/1.1 Host: ws.bsn.cloud Authorization: Bearer {{UserAccessToken}} Accept: application/json, application/vnd.bsn.error+json

Response Body

  • result string: The EDID string result

 

GET /video/{:connector}/output/{:device}/power-save/ 

Retrieves the power status of the monitor connected to the player (as reported over EDID)

Segments

  • connector: The current value is always hdmi

  • device: This value in /video/ URLs is currently 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.

Request Example

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

 

PUT /video/{:connector}/output/{:device}/power-save/ 

Enables or disables power-save mode on the monitor connected to the player (via HDMI, VGA, or Component)

Segments

  • connector: The current value is always hdmi

  • device: This value in /video/ URLs is currently 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.

Request Body Parameters

  • enabled bool:  Whether or not power save is enabled 

Request Example

This is the example request body:

Response Body

The server will return a success or error message

 

GET  /video/{:connector}/output/{:device}/modes/ 

Retrieves all available video modes on the specified video output

Segments

  • connector: The current value is always hdmi

  • device: This value in /video/ URLs is currently 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.

Request Example

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

  • 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

 

GET /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 in /video/ URLs is currently 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.

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 Examples

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

    • 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

 

PUT /video/{:connector}/output/{:device}/mode/ 

Changes the video mode on the player

Segments

  • connector: The current value is always hdmi

  • device: This value in /video/ URLs is currently 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.

Request Body Parameters

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

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

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

  • colorSpace string optional: The color space of the video signal

  • dropFrame bool: 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.

  • resultobject: The response object.

    • successbool: Whether or not the operation was successful

    • rebootbool: Whether or not the player is rebooting