The 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 Player into, and it can interact with, any type of existing application.
In this section, we describe the following:
- How to access the Player API
- How to configure the server
- Path names, based on your operating system
Accessing the Player API
You can access the Player API, with the remote control feature, using one of the following:
- Port 2324:
remote_action: An application that ships with Broadsign Player, using command line.
- XML: If you want to develop your own applications, you can communicate directly with the Player API using XML.
- Flash: You can pass Flash content to the Player API.
- Port 2325: Reserved for trigger actions only, whether using
trigger.exeor one of the other methods.
- Port 2326 – WebSocket Server:
- JSON: You can pass parameters from within your HTML5 file using JSON.
- XML: If you prefer to build your application using XML, you can call the Player API over the WebSocket server.
To use these Player API tools, you must configure the server:
- XML/Flash: Ensure that you select Enable Remote Control in the Remote Control tab in the configuration profile. See Configuration Profiles – Players – Devices and Triggers Section.
- Websocket: Ensure that you select Enable Web Sockets in the Remote Control tab in the configuration profile. See Configuration Profiles – Players – Devices and Triggers Section.
You can run these tools on Windows, Ubuntu Linux and Android, and find them along the following paths:
C:\Program Files (x86)\Broadsign\bsp\bin
- Ubuntu Linux:
Here are the actions that you can call using the Player API:
- Conditions: Allows third-party applications to communicate to Broadsign Player to activate a specific piece of content for playback on the screen.
- Data Capture: 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: Allows third-party scripts to determine, for external monitoring purposes, if Broadsign Player is in an active day part opening hour period.
- Incidents: Extends monitoring capabilities, allowing third-party applications to open and close incidents on Broadsign Player.
- Loop Query: Allows third-party applications to query Broadsign Player, acquiring information about the current loop, taking action as required.
- RS-232: Allows third-party applications to execute RS-232 actions within Broadsign Player.
- Stop Command: Third-party applications and Flash files can force Broadsign Player to stop playing the current content and start playing the next item in the loop.
- Triggers: Using
triggers, that ships with the player, you can send a signal to Broadsign Player to activate a specific piece of content for playback on the screen.