- We provide a short video introducing the features of our docs. See Broadsign Documentation in MadCap Flare.
- Images are thumbnails. To embiggen, click the image.
- Search is based on keyword. Ex: "Proposals"
- Do not search with natural language. Ex: "How do I create a proposal?"
- For release notes and highlights (past and present), see Release Highlights.
- Broadsign provides docs for many of the latest versions of its products. For older documentation, see Docs Archives.
Archived Docs Version 12.1 (For latest version, click here)
Broadsign Control Player API
The Broadsign Control Player API is an open and scriptable platform upon which you can implement your custom logic. You can query it for information, and control the playback behavior from a third party application or script.
You can embed Broadsign Control Player API into, and it can interact with, any type of existing application.
In this section, we discuss how to access the Broadsign Control Player API, how to configure the server and the path names for various operating systems.
- 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 in 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.
Flash: You can call Broadsign Control Player API from Flash content.
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:
C:\Program Files (x86)\BroadSign\bsp\bin
Here are the actions that you can call using the Broadsign Control Player API:
- Conditions Action: Allows third-party applications to communicate to Broadsign Control Player to activate a specific piece of content for playback on the screen.
- Data Capture Action: Designed to capture user-definable information, e.g., name, address, phone number, from interactive sign/kiosk applications. You can then associate that data with the campaign playing the interactive content.
- Day Part Query Action: Allows third-party scripts to determine, for external monitoring purposes, if Broadsign Control Player is in an active day part opening hour period.
- Incidents Action: Extends monitoring capabilities, allowing third-party applications to open and close incidents on Broadsign Control Player.
- Loop Query Action: Allows third-party applications to query Broadsign Control Player, acquiring information about the current loop, taking action as required.
- RS-232 Action: Allows third-party applications to execute RS-232 actions within Broadsign Control Player.
- Stop Command Action: Third-party applications and Flash files can force Broadsign Control Player to stop playing the current content and start playing the next item in the loop.
- Triggers Action: Using triggers, that ships with the player, you can send a signal to Broadsign Control Player to activate a specific piece of content for playback on the screen.