Skip to main content
Using Local Triggers
Ian Maison avatar
Written by Ian Maison
Updated over a week ago

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 on a one-to-one basis. By triggering the content locally, this capability can reduce latency, and improve the robustness of a solution.

Please Note

To trigger content on multiple players, groups of players, or network wide, you will need to use Web Triggers. Learn more on that here

Please Note

Local triggers are only supported on BrightSign, ChromeOS and Electron Client players

GUIDE

To deliver a Local Trigger, there are 3 APIs required. These are outlined below along with descriptions and notes.

  1. API for getting the available interrupt inputs for a Player - This will read the interrupts configured on your player.

  2. API for triggering an interrupt - This is the ‘Trigger key’, or the letter that will tell the player to trigger the pre-configured content.

  3. API for stopping an interrupt - This will immediately stop the interrupt content from playing, and resume the normal, scheduled content.

API for getting the available interrupt inputs for a Player

Route
http://[playeripaddress]:6200/interrupts
Method
GET
 Request Headers
Content-Type
application/json
 Result
[{"name":"Interrupt A",     "triggerKey":"A"},{"name":"Interrupt B","triggerKey":"B"}]        

Please Note

This will read from the current configuration (available as a private property on the LocalAPIController) the interrupts available and return a JSON Array of the Interrupts. If no Interrupts are published then an empty array should be returned - Response code HTTP 200

API for triggering an interrupt

Route
http://[playeripaddress]:6200/interrupts/trigger
Method
POST
Request Headers
Content-Type
application/json
Request Body
{

    "triggerKey":"A"

}
Response Body
{

    "triggerKey":"A"

}

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

API for stopping an interrupt

Route
http://[playeripaddress]:6200/interrupts/stop
Method
POST
Request Headers
Content-Type

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 accordance with this guide.

Did this answer your question?