Stagetimer

https://stagetimer.io/docs/
Admin
Stagetimer is a cloud-based countdown timer designed for live events, presentations, broadcasts, and...
Tokens:51,149
Snippets:168
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Stagetimer Desktop App Installation (Windows)

Source: https://stagetimer.io/docs/desktop-app

Step-by-step guide to download and install the Stagetimer Desktop App on Windows, including how to handle security warnings.

```English
1. Download the Windows installer (.exe file) from the [desktop app page](https://stagetimer.io/desktop-app/).
2. Run the downloaded installer file. You’ll see it appear in your Downloads folder.
3. When you first run the installer, Windows may display a security warning. This appears because the app isn’t code-signed with an official Microsoft certificate, which can be challenging and costly for smaller developers like us.
4. Click “More info” on the first warning screen, then click “Run anyway” on the second screen. This is safe when the installer was downloaded directly from our official website.
5. The installer runs automatically and typically opens the Stagetimer app within a few seconds of clicking the setup file.
```

--------------------------------

### Stagetimer API GET Request Example

Source: https://stagetimer.io/docs/api-v1

Demonstrates a GET request to the Stagetimer API to start a timer in a specific room. It includes the necessary room ID and API key as query parameters.

```curl
curl -v "https://api.stagetimer.io/v1/start?room_id=6ADP4P5U&api_key=123456"
```

--------------------------------

### Stagetimer ATEM Integration - Luma Key Setup

Source: https://stagetimer.io/docs/integration-with-atem

Steps to integrate Stagetimer with ATEM switchers using the luma key method. This involves connecting the computer, configuring Stagetimer's shareable link with a black background, and setting up the ATEM's upstream keyer.

```APIDOC
Luma Method Integration:

1. Connect Computer:
   - Connect your computer (running Stagetimer) to an ATEM switcher input via HDMI.
   - Enable "Extended Desktop" mode on your computer.

2. Open Timer Display:
   - In Stagetimer, click "Share" to open "Sharable Links".
   - Use the default background (slightly off-black) for luma keying.
   - Optional: Select "Isolate: Timer" to show only the countdown.
   - Open and position the window as described in the Chroma Method (Step 2).

3. ATEM Upstream Key 1 Configuration (Luma):
   - Open ATEM Software Control.
   - Navigate to the "Palettes" section on the right.
   - Expand "Upstream Key 1" and select the "Luma" tab.
   - Set "Fill Source" to the ATEM input connected to your Stagetimer computer.
   - Adjust "Clip" and "Gain" settings as needed for proper luma keying.

4. Activate Key:
   - Turn on "Upstream Key 1" in ATEM Software Control to display the Stagetimer overlay.
```

--------------------------------

### Stagetimer ATEM Integration - Chroma Key Setup

Source: https://stagetimer.io/docs/integration-with-atem

Steps to integrate Stagetimer with ATEM switchers using the chroma key method. This involves connecting the computer, configuring Stagetimer's shareable link with a specific background color, and setting up the ATEM's upstream keyer.

```APIDOC
Chroma Method Integration:

1. Connect Computer:
   - Connect your computer (running Stagetimer) to an ATEM switcher input via HDMI.
   - Enable "Extended Desktop" mode on your computer.

2. Open Timer Display:
   - In Stagetimer, click "Share" to open "Sharable Links".
   - Select "Chroma Key Purple" (or desired chroma key color) as the background.
   - Optional: Select "Isolate: Timer" to show only the countdown.
   - Click "Open link in new tab".
   - Drag the new window to your extended display.
   - Make the window fullscreen (F11 or Cmd/Ctrl + Shift + F).
   - macOS users: Ensure "Displays have Separate Spaces" is checked in Mission Control.

3. ATEM Upstream Key 1 Configuration:
   - Open ATEM Software Control.
   - Navigate to the "Palettes" section on the right.
   - Expand "Upstream Key 1" and select the "Chroma" tab.
   - Set "Fill Source" to the ATEM input connected to your Stagetimer computer.
   - Set the "Chroma Sample" color by clicking the "Chroma Sample" option and sampling the Stagetimer background color.

4. Activate Key:
   - Turn on "Upstream Key 1" in ATEM Software Control to display the Stagetimer overlay.
```

--------------------------------

### Stagetimer.io Timer Trigger Options

Source: https://stagetimer.io/docs/timers

Defines how a timer is initiated. Options include manual start, automatic start linked to the previous timer's completion, or scheduled start at a specific server-side time.

```APIDOC
Timer Trigger Options:
  * Manual: Timer starts manually via the "Play" button.
  * Linked: Timer starts automatically when the previous timer reaches zero.
  * Scheduled: Timer starts automatically at a specified server-side time, even if the controller page is closed.
```

