Advanced Options (URL Parameters)

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 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.

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=streamid could 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 streamid at a video bitrate of 500-kbps and set the &stereo parameter to 1:

http://vdo.ninja/?view=streamid&videobitrate=500&stereo=1

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:

http://vdo.ninja/?push=aaa&view=bbb,ccc,ddd

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.

General/Sender/Viewer Option

All of the available parameters can be seperated in five categories. You find the category on the top of the page of a parameter.

• General Option (&push, &room, &view, &scene, &solo, &director) You can use these parameters as a sender or as a viewer as well as in scenes, solo-links and rooms or even as a director.

• Sender-Side Option (&push) You can use these parameters as a sender when you are publishing a video with &push. You can use these parameters in rooms (&room) when publishing or as a basic push link outside a room. These parameters will affect the outgoing stream.

• Viewer-Side Option (&view, &scene, &room, &solo) You can use these parameters as a viewer of one or more video sources (scenes and solo-links in a room, as a guest in a room, or a basic &view stream). These parameters will affect the incoming stream(s).

• Director Option (&director) These parameters are specifically for the director of a room.

• 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 &push in the URL, too.

• WHIP Option (WHIP and WHEP tooling) WHIP Parameters are specific to WHIP and WHEP. You can find them in WHIP Parameters.

Navigating the available setting options

We've broken down the available URL parameters into 22 categories:

• Most common Parameters (the basic and most common parameters)

• Setup Parameters (stream ID, create a room, password, labels, groups, devices, auto-start, welcoming guests, sharing a website/file)

• Camera Parameters (options to pre-set the camera settings)

• Video Parameters (resolution, FPS, effects, self preview, mute video, PTZ, codec, buffer, broadcasting, scale)

• Video Bitrate Parameters (changing the bitrate of the outgoing and incoming video and for rooms)

• Audio Parameters (filters, adding delay, bitrate, channels, mono/stereo, muting guests, etc.)

• 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)

• Director Parameters (specific to the director's control room and director-specific features)

• Screen-share Parameters (labels, audio filters, type, bitrate, quality, etc.)

• Recording Parameters (options to specify recordings with VDO.Ninja)

• Guest queuing Parameters (options for guest queuing and approving system)

• Meshcast Parameters (options for the &meshcast parameter like audio filters, bitrate, screen-share, codecs, etc.)

• WHIP Parameters (options to specify the &whip parameter)

• Mobile Parameters (options to specify push links and guest invite links for mobile phones)

• API & MIDI Parameters (hotkey features via API and MIDI)

• TURN & STUN Parameters (options for setting up TURN and STUN servers)

• Parameters added in Version 24 (recently added to VDO.Ninja)

• Upcoming Parameters (only on VDO.Ninja/beta and/or VDO.Ninja/alpha version at the moment)

• Other Parameters (not ready for production, not intended to be used or not well-documented)

You can search for specific commands using the search bar at the top-right as well.