Ontime v2
Link to new docs
  • ontime
  • Feature list
  • Roadmap
  • Contributing
  • Main Concepts
    • Interface
      • Settings Bar
      • Rundown
      • Timer Control
      • Display Messages
      • Info
      • Quick start
      • Upload
      • Integration Settings
      • Application Settings
        • App Settings
        • Event Data
        • Editor Settings
        • Cuesheet settings
        • Views
        • URL Aliases
      • About modal
  • Views
    • Network views (Intro)
    • Stage Timer
    • Clock
    • Minimal Timer
    • Backstage Info
    • Public Info
    • Lower Thirds
    • Studio Clock
    • Countdown
    • Cuesheet
  • Control and feedback
    • Ontime APIs
      • HTTP API
    • Integrations
    • Runtime Data
  • Features
    • Google Sheet
    • 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
    • External data
  • ❤️Additional Notes
    • Control Ontime from vMix
    • Sync: Poll ontime status
    • Use in Raspberry Pi
    • Companion module
Powered by GitBook
On this page
  • HTTP API
  • Returns object containing app timer status
  • OSC and Websocket API
  1. Additional Notes

Sync: Poll ontime status

PreviousControl Ontime from vMixNextUse in Raspberry Pi

Last updated 1 year ago

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

HTTP API

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
}

OSC and Websocket API

You can also poll using both the OSC and WebSocket APIs,

❤️
see the definition