Local Web API is a simple way to integrate outside devices and trigger Content on the Player through a local network HTTP call.
The Local Web API is supported by OnSign TV on Android, Windows, Linux, Mac, and BrightSign Players.
Important: The Local Web API requires the Pro subscription.
To use the Local Web API, this option must be enabled in the Player settings.
Local Web API for Android Player 9.8.5
| Endpoint | Method | Meaning |
POST |
Triggers the play of a campaign or a Playlist which is configured with an interactivity containing the pattern {pattern}. |
|
POST |
Stops the current content playing, skipping to the next one in the loop. |
|
PUT |
Sets the attribute {name} with the value {value}. |
|
GET |
Retrieves the attribute named {name} as JSON, in the format {"name": "attr_name", "value": "attr_value"}. If no value is set for this attribute or attribute doesn't exist, returns {"name": "attr_name", "value": null}. |
|
GET |
Retrieves list of all attributes currently set as JSON, in the format {"attributes": [{"name": "attr_name", "value": "attr_value"}]}. If no value is set for an attribute, it is not listed. |
Local Web API for Windows/Mac/Linux Player 9.3.9:
| Endpoint | Method | Meaning |
GET, POST |
Triggers the play of a campaign or a Playlist which is configured with an interactivity containing the pattern {pattern}. |
|
GET, POST |
Stops the current content playing, skipping to the next one in the loop. |
|
GET, POST |
Retrieve the playback status as JSON, in the format {"visible": true, "playing": true}. |
|
GET, POST |
Shows the Player window. If window is already visible, nothing happens. |
|
GET, POST |
Hides the Player window. Playback still happens in the background. |
|
GET, POST |
Starts playing content. If content is already playing, nothing happens. |
|
GET, POST |
Stops playing content. Displays a black screen until playback is resumed. |