--------------------------------

### Example URL with Multiple Parameters

Source: https://stagetimer.io/docs/viewer

An example showing how to combine multiple URL parameters to customize the viewer page, including mirroring the display and hiding controls.

```URL
https://stagetimer.io/r/YOURROOM/?mirror=horizontal,vertical&hide=controls
```

--------------------------------

### Stagetimer.io Timer Trigger Options

Source: https://stagetimer.io/docs/using-timers

Defines how a timer is initiated. Options include manual start, automatic start linked to the previous timer's completion, or scheduled start at a specific server-side time.

```APIDOC
Timer Trigger Options:
  * Manual: Timer starts manually via the "Play" button.
  * Linked: Timer starts automatically when the previous timer reaches zero.
  * Scheduled: Timer starts automatically at a specified server-side time, even if the controller page is closed.
```

--------------------------------

### Example URL with Name Parameter

Source: https://stagetimer.io/docs/viewer

An example demonstrating how to set a custom device name for the viewer page using the 'name' URL parameter.

```URL
https://stagetimer.io/r/YOURROOM/?name=Stage
```

--------------------------------

### API Authentication Examples

Source: https://stagetimer.io/docs/api-v1

Demonstrates two methods for authenticating API requests: using the 'api_key' query parameter and using the 'Authorization' header with a bearer token. Both examples show how to test authentication with a room ID.

```curl
curl "https://api.stagetimer.io/v1/test_auth?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

```curl
curl "https://api.stagetimer.io/v1/test_auth?room_id=YOUR_ROOM_ID" -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Stagetimer Desktop App Updates

Source: https://stagetimer.io/docs/desktop-app

Instructions on how to update the Stagetimer Desktop App by downloading and running the new installer, ensuring data preservation.

```English
You can install updates the same way by downloading and running the new installer. All your existing data, rooms, and license keys will be preserved during the update process.
```

--------------------------------

### StageTimer.io API - Create Timer Request Example

Source: https://stagetimer.io/docs/api-v1

Example cURL command to create a timer using the StageTimer.io API, demonstrating the endpoint and required parameters.

```bash
curl "https://api.stagetimer.io/v1/create_timer?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### StageTimer.io API - Create Timer Response Example

Source: https://stagetimer.io/docs/api-v1

Example JSON response from the StageTimer.io API after successfully creating a timer, showing the structure of the returned data.

```APIDOC
200 – Response (example)
```
{
 "ok": true,
 "message": "Timer created",
 "data": {
  "_id": "63f59467d68bfdeef6b3bfc3",
  "_model": "timer",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "name": "Timer 1",
  "speaker": "Thomas",
  "notes": "Very tall, remember to adjust camera angle",
  "labels": [
   {
    "name": "VT",
    "color": "#F44336"
   }
  ],
  "appearance": "COUNTDOWN",
  "type": "DURATION",
  "duration": "0:01:00",
  "hours": 0,
  "minutes": 1,
  "seconds": 30,
  "wrap_up_yellow": 60,
  "wrap_up_red": 15,
  "trigger": "MANUAL",
  "start_time": "2023-05-01T08:40:06.463Z",
  "start_time_uses_date": false,
  "finish_time": "2023-05-01T08:40:06.463Z",
  "finish_time_uses_date": false
 }
}
```
```

--------------------------------

### Install Stagetimer on Ubuntu/Debian Linux via Command Line

Source: https://stagetimer.io/docs/desktop-app

This snippet shows how to install the Stagetimer desktop application on Ubuntu or Debian-based Linux distributions using the dpkg command in the terminal. Ensure you replace the placeholder filename with the actual downloaded .deb file name.

```bash
sudo dpkg -i stagetimer.io-2.18.0-arm64.deb
```

--------------------------------

### ATEM Upstream Key 1 Luma Settings

Source: https://stagetimer.io/docs/integration-with-atem

Configuration steps for ATEM Upstream Key 1 using the Luma method with Stagetimer. This involves setting fill and key sources, unchecking 'Pre Multiplied Key', and adjusting 'Clip' and 'Gain'.

```APIDOC
ATEM Upstream Key 1 Configuration (Luma Method):

1. Open ATEM Software Control and navigate to 'Palettes'.
2. Expand 'Upstream Key 1' and select the 'Luma' tab.

Settings:
- Fill Source: Set to the input connected to the Stagetimer computer.
- Key Source: Set to the input connected to the Stagetimer computer.
- Pre Multiplied Key: Uncheck this option.

Refining the Key:
- Clip: Set to a low number to remove darker parts of the image.
- Gain: Adjust to control how much of the dark image is removed.

