Loading...
Loading...
Control KUMA Timer (macOS & Windows professional countdown timer) from Bitfocus Companion via HTTP/JSON API.
5555)500 ms)If KUMA Timer is running on the same machine as Companion, use 127.0.0.1.
| Action | Description |
|---|---|
| Start | Start the countdown timer |
| Pause / Resume | Pause or resume the timer |
| Reset | Stop and reset the timer |
| Hide / Show Display | Toggle the display window visibility |
| +1 Minute | Add 60 seconds to remaining time |
| -1 Minute | Subtract 60 seconds from remaining time |
| Load Time (seconds) | Load a specific duration in seconds |
| Load Time (MM:SS) | Load a specific duration as minutes + seconds |
| Load Preset | Load one of the 6 quick-access preset times (index 0–5) |
| Load Cue | Load a cue from the runsheet by index (0 = first) |
| Next Cue | Advance to the next cue in the list |
| Previous Cue | Go back to the previous cue in the list |
| Set Display Mode | Switch between TIMER and CLOCK display modes |
| Send Message (SMS) | Display a text message overlay on the timer display |
| Cancel SMS | Remove the active message overlay |
| Feedback | Trigger |
|---|---|
| Timer is LIVE | Timer is actively counting down |
| Timer is PAUSED | Timer is paused |
| Timer in STANDBY | Timer is stopped (standby) |
| Display is HIDDEN | Display window is hidden |
| Timer in OVERTIME | Timer has passed zero and is counting up |
| Cue is active (by index) | The cue at the specified index is currently loaded |
| Low time warning | Progress % has dropped below a configurable threshold |
| SMS message is active | A message overlay is currently displayed |
| Variable | Description |
|---|---|
$(pltech-kumatimer:timer) | Current time string (e.g. 05:23) |
$(pltech-kumatimer:timer_seconds) | Remaining seconds as a number |
$(pltech-kumatimer:status) | Status: LIVE, PAUSED, STANDBY, or HIDDEN |
$(pltech-kumatimer:display_mode) | Display mode: TIMER or CLOCK |
$(pltech-kumatimer:cue_name) | Name of the currently loaded cue / speaker |
$(pltech-kumatimer:cue_index) | Index of the current cue (−1 if none) |
$(pltech-kumatimer:overtime) | true if in overtime, otherwise false |
$(pltech-kumatimer:progress) | Progress bar value (0–100 %) |
$(pltech-kumatimer:sms_active) | true if a message overlay is active |
The module provides ready-made preset buttons in these categories: