Screenshot Request Action

Call the screenshot_request action using one of the following:

WebSocket Server:

• JSON – You can pass parameters from within your HTML5 file using JSON.

  Note: Ensure that you select Enable Remote Control in the Remote Control tab of the configuration profile. See The Remote Control Tab.

  Note: If using JSON via the WebSocket server, any firewall present on Broadsign Control Player should be configured to access port 2326 directly for use.

Port 2324:

• remote_action – An application that ships with Broadsign Control Player, using command line.
• XML – If you want to develop your own applications, you can communicate directly with Broadsign Control Player API using XML.

Note: Ensure that you select Enable Remote Control in the Remote Control tab of the configuration profile. See The Remote Control Tab.

Note: Any firewall present on Broadsign Control Player should be configured to either allow bsp.exe to open ports, or configure port 2324 or port 2326 directly for use.

Note: The Triggers Action is the only exception to this rule. It uses port 2325. See Triggers Action.

You can call this action on Windows and Ubuntu Linux, and find it along the following paths:

• Windows (64-bit):

C:\Program Files\BroadSign\bsp\bin

• Ubuntu Linux:

  /opt/broadsign/suite/bsp/bin/

You can request screenshots from a player by invoking the standalone executable remote_action which ships with Broadsign Control Player. It can be found in the player’s installation bin directory.

For example, to request a screenshot, type:

remote_action screenshot_request --dest-url "YourURLHere" --burst-duration 1000 --burst-frequency 100 --scale-factor 100

Where:

• screenshot_request: The action type.
• dest-url: The URL to which you want the player to send the screenshot, in jpeg format.
• burst-duration: The total duration (in milliseconds) for which the player should send multiple screenshots at the specified burst_frequency.
• burst-frequency: If burst_duration_ms is specified, burst_frequency_ms dictates the number of milliseconds between screenshots.
• scale-factor: Optional. Integer, 1-100. 100 = full resolution. Aspect ratio is preserved.

A custom application can request screenshots from Broadsign Control Player by sending an XML message to the monitor_remote port (2324).

<rc version="1" id="1-abcdef" action="screenshot_request" dest_url="https://app.example.com/upload" scale_factor="50" burst_duration_ms="60000" burst_frequency_ms="3000"/>\r\n\r\n

Note: You must terminate the request with \r\n\r\n.

The player will respond with the following document:

<rc version="1" status="1" action="screenshot_request" id="1" />

Note: Each command sent requires a unique identifier (id). The application can use a simple incrementing value here.

Screenshot Request Action - XML Parameters

Note: Any firewall present on Broadsign Control Player should be configured to either allow bsp.exe to open ports, or configure port 2324 or port 2326 directly for use.

The player will respond with the following document:

{
    "rc": {
        "version": "1",
        "status": "1",
        "action": "screenshot_request",
        "id": "1",
    }
}

Screenshot Request Action - JSON Parameters

Note: If using JSON via the WebSocket server, any firewall present on Broadsign Control Player should be configured to access port 2326 directly for use.