Hotkey and API support

Ninja Docs

Search…

What is VDO.Ninja?

Getting started

Advanced Options (URL Parameters)

Releases

Help!

Common errors and known issues

Platform specific issues

Important Links

FAQ

Edit this documentation

Redirect

Redirect 2

Hotkey and API support

Some keyboard hotkeys

Basic hotkeys
CTRL + M => Mute your mic (audio output)
CTRL + B => Mute your video output
SHIFT + ALT + C => Toggle the control bar that's normally at the bottom of the screen.
CTRL + ALT + F => Open the file-sharing window
CTRL + ALT + C => Cycle the camera to the next camera available
CTRL + ALT + S => Open the screen-sharing window
[On macOS use CMD instead of CTRL]
When using the above keyboard short-cuts, the tab/window must be actively in focus.
When using the Electron Capture app in elevated privilege mode, the keyboard shortcuts are global.
MIDI hotkeys
There are numerous more hotkeys that can be used via MIDI; these are global hotkeys, used even if the window is not visible, but they require some additional setup. You can remotely control via MIDI also, using the &midiout and &midiin routing functionality. 
MIDI hotkeys are compatible with an Elgato Streamdeck by means of a free Streamdeck MIDI plugin.
&midi
Bitfocus Companion
There is also Bitfocus Companion control compatibility, available here: https://github.com/bitfocus/companion-module-vdo-ninja​
HTTP / Websocket API
The Bitfocus Companion plugin makes use of a HTTP and Websocket API, that allows for lots of remote control functionality.
There is a website that demos some of the commands available here: https://companion.vdo.ninja/ Details on the API itself is here: https://github.com/steveseguin/Companion-Ninja​
You can use this to create your own hotkeys for pretty any device, application, or website.
&api
IFRAME API
The HTTP and websocket make use of a server to route API calls. If you'd like to create your own API server or don't need remote hotkey support, you can used the provide IFRAME API and send commands instead to VDO.Ninja via an IFRAME wrapper. 
The IFRAME API is the most powerful option, but it requires some basic coding on your own part to have it provide hotkey functionality for your specific requirement.
Embed into a site with iFrames
WebHID
There is also webHID support, but it's not fully implemented at this time. User requests are welcomed though and there's a demo here: https://vdo.ninja/webhid
It should be improved upon in the future, assuming the feature does not get depreciated by the browser first.
Feature requests and feedback
It's easy enough to add new hotkeys or features; please make a request as needed. The hotkey and API commands are organically development, based on user needs and feedback. Most simple requests can be accommodated within minutes.

Connecting smartphone to computer via USB

API commands

Last modified 4mo ago

Copy link

Contents