Skip to content

Event data

Any scheduled event in Ontime (called an event in the app) will contain the following information.
All times are in milliseconds.

DataNote
IDEvent ID, cannot be changed
Title
Cue
Colour
NoteUser defined note, available in some views
Time StartScheduled start time
Time EndScheduled end time
DurationScheduled duration time
DelayWhether there is a delay associated to the event
Is PublicWhether the event is visible in public screens
SkipSkipped events are ignored by the runtime playback
Link StartInternal whether the start of the event is associated with the previous
Time DangerInternal second threshold from time end
Time WarningInternal second threshold from time end
End ActionInternal defines potential automation for when an event ends
Timer TypeInternal defines a method for the counting of the running timer
Time StrategyInternal defines the significant dataset for event duration
TypeInternal, this will always be Event
CustomThis is an object of user given custom fields associated to the event
// example event data
{
"title": "Albania",
"note": "SF1.01",
"endAction": "none",
"timerType": "count-down",
"timeStart": 36000000,
"timeEnd": 37200000,
"duration": 1200000,
"isPublic": true,
"skip": false,
"colour": "",
"type": "event",
"revision": 0,
"id": "32d31",
"cue": "SF1.01",
"custom": {
"song": "Sekret",
"artist": "Ronela Hajati"
}
}

End action

An event end-action refers to automations to the rundown that may occur once an event finishes (reaches 00:00).
This is unrelated to how the timer is displayed and concerns only to rundown automation.

  • none: Event will reach 00:00 and continue playing into negative numbers
  • stop: Event will reach 00:00 and the rundown will stop
  • load-next: Next event in the rundown will be loaded
  • play-next: Next event in the rundown will be loaded and started

Timer type

An event timer-type informs Ontime on how the timer show be presented. \

  • count-down: Ontime will count down the duration of the event
  • count-up : Ontime will count up from when the event starts
  • time-to-end: Ontime will count down to the scheduled event end, regardless of start time
  • clock: Ontime will display the current clock
  • none: Ontime will display a placeholder --:--:-- when this event is playing

Time strategy

An event timer-strategy informs Ontime on how to calculate changes to timers when events are linked.
Read more.