For the complete documentation index, see llms.txt. This page is also available as Markdown.

How to control VDO.Ninja with Touch Portal

Controlling VDO.Ninja with Touch Portal using API commands

How to

1. Create a new room as a director, with a custom API key, so that it looks like this: https://vdo.ninja/?api=APIKEY&director=TouchPortalExample Replacing the APIKEY with a string of your choosing.

2. Then, in Touch Portal, add a new button with the HTTP GET action. In the HTTP GET Action GET URL field, input your desired action. This particular GET action will send Guest 1 to Scene 1 with a push of the button: https://api.vdo.ninja/APIKEY/addScene/1/1

Thanks to djlefave on Discord for this guide.

Switching the layout of a scene in OBS

https://api.vdo.ninja/APIKEY/layout/[{"x":0,"y":0,"w":50,"h":100,"c":true,"slot":0},{"x":50,"y":0,"w":50,"h":100,"c":false,"slot":1}]

You can also use Touch Portal to switch the layout of &scene=0 without using the Mixer App.

https://docs.google.com/spreadsheets/d/1cHBTfni-Os3SAITsXrrNJ3qVCMVjunuW3xugvw1dykw/edit#gid=151839312

You can download this google sheet and use it to create your own layouts.

Examples and resources

For more API examples, check out these resources: https://github.com/steveseguin/Companion-Ninja https://companion.vdo.ninja/?api=k8eYrfvJUC

&api

Last updated

Was this helpful?