Note: These settings affect dark elements in the timer display. Consider using lighter colors in your timer theme if elements appear to be removed.
```

--------------------------------

### General GET Request with Query Parameters

Source: https://stagetimer.io/docs/api-v1

Illustrates the standard format for a GET request with query parameters, showing how key-value pairs are appended to a URL.

```http
https://api.example.com/resource?key1=value1&key2=value2
```

--------------------------------

### Control Timer: Start

Source: https://stagetimer.io/docs/api-v1

Starts or resumes the highlighted timer in a given room. Requires a room ID and API key.

```APIDOC
GET https://api.stagetimer.io/v1/start

Query parameters:
  room_id (Required, string): ID of the room.
  api_key (Required, string): Your API key.

Response (200):
{
 "ok": true,
 "message": "Timer started at 0:01:00",
 "data": {
  "_model": "playback_status",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "timer_id": "63f59467d68bfdeef6b3bfc3",
  "running": false,
  "start": 1677055206453,
  "finish": 1677055206453,
  "pause": 1677055206453,
  "server_time": 1677055206453
 }
}
```

```bash
curl "https://api.stagetimer.io/v1/start?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### StageTimer.io Timer Configuration

Source: https://stagetimer.io/docs/controller

Explains the configuration options for timers, including setting start times (manual, linked, scheduled), duration, and appearance (countdown, count up, time of day, hidden). Covers wrap-up times and actions like chimes and flashing.

```English
Timer settings include title, speaker, and notes (optional).
Start time triggers: Manual (reference only), Linked (starts when previous timer finishes), Scheduled (starts at a specific time/date).
Duration can be fixed or calculated based on a finish time.
Appearance options: Countdown, Count Up, Time of Day, Hidden.
Wrap-up times trigger visual warnings (yellow/red) and actions (chimes, flashing) at set times before the timer ends.
```

--------------------------------

### Install Chromium Browser on Raspberry Pi

Source: https://stagetimer.io/docs/integration-with-raspberry-pi

This snippet shows the terminal commands to update package lists and install the Chromium web browser on a Raspberry Pi, which is necessary to access web applications like Stagetimer.

```bash
sudo apt-get update
sudo apt-get install chromium-browser
chromium-browser
```

--------------------------------

### StageTimer.io API - Update Timer Request Example

Source: https://stagetimer.io/docs/api-v1

Provides an example of a cURL request to update a timer in a room using the StageTimer.io API, including placeholders for room ID and API key.

```bash
curl "https://api.stagetimer.io/v1/update_timer?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### Launch Stagetimer on Linux via Command Line

Source: https://stagetimer.io/docs/desktop-app

This command is used to launch the Stagetimer desktop application from the terminal after it has been installed on a Linux system. Some desktop environments may also add it to the application menu.

```bash
stagetimerio
```

--------------------------------

### JavaScript Socket.io Client

Source: https://stagetimer.io/docs/api-v1

Example of connecting to the StageTimer.io socket.io endpoint using the 'socket.io-client' library in JavaScript. It demonstrates connection, error handling, and receiving all events.

```JavaScript
import { io } from "socket.io-client";

const socket = io('https://api.stagetimer.io', {
  path: '/v1/socket.io',
  auth: { room_id: 'YOUR_ROOM_ID', api_key: 'YOUR_API_KEY' },
});

socket.on('connect', () => { console.info('Connection Success') });
socket.on('connect_error', (error) => { console.error('Connection Error:', error); });
socket.onAny((event, payload) => { console.info(event, payload) });
```

--------------------------------

### Timer Show Control Modes

Source: https://stagetimer.io/docs/timers

This section explains the two primary modes for running a show with Stagetimer.io: manual control and automated control. It discusses the use cases and recommended setups for each mode.

```APIDOC
Show Control Modes:
  1. Manual Control:
     - Description: Advance timers one by one manually.
     - Recommended for: Shows with a dedicated show caller.
     - Setup: Integrate with Stream Deck and Companion for easy access to actions (start, stop, next).
     - Guide: https://stagetimer.io/docs/integration-with-streamdeck-companion/

  2. Automated Control:
     - Description: Link timers together to run sequentially without manual intervention.
     - Use Case: Ideal for predictable show flows or displaying an agenda publicly.
     - Consideration: May reduce flexibility for overtime management.
```

--------------------------------

### Python Socket.io Client

Source: https://stagetimer.io/docs/api-v1

Example of connecting to the StageTimer.io socket.io endpoint using the 'python-socketio' library in Python. It shows how to define event handlers and establish a connection with authentication.

```Python
import socketio

sio = socketio.Client()

