Please Note
Local triggers are only supported on BrightSign, ChromeOS and Electron Client players
Local triggers allow real-time triggering of cached content without the need for the trigger message to go via the Signagelive cloud for validation. Instead, it travels via the LAN and can deliver messages one-to-one. This capability can reduce latency and improve a solution's robustness by triggering the content locally.
The Local API Requests you need
There are 4 API requests required to set up a local trigger.
Details of each are outlined below:
Please Note
You will need to use Web Triggers to trigger content on multiple players, groups of players, or network-wide. Learn more on that here
GET: Interrupts
Route:
http://[playeripaddress]:6200/interrupts
Method:
'GET'
Request Headers:
Content-Type | application/json |
Result (trigger the content assigned to key A to play):
[
{
"name": "[name of your published interrupt]",
"triggerKey": "A"
}
]
Please Note
This will read from the current player configuration (available as a private property on the LocalAPIController), which interrupts are available, and return a JSON Array of the Interrupts. If no Interrupts are published to the player, then an empty array will be returned - Response code HTTP 200
POST: Send a Trigger
Route:
http://[playeripaddress]:6200/interrupts/trigger
Method: 'POST'
Request Headers:
Content-Type | application/json |
Request-Body:
{
"triggerKey":"A"
}Response Body:
OK
Please Note
If the trigger key is not found, i.e. the interrupt is not published, a HTTP 404 should be returned. If the trigger key is found then the content will be instantly triggered in the same way Web Triggers operates
POST: Stop your current Interrupt Trigger
Route:
http://[playeripaddress]:6200/interrupts/stop
Method: 'POST'
Request Headers:
Content-Type | application/json |
Response:
Accepted
Please Note
If there is an interrupt playing, it will be instantly stopped. Then normal scheduled content will resume and the API will return HTTP 202 Accepted. If there is no interrupt playing then HTTP 400 should be returned
Publishing Content as an Interrupt
Once you have configured your Local Triggers, you will need to go through the steps in the Publish section in accordance with this guide.