Ninja Docs
Search…
What is VDO.Ninja?
Getting started
Steve's helper apps & tools
Guides
Advanced Options (URL Parameters)
Most common Parameters
Setup Parameters
Video Parameters
Audio Parameters
Settings Parameters
Mixer/Scene Parameters
Design Parameters
Director Parameters
Screen-share Parameters
Meshcast Parameters
API & MIDI Parameters
&api
&pie
&midi
&midiin
&midiout
&midiremote
&midichannel
&mididevice
&midioffset
&datamode
TURN & STUN Parameters
Newly Added Parameters
Upcoming Parameters
Other Parameters
Releases
Development Progress
Help!
Common errors and known issues
Platform specific issues
Useful Links
FAQ
Sponsor ❤
Edit this documentation
Redirect
Redirect 2
Powered By GitBook
&api
Remote control API (HTTP-GET / WSS-based)
General Option! (&push, &room, &view, &scene)

Aliases

  • &osc

Options

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

Previous
API & MIDI Parameters
Next
&pie
Last modified 3mo ago
Copy link
Outline
Aliases
Options
Details
Related