Ontime v1 - old
  • ontime
  • Feature list
  • Main Concepts
    • Application shortcuts
    • Interface
      • Settings Menu
      • Event List
      • Timer Control
      • Display Messages
      • Info
    • Event Types (Blocks)
      • ⚙️Settings
        • App Settings
        • Event Data Settings
        • URL Aliases Settings
        • Cuesheet Settings
        • OSC Settings
  • Views
    • Network views (Intro)
    • Stage Timer
    • Minimal Timer
    • Backstage Info
    • Public Info
    • Lower Thirds
    • PiP
    • Studio Clock
    • Cuesheet
    • Countdown
    • Clock
  • Control and feedback
    • OSC
    • HTTP API
  • Features
    • Smart Time Entry
    • The delay workflow
    • Roll
    • Import events from Excel
    • URL Aliases
    • Edit Anywhere
    • Headless Mode (Docker)
    • Note: Lower thirds in OBS
    • User fields
    • Custom Styling
    • Make your own viewer
    • Count to anything
  • ❤️Additional Notes
    • Control Ontime from vMix
    • Sync: Poll ontime status
    • Use in Raspberry Pi
Powered by GitBook
On this page
  • Returns object containing app timer status
  • Playback states

Was this helpful?

  1. Additional Notes

Sync: Poll ontime status

PreviousControl Ontime from vMixNextUse in Raspberry Pi

Last updated 3 years ago

Was this helpful?

In the scenario of syncing the state of ontime with 3rd party applications, ontime offers an endpoint to poll the app status

Returns object containing app timer status

GET http://<your_ip>:4001/ontime/poll

{
    "clock": 39981051,                  // clock in milliseconds
    "running": 1792,                    // current timer in milliseconds
    "durationSeconds": 1800,            // duration of current event
    "playback": "start",                // playback status
    "title": "Welcome to Ontime",       // current event title
    "presenter": "cpvalente",           // current event presenter 
    "timetag": "00:29:51"               // current timer string
}

Playback states

With the poll endpoint, ontime will report one of the following playback states

  • Start - Playback in play mode

  • Pause - playback in pause mode

  • Roll - playback in

  • Stop - Playback in stop mode

❤️
roll mode