Ninja Docs
Search…
Misc options
Platform Specific Issues
Newly Added Parameters
Powered By GitBook
Advanced Options
Understanding URL parameters and custom settings

Overview

VDO.Ninja is a tool that can be seen as a mediator, negotiating a direct connection between a publishing device and a viewing device (such as OBS (Open Broadcasting Studio)). There are generally two links involved; one to push (publish) and one to pull (view), although links can be made to do both at the same time.
The viewer (receiver) and the publisher (sender) each play their own role in determining the qualities of a stream, so likewise each side has its own set of parameters available to them. A publisher can have multiple viewers access their video stream, with each viewer having the ability to customize the quality of the stream they receive.
The following guide details the options, syntax, values, and general use of these available settings/parameters; organized into three sections.

Passing parameters via the URL to achieve your desired stream settings

You can customize the playback of videos by adding query string parameters to the VDO.Ninja URL links, along with many other aspects. VDO.Ninja is highly flexible in this regard, letting you achieve your desired outcome without needing to code and without additional software.
For example, a simple viewer URL link such as https://vdo.ninja/?view=xxxxxxx could be amended to https://vdo.ninja/?view=xxxxxxx&bitrate=500, which will cause the viewer to receive the publisher's video stream at a video bitrate of 500-kbps.
Multiple parameters can be appended together by using the ampersand (&) as a separating character. For example, to view the video stream published at stream ID xxxxxxx at a video bitrate of 500-kbps and set the stereo parameter to 1:
1
http://vdo.ninja/?view=xxxxxxx&bitrate=500&stereo=1
Copied!
Some parameters, like view will accept a comma-separated list of valid values, so you can do some rather powerful combos, such as publish a video (using push) while also viewing multiple others videos. VDO.Ninja will auto-mix the videos together into a single layout for you:
1
http://vdo.ninja/?push=aaa&view=bbb,ccc,ddd
Copied!
You might notice the stream ID values I'm using (ie: aaa, bbb, etc); these can be manually created and reused. Use &push=STREAMID to publish a video and &view=STREAMID to remotely view it. If you don't manually specify a stream ID, VDO.Ninja will sometimes generate one for you.
To make up a valid stream ID of your own though, choose something with less than 31-characters of length and ensure it's AlpHaNuMerIc-only.
A stream ID must also not already be in active use, else you will be provided with an error.

Navigating the available setting options

We've broken down the available URL parameters into four parts
    General Settings, which tend to settings that impact the app broadly, such as the color of the background
    Source Settings, which are settings specific to publishing, so these are things related to customizing the camera and microphone.
    Viewer Settings, which are aspects that are controllable by the viewer's side, which includes bitrate, codec, and layouts.
    Director Settings, which are specific to the director's control room and director-specific features.
You can normally find a long list of each command in the left-hand menu of this support system, although you can search for specific commands using the search bar at the top-right as well.
Last modified 4mo ago