Interrupt

The interrupt object details events to listen for and actions to perform when they are received. Currently only key presses are supported and the action will be a layout to display

Field definitions:
Name Description Required
name The name of the interrupt Yes
trigger An object describing how the interrupt is triggered. Yes
action An object describing interrupt action. Yes
Trigger Field definitions:
Name Description Required
type The type of interrupt trigger. Only KeyboardEvent is currently supported. Yes
configuration_parameters A collection of name/value pairs specifying how the interrupt is initiated and cancelled. Yes
Trigger configuration parameters:
Name Description Required
ActionKey The key use to initiate the interrupt. Yes
CancelKey The key used to cancel the interrupt. No
Action field definitions
Name Description Required
layout_id The id of the layout to play. Yes
duration Duration to play the layout for in seconds, if the layout is not cancelled. If duration is 0, the layout will play until all playlists in the layout have been played at least once. Yes

 

Scheduling Example

Only one interrupt will be active at any one time. When an interrupt is cancelled or ends, the scheduled content will resume playing. When a second interrupt is triggered while the first is playing, the first is automatically cancelled.

Example 1:

  1. Scheduled content is playing
  2. Interrupt 1 is triggered
  3. Interrupt 1 plays
  4. Interrupt 1 finishes playing
  5. Scheduled content plays

Example 2:

  1. Scheduled content is playing
  2. Interrupt 1 is triggered
  3. Interrupt 1 plays
  4. Interrupt 2 is triggered
  5. Interrupt 2 plays
  6. Interrupt 2 is cancelled
  7. Scheduled content plays