Timeline#

The Timeline subscription allows you to subscribe to changes to active timelines or timeline state.

Subscribe Message#

{
   "subscribe": "timeline"
}

Change Message#

When the state of any scene changes, a message is sent out with the following parameters in the data part of the JSON object:

Attribute

Value Type

Description

Value Example

num

integer

Timeline number

1

state

string

The new state of the timeline: none, running, paused, holding_at_end, released

"running"

onstage

boolean

Whether the timeline is currently affecting the output of any fixtures in the project.

true

position

integer

Current time position of the timeline playback, in milliseconds

5000

For example:

{
   "broadcast": "scene",
   "data": {
      "num": 1,
      "onstage": true,
      "state": "started"
   }
}