Skip to content

Latest commit

 

History

History
170 lines (133 loc) · 6.53 KB

HELP.md

File metadata and controls

170 lines (133 loc) · 6.53 KB

Stagetimer.io logo

Stagetimer.io module for Companion

This module lets you remotely control Stagetimer using Companion.

It connects using the Stagetimer HTTP RPC API and Stagetimer Socket.io endpoint.

Requirements

To use this module you need:

  • A Stagetimer account on a paid plan (Pro or Premium).
  • Room ID: The ID of the Stagetimer room you want to control.
  • API Key: A key that authorizes you to use the Stagetimer API. You can generate an API key on the controller page.

Configuration

  1. Click on the module in the Connections list to reveal the configuration pane.
  2. Enter your Room ID and API Key in the form and click Save.
  3. If the details you entered are correct, the module will connect. If the module fails to connect, please review the output in the Companion Logs tab.

Presets

There are multiple presets available for the most common actions, ready to drop into your button layout.

Find a complete list in the Presets section of this guide in the Stagetimer docs:
Controlling Stagetimer via Companion for Stream Deck (Comprehensive Guide)

Actions

The following Actions are available:

Message actions:

  • Message: Hide
    Hide a message in the room
  • Message: Show
    Show a message in the room
  • Message: Toggle visibility
    Show/hide a message in the room
  • Message: Create new message
    Create a new message in the room

Timer actions:

  • Timer: Reset
    Reset a specific timer to original duration
  • Timer: Start
    Start or resume a specific timer in the room
  • Timer: Stop
    Stop a specific timer in the room
  • Timer: Toggle playback
    Toggle (start/stop) a specific timer in the room
  • Timer: Create new timer
    Create a new timer in the room

Transport actions:

  • Transport: Add time
    Add an amount of time to the highlighted timer in the room.
  • Transport: Next
    Highlight the next timer in the list
  • Transport: Previous
    Reset the highlighted timer in the room if it is running. If the highlighted timer is not running, highlight the previous timer in the list. Optionally, you can automatically start the previous timer once it's highlighted.
  • Transport: Start
    Start or resume the highlighted timer in the room
  • Transport: Start/stop
    Start/stop the highlighted timer in the room
  • Transport: Stop
    Stop the highlighted timer in the room
  • Transport: Reset
    Reset or restart the currently highlighted timer.
  • Transport: Subtract time
    Subtract an amount of time from the highlighted timer in the room.

Viewer actions:

  • Viewer: Disable blackout mode
    Disable blackout mode in the room
  • Viewer: Disable focus mode
    Disable focus mode in the room
  • Viewer: Enable blackout mode
    Enable blackout mode in the room
  • Viewer: Enable focus mode
    Enable focus mode in the room
  • Viewer: Flash the screen
    Flashes the screen in the room. Can be used to grab the attention of speakers.
  • Viewer: Stop flashing
    Stops any flashing timers and message on the screen.
  • Viewer: Toggle blackout mode
    Toggle (enable/disable) blackout mode in the room
  • Viewer: Toggle focus mode
    Toggle (enable/disable) focus mode in the room

Utility actions:

  • Utility: Get room
    Get status of the room
  • Utility: Get status
    Get playback status of the room
  • Utility: Test auth
    Test connection and authentication

Variables

Room

  • $(stagetimer:roomId) - Room ID
  • $(stagetimer:roomName) - Room name
  • $(stagetimer:roomTimezone) - Room timezone (Docs)

Playback Snapshot
The time display is equal to the Stagetimer output, taking timer appearance into account (Docs). The current time remaining is always strictly a countdown.

  • $(stagetimer:timeDisplay) - Time Display
  • $(stagetimer:timeDisplayHours) - Time Display (hours)
  • $(stagetimer:timeDisplayMinutes) - Time Display (minutes)
  • $(stagetimer:timeDisplaySeconds) - Time Display (seconds)
  • $(stagetimer:currentTimerRemaining) - Timer remaining time
  • $(stagetimer:currentTimerRemainingAsMs) - Timer remaining time (ms)
  • $(stagetimer:currentTimerRemainingHours) - Timer remaining time (hours)
  • $(stagetimer:currentTimerRemainingMinutes) - Timer remaining time (minutes)
  • $(stagetimer:currentTimerRemainingSeconds) - Timer remaining time (seconds)

Current Timer

  • $(stagetimer:currentTimerId) - Timer ID
  • $(stagetimer:currentTimerName) - Timer name
  • $(stagetimer:currentTimerSpeaker) - Timer speaker
  • $(stagetimer:currentTimerNotes) - Timer notes
  • $(stagetimer:currentTimerAppearance) – Timer appearance (Docs)
  • $(stagetimer:currentTimerStartTime12h) - Hard start time (12h format, Docs)
  • $(stagetimer:currentTimerStartTime24h)- Hard start time (24h format, Docs)
  • $(stagetimer:currentTimerDuration) - Timer duration
  • $(stagetimer:currentTimerDurationAsMs) - Timer duration (ms)

Next Timer

  • $(stagetimer:nextTimerId) - Timer ID
  • $(stagetimer:nextTimerName) - Timer name
  • $(stagetimer:nextTimerSpeaker) - Timer speaker
  • $(stagetimer:nextTimerNotes) - Timer notes
  • $(stagetimer:nextTimerAppearance) – Timer appearance (Docs)
  • $(stagetimer:nextTimerStartTime12h) - Hard start time (12h format, Docs)
  • $(stagetimer:nextTimerStartTime24h)- Hard start time (24h format, Docs)
  • $(stagetimer:nextTimerDuration) - Timer duration
  • $(stagetimer:nextTimerDurationAsMs) - Timer duration (ms)

Feedbacks

  • Blackout mode
  • Flashing
  • Focus mode
  • Message showing
  • Playback running
  • Playback stopped
  • Timer is over time
  • Timer is running and on time
  • Timer is showing red wrap-up warning
  • Timer is showing yellow wrap-up warning