The Web API feature in Composer enables external application control using HTTP or WebSockets. This allows third-party applications, automation scripts, and custom integrations to interact with and control Composer remotely.
.png)
Web API Settings
These settings control the primary HTTP API functionality.
| Setting | Description |
|---|---|
| Enable Web API | Enables or disables the HTTP API. When enabled, Composer listens for incoming HTTP requests on the configured port. |
| Web API listening port | The TCP port number on which the Web API listens for incoming HTTP requests. |
| Web API Https FQDN | The Fully Qualified Domain Name (FQDN) used for HTTPS connections. Configure this when you need secure HTTPS access to the API. |
| Disable Web API when project not running | When enabled, the Web API will only respond to requests while a project is actively running. This prevents API access when Composer is idle. |
Connectors
Connectors allow you to define automated actions that can be triggered via the API. This section controls how connector invocations are handled.
Connector Behaviour
Controls how Composer handles multiple connector invocations.
| Option | Description |
|---|---|
| Default (always allow connectors to be invoked) | No restrictions. Multiple connectors can be invoked simultaneously without any warnings or limitations. |
| Warn on invoke while a connector is running | Displays a warning when attempting to invoke a connector while another connector is already running, but still allows the invocation. |
| Warn and prohibit invoke while a connector is running | Displays a warning and prevents invoking a new connector while another connector is currently running. |
| On invoke, stop already running connectors | When a new connector is invoked, any currently running connectors are automatically stopped before the new one begins. |
WebSockets
WebSockets provide real-time, bidirectional communication between Composer and external applications. This is ideal for scenarios requiring live updates or continuous data streams.
Read more about the WebSocketAPI and explore our examples and other configuration snippets to help you get started.
| Setting | Description |
|---|---|
| Enable WebSockets | Enables or disables WebSocket communication. When enabled, Composer accepts WebSocket connections on the configured hostname and port. |
| Hostname | The hostname or IP address on which the WebSocket server listens for connections. |
| Port | The TCP port number for WebSocket connections. |
| Throttled properties update frequency | Controls how often property updates are sent to connected WebSocket clients. See frequency options below. |
| Max message queue length (1-500) | The maximum number of incoming messages that can be queued for processing. Valid range: 1 to 500. Higher values allow for more buffering but consume more memory. |
Throttled Properties Update Frequency Options
This setting controls the rate at which property updates are broadcast to WebSocket clients. Lower frequencies reduce network traffic and CPU usage but result in less frequent updates.
| Option | Description |
|---|---|
| Default (Composer decides) | Composer automatically determines the optimal update frequency based on system performance. |
| Every frame | Updates are sent every frame (highest frequency, most network traffic). |
| Every second frame | Updates are sent every 2nd frame. |
| Every third frame | Updates are sent every 3rd frame. |
| Every 4th frame | Updates are sent every 4th frame. |
| Every 5th frame | Updates are sent every 5th frame. |
| Every 10th frame | Updates are sent every 10th frame. |
| Every 20th frame | Updates are sent every 20th frame. |
| Every 30th frame | Updates are sent every 30th frame (lowest frequency, least network traffic). |
Quick Start
Open Settings from the Composer menu
Navigate to the Web API tab
Check Enable Web API to activate HTTP API access
Configure the listening port (default port may vary)
Optionally enable WebSockets for real-time communication
Click OK to save settings
Restart Composer for changes to take effect
Use Cases
Remote Control: Trigger scene changes, adjust parameters, or control playback from external applications
Automation: Integrate Composer into automated workflows and scheduling systems
Custom Interfaces: Build custom control panels or dashboards that interact with Composer
Live Production: Enable real-time control during live broadcasts or events
Monitoring: Use WebSockets to receive real-time status updates and property changes