API Introduction
The API request type for COEX is HTTP. In online mode, the controller IP is the actual device IP, with port number 8001. In offline mode, the controller IP is 127.0.0.1, and the port number is 10001.
Users can integrate the API into other software to control the device. This document primarily introduces how to use third-party software Companion to call the API interface for device control.
Prerequisites
Before calling the APIs, it is necessary to ensure the following environment:
Ensure proper communication between the PC and the device.
Make sure that the device is not being occupied by VMP (we recommend clicking on a blank space in the device list to release the device).
Basic Steps for Use
Open a API tool of your choice.
Find the information for the API you need to use.
Call the API according to the documentation.
Companion Introduction
Bitfocus Companion is a middleware software designed for Elgato Stream Deck that controls broadcast equipment via Ethernet. It serves as a centralized control solution for various professional devices (such as vision mixers, audio consoles, video matrices, PTZ cameras, lighting controllers, etc.), while also supporting generic devices (like smart plugs, computer keyboard/mouse emulation, PLCs, etc.).
Elgato Stream Deck is a customizable button panel. Notably, Bitfocus Companion does not strictly require a Stream Deck for operation. Users can alternatively access its web interface to turn other LAN-connected devices (e.g., computers, smartphones, or tablets) into control panels. For advanced integration, OSC (Open Sound Control) or WebSocket protocols allow third-party software to send commands through Companion to managed devices.
