Skip to content

OSC API

The OSC and WebSocket APIs allow for low latency communication to Ontime server.

Terminal window
/ontime/change/<event-id>/<field> <new-value>

The change endpoint allows changing some of the properties of a given event (below).
The request should contain a patch of the event to be changed, along with the ID of the event to change.

You can change any field in an event using this endpoint. See below a description of expected values.

PropertyValue type
titlestring
notestring
cuestring (value should be kept under 8 characters)
isPublicboolean
skipboolean
colourstring (# hex colour or named css colour)
customtarget the specific custom field with custom:<fieldname>
timeWarningnumber (in seconds)
timeDangernumber (in seconds)
endActionstring (none / load-next / play-next / stop)
timerTypestring (count-down / count-up / time-to-end / clock / none)
durationnumber (in seconds)
timeStartnumber (in seconds)
timeEndnumber (in seconds)

OSC Message

Terminal window
/ontime/change/<event-id>/title <new-value>

The custom field must exist in the project to be accepted by the API.
See more on custom fields

OSC Message

Terminal window
/ontime/change/<event-id>/custom:<field-name> <new-value>

The following endpoints allow controlling the messages Ontime sends to the timer view.
The payload response is the current state of the message data.

OSC Message

Terminal window
# Note that this will set the text, however setting its visibility is a separate operation.
# See below
/ontime/message/external <new-text>

Example: secondary source in the timer view

Section titled “Example: secondary source in the timer view”

OSC Message

Show auxiliary timer as secondary field
/ontime/message/timer/secondarySource 'aux'

OSC Message

Show external message as secondary field
/ontime/message/timer/secondarySource 'external'

OSC Message

Hide secondary field
# Note: The secondary source can be `aux` or `external`, any other value will assign the property to null (ie: off)
/ontime/message/timer/secondarySource 'off'

You can remotely blackout every screen that is in the timer view.

OSC Message

Blackout timer screen
/ontime/message/timer/blackout true

OSC Message

Disable timer screen blackout
/ontime/message/timer/blackout false

The following endpoints allow controlling the Ontime’s playback.

OSC Message

Terminal window
/ontime/start

OSC Message

Terminal window
/ontime/start/index <event-index>

OSC Message

Terminal window
/ontime/start/id <event-id>

OSC Message

Terminal window
/ontime/start/cue <event-cue>

OSC Message

Terminal window
/ontime/start/next

OSC Message

Terminal window
/ontime/start/previous

OSC Message

Terminal window
/ontime/pause

OSC Message

Terminal window
/ontime/load/index <event-index>

OSC Message

Terminal window
/ontime/load/id <event-id>

OSC Message

Terminal window
/ontime/load/cue <event-cue>

OSC Message

Terminal window
/ontime/load/next

OSC Message

Terminal window
/ontime/load/previous

OSC Message

Terminal window
/ontime/reload

OSC Message

Terminal window
/ontime/stop

OSC Message

Terminal window
/ontime/roll

OSC Message

Terminal window
/ontime/addtime/add <value-in-seconds>

OSC Message

Terminal window
/ontime/addtime/remove <value-in-seconds>

Ontime provides an auxiliary timer which does not affect the current playback.
This can be controlled using the API as shown below

OSC Message

Terminal window
/ontime/auxtimer/1/duration <value-in-seconds>

Auxiliary timer can count up or count down.

OSC Message

Terminal window
/ontime/auxtimer/1/direction count-up

OSC Message

Terminal window
/ontime/auxtimer/1/direction count-down

OSC Message

Terminal window
/ontime/auxtimer/1/start

OSC Message

Terminal window
/ontime/auxtimer/1/pause

OSC Message

Terminal window
/ontime/auxtimer/1/stop

OSC Message

Terminal window
/ontime/auxtimer/1/addtime <value-in-seconds>