@sio.event
def connect():
    print('Connected to Socket.io')

@sio.on('*')
def catch_all(event, data):
    print('Message received', event, data)

auth = { 'room_id': 'YOUR_ROOM_ID', 'api_key': 'YOUR_API_KEY' }
sio.connect('https://api.stagetimer.io', {}, auth, None, None, 'v1/socket.io')
```

--------------------------------

### Timer Show Control Modes

Source: https://stagetimer.io/docs/using-timers

This section explains the two primary modes for running a show with Stagetimer.io: manual control and automated control. It discusses the use cases and recommended setups for each mode.

```APIDOC
Show Control Modes:
  1. Manual Control:
     - Description: Advance timers one by one manually.
     - Recommended for: Shows with a dedicated show caller.
     - Setup: Integrate with Stream Deck and Companion for easy access to actions (start, stop, next).
     - Guide: https://stagetimer.io/docs/integration-with-streamdeck-companion/

  2. Automated Control:
     - Description: Link timers together to run sequentially without manual intervention.
     - Use Case: Ideal for predictable show flows or displaying an agenda publicly.
     - Consideration: May reduce flexibility for overtime management.
```

--------------------------------

### StageTimer.io API - Create Timer Parameters

Source: https://stagetimer.io/docs/api-v1

Defines the query parameters available for creating a new timer via the StageTimer.io API. Includes required and optional parameters with their types, examples, and default values.

```APIDOC
Query parameters:

room_id
    
**Required <string>**
Example: `6ADP4P5U`
ID of the room you are targeting. 

name
    
**Optional <string>**
Example: `Timer 1`
Default: `Timer [n]`
Name of the timer. 

speaker
    
**Optional <string>**
Example: `Thomas`
Default: `[blank]`
Used to identify speakers. 

notes
    
**Optional <string>**
Example: `Very tall, remember to adjust camera angle`
Default: `[blank]`
Notes related to the timer or speaker. 

labels
    
**Optional <array>**
Example: `[   {     "name": "VT",     "color": "#F44336"   } ]`
Default: `[]`
Colored tags visible on the controller page. Can be provided using indexed notation in the URL query string.  
Example usage: `?labels[0][name]=VT&labels[0][color]=%23F44336&labels[1][name]=Break&labels[1][color]=%234CAF50`
This represents an array of two labels:
  1. Name: "VT", Color: "#F44336" (Red)
  2. Name: "Break", Color: "#4CAF50" (Green)

  
Note: The '#' in color codes must be URL-encoded as '%23'.  
You can add as many labels as needed by incrementing the index and providing both 'name' and 'color' for each. 

appearance
    
