The Mavis Camera API lets external applications communicate with and control Mavis Camera over a local network. It provides access to many of the same controls and information available within the app, allowing Mavis Camera to become part of a larger production system or custom workflow.
Communication happens over a WebSocket connection. Once connected, another application can send commands to Mavis Camera - for example, to start or stop recording, change exposure, adjust focus, select a lens, control tally, or modify the camera’s colour grade. The API can also report the current state of the camera and send live updates when values change.
The API is designed to be discoverable rather than relying on a fixed set of capabilities. An application can ask Mavis Camera what commands, settings and state information are currently available. This means the API can describe the capabilities of the particular device and camera configuration it is connected to, including the values and ranges that are valid at that moment.
At its simplest, this means you can connect another device to Mavis Camera and control it remotely. At a more advanced level, the API can be used to integrate Mavis Camera with production systems, hardware controllers, automation tools, custom user interfaces, or your own applications.
You don’t need to build anything to see how it works. Mavis Camera includes API Playground, a website served directly from the app that lets you explore, control the API and have a go directly from a web browser.
Have a go
You'll need Mavis Camera running on an iPhone and a Mac, iPad, or another device with a web browser connected to the same local network.
1. Turn on API Playground
- Open Settings in Mavis Camera.
- Open API.
- Turn on Enable API Access.
- Turn on API Playground.
2. Open the Playground
Open URLs and copy the API Playground URL.
Open the URL in a web browser on your Mac, iPad, or another device on the same network. Keep Mavis Camera open in the foreground on the iPhone while you're using the Playground.
3. Start controlling Mavis Camera
That's it. The API Playground website gives you controls for the API features available on the camera, so you can start experimenting straight away.
Try changing camera settings, controlling focus or exposure, showing color bars, or starting and stopping a recording. You'll see the changes happen immediately in Mavis Camera.
Ready to build something?
Once you've had a go with API Playground, see API Details for information about connecting your own application, API keys, commands, events, discovery, and the complete API reference.