Advanced Options (URL Parameters)
Understanding URL parameters and custom settings
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 Broadcaster Software]). 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.
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=streamidcould be amended to
https://vdo.ninja/?view=streamid&videobitrate=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
streamidat a video bitrate of 500-kbps and set the
You might notice the stream ID values I'm using (ie:
bbb, etc); these can be manually created and reused. Use
&push=STREAMIDto publish a video and
&view=STREAMIDto 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.
All of the available parameters can be seperated in five categories. You find the category on the top of the page of a parameter.
- Meshcast Option (
&meshcast) These parameters can only be used in combination with
&meshcast. You can find them in Meshcast Parameters. These parameters are always Sender-Side Option, so you will find
&pushin the URL, too.
We've broken down the available URL parameters into 19 categories:
- Setup Parameters (stream ID, create a room, password, labels, groups, devices, auto-start, welcoming guests, sharing a website/file)
- Video Parameters (resolution, FPS, effects, self preview, mute video, PTZ, codec, buffer, broadcasting, scale)
- Settings Parameters (language, save cookies, remote access, chat widget, chunked mode, raise hands, notify, transcription, closed captions)
- Buttons and Control Bar Parameters (show/hide buttons, adjust the user control bar and video control bar)
- Design Parameters (labels, styles, clean output, CSS, mirroring, margin, dark mode, background color, disable tallies, etc.)
- Mixer/Scene Parameters (layout and design for the video mixer in rooms/scenes, preload/hidden scene bitrate)
- Meshcast Parameters (options for the
&meshcastparameter like audio filters, bitrate, screen-share, codecs, etc.)
You can search for specific commands using the search bar at the top-right as well.
Last modified 4mo ago