**Optional <string>**
Default: `COUNTDOWN`
Possible values:  `COUNTDOWN`, `COUNTUP`, `TOD`, `COUNTDOWN_TOD`, `COUNTUP_TOD`, `HIDDEN`
Defines how the timer is displayed. Read more: [Timer Appearances](https://stagetimer.io/docs/using-timers/#timer-appearances)

type
    
**Optional <string>**
Default: `DURATION`
Possible values:  `DURATION`, `FINISH_TIME`
Defines the type of timer, ie. how runtime length is handled. Read more: [Timer Types](https://stagetimer.io/docs/using-timers/#timer-types)

hours
    
**Optional <integer>**
Example: `0`
Default: `0`
Duration (hours). 

minutes
    
**Optional <integer>**
Example: `1`
Default: `10`
Duration (minutes). 

seconds
    
**Optional <integer>**
Example: `30`
Default: `0`
Duration (seconds). 

wrap_up_yellow
    
**Optional <integer>**
Default: `60`
Yellow wrap-up time (in seconds from the end). 

wrap_up_red
    
**Optional <integer>**
Default: `15`
Red wrap-up time (in seconds from the end). 

trigger
    
**Optional <string>**
Default: `MANUAL`
Possible values:  `MANUAL`, `LINKED`, `SCHEDULED`
Defines how the timer is triggered (started). Read more: [Timer Triggers](https://stagetimer.io/docs/using-timers/#timer-triggers)

start_time
    
**Optional <string>**
Example: `2023-05-01T08:40:06.463Z`
Default: `null`
Set a hard start time for this cue. Required when `trigger=SCHEDULED`, but otherwise optional. 

start_time_uses_date
    
**Optional <boolean>**
Default: `false`
Determines if the date-part of `start_time` is being used. If `true`, then the the full date is used (e.g. 11 am on Oct 6). But if `false`, the start date is interpreted as today and the date part ignored (e.g. 11 am today). 

finish_time
    
**Optional <string>**
Example: `2023-05-01T08:40:06.463Z`
Default: `null`
Finish time for the cue. Required when `type=FINISH_TIME`, otherwise ignored. 

finish_time_uses_date
    
**Optional <boolean>**
Default: `false`
Determines if the date-part of `finish_time` is being used. If `true`, then the the full date is used (e.g. 11 am on Oct 6). But if `false`, the start date is interpreted as today and the date part ignored (e.g. 11 am today).
```

--------------------------------

### Companion Module Multi-Room Setup

Source: https://stagetimer.io/docs/integration-with-streamdeck-companion

Instructions on configuring the Companion module to control multiple Stagetimer rooms. This involves setting up distinct connections for each room and using connection-specific variables for button actions.

```APIDOC
Companion Module Multi-Room Configuration:
  1. Existing Connection: Locate and rename an existing Stagetimer connection (e.g., `stagetimer-1`).
  2. Add New Connection: Add another Stagetimer API module.
  3. Configure Second Connection:
     - Label: Assign a unique label (e.g., `stagetimer-2`).
     - Room ID: Enter the Room ID for the second room.
     - API Key: Enter the corresponding API key for the second room.
  4. Button Configuration with Variables:
     - Reference connection-specific variables using the label:
       - `$(stagetimer-1:currentTimerName)`
       - `$(stagetimer-2:currentTimerName)`
```

--------------------------------

### Start Timer

Source: https://stagetimer.io/docs/api-v1

Starts or resumes a specific timer within a given room.

```APIDOC
Endpoint: GET https://api.stagetimer.io/v1/start_timer

Description: Start/resume a specific timer in the room.
```

--------------------------------

### Stagetimer.io API Documentation

Source: https://stagetimer.io/docs/output-links

Documentation for the Stagetimer.io API, covering various integrations and functionalities.

```APIDOC
Stagetimer.io API Documentation:

Integrations:
- API (v1): https://stagetimer.io/docs/api-v1/
- Stream Deck & Companion: https://stagetimer.io/docs/integration-with-streamdeck-companion/
- OBS Studio: https://stagetimer.io/docs/integration-with-obs-studio/
- vMix: https://stagetimer.io/docs/integration-with-vmix/
- Atem: https://stagetimer.io/docs/integration-with-atem/
- Zoom: https://stagetimer.io/docs/integration-with-zoom/
- Raspberry Pi: https://stagetimer.io/docs/integration-with-raspberry-pi/
- Embed on Website: https://stagetimer.io/docs/embed-on-website/
```

--------------------------------

### Stagetimer.io API Documentation

Source: https://stagetimer.io/docs/outputs

Documentation for the Stagetimer.io API, covering various integrations and functionalities.

```APIDOC
Stagetimer.io API Documentation:

Integrations:
- API (v1): https://stagetimer.io/docs/api-v1/
- Stream Deck & Companion: https://stagetimer.io/docs/integration-with-streamdeck-companion/
- OBS Studio: https://stagetimer.io/docs/integration-with-obs-studio/
- vMix: https://stagetimer.io/docs/integration-with-vmix/
- Atem: https://stagetimer.io/docs/integration-with-atem/
- Zoom: https://stagetimer.io/docs/integration-with-zoom/
- Raspberry Pi: https://stagetimer.io/docs/integration-with-raspberry-pi/
- Embed on Website: https://stagetimer.io/docs/embed-on-website/
```

--------------------------------

### Import Rundown from CSV

Source: https://stagetimer.io/docs/timers

This section details how to import a show rundown from a CSV file, typically generated from Google Sheets or MS Excel. It explains the process of scanning the document, manually adjusting the structure if needed, and provides a link to a template and a video tutorial.

```APIDOC
Import Rundown:
  Description: Import a show rundown from Google Sheets or MS Excel via CSV.
  Process:
    1. Upload a CSV file containing your show's rundown.
    2. Stagetimer scans the document to recognize its structure.
    3. Manually adjust the structure if recognition is not perfect.
    4. Commit the import to create timers.
  Resources:
    - Template: https://docs.google.com/spreadsheets/d/1kphPOGG9tO_GVdNFoyHGdEyVkTehOErzE60k05VJOFg/template/preview
    - Video Tutorial: https://www.youtube.com/watch?v=dC10v6bt5bY
```

--------------------------------

### Control Timer: Start or Stop

Source: https://stagetimer.io/docs/api-v1

Toggles the state of the highlighted timer (starts if stopped, stops if running) in a given room. Requires a room ID and API key.

```APIDOC
GET https://api.stagetimer.io/v1/start_or_stop

Query parameters:
  room_id (Required, string): ID of the room.
  api_key (Required, string): Your API key.

Response (200):
{
 "ok": true,
 "message": "Timer stopped at `0:00:30",
 "data": {
  "_model": "playback_status",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "timer_id": "63f59467d68bfdeef6b3bfc3",
  "running": false,
  "start": 1677055206453,
  "finish": 1677055206453,
  "pause": 1677055206453,
  "server_time": 1677055206453
 }
}
```

```bash
curl "https://api.stagetimer.io/v1/start_or_stop?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### Output Links (Beta) Management

Source: https://stagetimer.io/docs/output-links

Details on managing and customizing 'Output Links' within Stagetimer.io, including tab management, preview, and customization options.

```APIDOC
Output Links Management:

Access: Click 'Room' > 'Output Links (beta)'

Output Tabs:
- Displays tabs for each output with preview thumbnail and name.
- New rooms include a 'Viewer' output. 'Controller' and 'Operator' outputs are available by default.
- Managing Outputs:
  - Three-dot menu: Rename, duplicate, or delete an output.
  - '+ Add Output' button: Create new customizable outputs.
  - Tabs scroll horizontally.

Preview & Customize:
- Preview section: Static preview with sample data.
- Customize button: Opens layout editor for moving, resizing, styling elements, adding new elements (images, text, progress bars), changing fonts, colors, backgrounds, and configuring timer information display.
- Controller and Operator outputs use fixed layouts and cannot be customized.
- All other outputs are customizable with Premium plans.
```

--------------------------------

### Stagetimer API: Start Timer

Source: https://stagetimer.io/docs/api-v1

Starts a specific timer in a given room. Requires room_id and optionally timer_id or index to target the timer. Returns the updated timer status.

```APIDOC
GET https://api.stagetimer.io/v1/start_timer

Query parameters:

room_id
    
**Required <string>**
Example: `6ADP4P5U`
ID of the room you are targeting. 

timer_id
    
**Optional <string>**
Example: `63f59467d68bfdeef6b3bfc3`
ID of the timer to target in the room. 

index
    
**Optional <integer>**
Example: `2`
Index of a timer or message to target in a room. Note: Index is not zero-based, it starts at 1. Example: To target the second timer from the top, set `index=2`

200 – Response (example)
```
{
 "ok": true,
 "message": "Timer started at 0:01:00",
 "data": {
  "_model": "playback_status",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "timer_id": "63f59467d68bfdeef6b3bfc3",
  "running": false,
  "start": 1677055206453,
  "finish": 1677055206453,
  "pause": 1677055206453,
  "server_time": 1677055206453
 }
}
```
```

```bash
curl "https://api.stagetimer.io/v1/start_timer?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### Stagetimer.io Output Sharing Links

Source: https://stagetimer.io/docs/timers

Provides various links to share the event's output with different stakeholders. Includes links for talent confidence monitors, audience schedules, production staff control, and message moderation.

```APIDOC
Sharing Output Links:
  * Viewer Link (Confidence Monitor): Fullscreen version of the preview, for talent and backstage teams.
  * Controller Link: Full access for production staff and collaborators to manage timers.
  * Agenda Link: Simplified rundown view for the audience, automatically scrolling to the active timer.
  * Moderator Link: For message interaction, like audience questions or social media comments, with full message control but no timer control.
  * Operator Link: Streamlined interface with large buttons for timing controls, optimized for tablets during live productions.
```

--------------------------------

### Stagetimer.io - Creating and Managing Messages

Source: https://stagetimer.io/docs/messages

This section details the process of creating, showing, and hiding messages within the Stagetimer.io controller interface. It covers the basic steps and the toggle functionality of the 'Show' button.

```APIDOC
Controller Interface - Message Management:

1.  **Add a Message**:
    *   Navigate to the 'Messages' section on the Controller page.
    *   Click the "+ Add Message" button.

2.  **Type Message Content**:
    *   Enter the desired text in the provided input field.

3.  **Show/Hide Message**:
    *   Click the "Show" button next to the message.
    *   This button acts as a toggle: clicking it once displays the message on all Viewer screens, and clicking it again hides the message.
```

--------------------------------

### API Documentation - Stagetimer API v1

Source: https://stagetimer.io/docs/submit-questions

Documentation for the Stagetimer API v1, detailing endpoints and functionalities for integrating Stagetimer with other applications and services.

```APIDOC
API v1:
  Description: API for integrating with Stagetimer.
  Endpoints:
    - /api/v1/timers: Manage timers.
    - /api/v1/messages: Manage messages and questions.
    - /api/v1/users: Manage user accounts.
```

--------------------------------

### Stagetimer API: Start or Stop Timer

Source: https://stagetimer.io/docs/api-v1

Toggles the state of a specific timer (starts if stopped, stops if running) in a given room. Requires room_id and optionally timer_id or index to target the timer. Returns the updated timer status.

```APIDOC
GET https://api.stagetimer.io/v1/start_or_stop_timer

Query parameters:

room_id
    
**Required <string>**
Example: `6ADP4P5U`
ID of the room you are targeting. 

timer_id
    
**Optional <string>**
Example: `63f59467d68bfdeef6b3bfc3`
ID of the timer to target in the room. 

index
    
**Optional <integer>**
Example: `2`
Index of a timer or message to target in a room. Note: Index is not zero-based, it starts at 1. Example: To target the second timer from the top, set `index=2`

200 – Response (example)
```
{
 "ok": true,
 "message": "Timer stopped at `0:00:30",
 "data": {
  "_model": "playback_status",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "timer_id": "63f59467d68bfdeef6b3bfc3",
  "running": false,
  "start": 1677055206453,
  "finish": 1677055206453,
  "pause": 1677055206453,
  "server_time": 1677055206453
 }
}
```
```

```bash
curl "https://api.stagetimer.io/v1/start_or_stop_timer?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

--------------------------------

### Stagetimer.io - Message Formatting Options

Source: https://stagetimer.io/docs/messages

Explains the available formatting options for messages in Stagetimer.io, including text styling and display effects. Premium users have additional customization for colors.

```APIDOC
Message Formatting Options:

Available options to enhance message visibility and impact:

*   **Colors**:
    *   Options: White, Green, Red.
    *   Premium users can customize message colors to match branding.
*   **Bold**:
    *   Applies bold formatting to the message text for emphasis.
*   **Uppercase**:
    *   Converts the message text to ALL CAPS.
*   **Flash**:
    *   Makes the message blink several times for increased attention.
*   **Focus**:
    *   Displays the message prominently, overlaying other content on the screen.
```

--------------------------------

### Integrate Stagetimer with Zoom via OBS Studio

Source: https://stagetimer.io/docs/integration-with-zoom

This guide explains how to use OBS Studio to display Stagetimer within a Zoom call. It involves setting up OBS, adding the Stagetimer viewer link as a browser source, and then using the OBS Virtual Camera in Zoom.

```Guide
1. Download and Install OBS Studio from [https://obsproject.com/](https://obsproject.com/).
2. Create a new Scene in OBS Studio and add a 'Browser' Source.
3. Copy your Stagetimer viewer link from the Stagetimer application.
4. Paste the Stagetimer link into the URL field of the 'Browser' Source properties in OBS. Set width to 1280 and height to 720.
5. Enable 'Control Audio via OBS' if you want to use audio chimes.
6. Resize the Browser Source in the OBS Preview window to fill the screen.
7. Click 'Start Virtual Camera' in OBS.
8. In Zoom, enable 'Join from your browser'.
9. Start your Zoom meeting and copy the invite link.
10. Open the invite link in a Chrome browser and select 'Join from your browser'.
11. Allow camera access and select 'OBS Virtual Camera' as your camera source in Zoom.
12. Click to join the call. Avoid running the Zoom app and Stagetimer Virtual Camera from the same computer without managing audio to prevent echoes.
```

--------------------------------

### Output Links (Beta) Management

Source: https://stagetimer.io/docs/outputs

Details on managing and customizing 'Output Links' within Stagetimer.io, including tab management, preview, and customization options.

```APIDOC
Output Links Management:

Access: Click 'Room' > 'Output Links (beta)'

Output Tabs:
- Displays tabs for each output with preview thumbnail and name.
- New rooms include a 'Viewer' output. 'Controller' and 'Operator' outputs are available by default.
- Managing Outputs:
  - Three-dot menu: Rename, duplicate, or delete an output.
  - '+ Add Output' button: Create new customizable outputs.
  - Tabs scroll horizontally.

Preview & Customize:
- Preview section: Static preview with sample data.
- Customize button: Opens layout editor for moving, resizing, styling elements, adding new elements (images, text, progress bars), changing fonts, colors, backgrounds, and configuring timer information display.
- Controller and Operator outputs use fixed layouts and cannot be customized.
- All other outputs are customizable with Premium plans.
```

--------------------------------

### StageTimer API: Get All Timers

Source: https://stagetimer.io/docs/api-v1

Retrieves all timers associated with a specific room. Requires room_id and api_key.

```APIDOC
GET https://api.stagetimer.io/v1/get_all_timers

Query parameters:

room_id
    
Required <string>
Example: `6ADP4P5U`
ID of the room you are targeting.

Request (example):
```bash
curl "https://api.stagetimer.io/v1/get_all_timers?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

200 – Response (example):
```json
{
 "ok": true,
 "message": "Timers loaded",
 "data": [
  {
   "_id": "63f59467d68bfdeef6b3bfc3",
   "_model": "timer",
   "_updated_at": "2023-05-01T08:40:06.463Z",
   "name": "Timer 1",
   "speaker": "Thomas",
   "notes": "Very tall, remember to adjust camera angle",
   "labels": [
    {
     "name": "VT",
     "color": "#F44336"
    }
   ],
   "appearance": "COUNTDOWN",
   "type": "DURATION",
   "duration": "0:01:00",
   "hours": 0,
   "minutes": 1,
   "seconds": 30,
   "wrap_up_yellow": 60,
   "wrap_up_red": 15,
   "trigger": "MANUAL",
   "start_time": "2023-05-01T08:40:06.463Z",
   "start_time_uses_date": false,
   "finish_time": "2023-05-01T08:40:06.463Z",
   "finish_time_uses_date": false
  },
  "..."
 ]
}
```
```

--------------------------------

### Output Link Options

Source: https://stagetimer.io/docs/outputs

Configuration options for Output Links, including permanent settings and link-specific settings.

```APIDOC
Output Link Options:

Output Options (Permanent Settings):
- Password Protection: Set a password for viewers. Can be changed or removed.

Link Options (Link-Specific Settings):
- Identifier: Set a custom device name for the 'Connected Devices' list.
- Mirror: Flip display horizontally, vertically, or both.
- Delay: Add a delay in seconds for sync purposes.
- Timezone: Override the room's timezone for the specific output.
- Hide Controls Overlay: Hide control buttons that appear on hover.

Note: Controller and Operator outputs only show password and identifier options due to fixed layouts.
```

--------------------------------

### StageTimer API: Next Timer

Source: https://stagetimer.io/docs/api-v1

Highlights the next timer in the list. Optionally, can automatically start the next timer.

```APIDOC
GET https://api.stagetimer.io/v1/next

Description: Highlight the next timer in the list. Optionally, you can automatically start the next timer once it's highlighted.

Query parameters:
- room_id (Required <string>): ID of the room you are targeting. Example: `6ADP4P5U`
- autostart (Optional <boolean>): Set to `true` to automatically start the timer after the action is triggered. Default: `false`

Request (example):
```bash
curl "https://api.stagetimer.io/v1/next?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```

200 – Response (example):
```json
{
 "ok": true,
 "message": "Next timer _Timer 1_ selected (`0:05:00`)",
 "data": {
  "_model": "playback_status",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "timer_id": "63f59467d68bfdeef6b3bfc3",
  "running": false,
  "start": 1677055206453,
  "finish": 1677055206453,
  "pause": 1677055206453,
  "server_time": 1677055206453
 }
}
```
```

--------------------------------

### Output Link Options

Source: https://stagetimer.io/docs/output-links

Configuration options for Output Links, including permanent settings and link-specific settings.

```APIDOC
Output Link Options:

Output Options (Permanent Settings):
- Password Protection: Set a password for viewers. Can be changed or removed.

Link Options (Link-Specific Settings):
- Identifier: Set a custom device name for the 'Connected Devices' list.
- Mirror: Flip display horizontally, vertically, or both.
- Delay: Add a delay in seconds for sync purposes.
- Timezone: Override the room's timezone for the specific output.
- Hide Controls Overlay: Hide control buttons that appear on hover.

Note: Controller and Operator outputs only show password and identifier options due to fixed layouts.
```

--------------------------------

### StageTimer API: Get Message

Source: https://stagetimer.io/docs/api-v1

Retrieves a specific message from a room using its room_id and optionally message_id or index.

```APIDOC
GET https://api.stagetimer.io/v1/get_message

Query parameters:

room_id (Required <string>): ID of the room you are targeting. Example: `6ADP4P5U`
message_id (Optional <string>): ID of the message to target in the room. Example: `e5f46622be82fdaa44bba54c`
index (Optional <integer>): Index of a timer or message to target in a room. Note: Index is not zero-based, it starts at 1. Example: To target the second timer from the top, set `index=2`

200 – Response (example):
{
 "ok": true,
 "message": "Message loaded",
 "data": {
  "_id": "e5f46622be82fdaa44bba54c",
  "_model": "message",
  "_updated_at": "2023-05-01T08:40:06.463Z",
  "showing": false,
  "text": "Question for the speaker: [...]",
  "color": "white",
  "bold": false,
  "uppercase": false
 }
}
```

```bash
curl "https://api.stagetimer.io/v1/get_message?room_id=YOUR_ROOM_ID&api_key=YOUR_API_KEY"
```
Tokens:
Raw