&api

Remote control API (HTTP-GET / WSS-based)

General Option! (&push, &room, &view, &scene)

Aliases

• &osc

&osc is only a legacy alias for this HTTP/WSS remote API key parameter. VDO.Ninja does not support native OSC protocol input, such as UDP OSC messages from another app. External OSC tools need their own bridge to the HTTP/WSS API.

Options

Example: &api=SomeAPIKey

Value	Description
(key)	API KEY to control VDO.Ninja remotely

Details

You can use this parameter to enable the HTTP/WSS remote control API for VDO.Ninja. You pass a API KEY value to the parameter, and if it matches the remote control's API KEY, then the remote control interface will be able to send commands to your VDO.Ninja session.

You can control guests in the director's room, or you can control your local microphone and camera, as examples.

Please see https://github.com/steveseguin/Companion-Ninja for documentation and details of this command. There is a module for Bitfocus's Companion available, along with HTTP and WSS API endpoints.

Please see https://companion.vdo.ninja for a sample interface to test this command out with. The Companion module is available here: https://github.com/bitfocus/companion-module-vdo-ninja

Related

Basic hotkeysHow to control VDO.Ninja with Touch Portal