Composer provides a WebSocket API for real-time, bidirectional communication between Composer and external applications. This is ideal for scenarios requiring live updates or continuous data streams.
Composer currently exposes WebSocket communication for Inputs & Audio and Log files.
Please refer to Settings - Web API for information on enabling and configuring websockets.
For an overview of the different options for integrating Composer, see the Integration Guide.
Examples
Please refer to the Vindral Composer WebSocket client web application to try it out yourself. It shows how to connect, subscribe, and handle incoming and outgoing messaging.
It is especially useful to help understand how to construct message objects for writing.
Notes
Remote WS access
Due to limitations in the underlying WS-library; the Hostname must be set to the IP address in the Settings - Web API.
Using secure WebSockets
In order to use secure websockets (WSS); use our (Docker) nginx proxypass solution.