Complete List of Parameters in v26

A complete list of URL parameters, although not documented

This is a near-complete list of all the URL parameters within VDO.Ninja, up until v26.2. It does not offer help in explaining what a parameter does, as it's provided purely as a technical reference.

This list is not exhaustive, it may have flawed descriptions, and it does not offer links or specifics. Please refer to other support material in the documentation for details on how certain parameters actually work. If a parameter below is not found in the rest of the documentation, please refer to the code directly. This list is AI-generated, based on the contents of the main.js file, which you can refer to on the Github. Searching through the lib.js file also will help provide added detail into any function calls the parameters are calling. Using an LLM with a sufficiently large context-window can help explain the code, as well as nearly any function, so give that a try if stuck.

If you are self-hosting VDO.Ninja, often these URL parameters can be hard-coded to have a certain value without needing URL parameters. Please refer to the main.js file as well for a sense of what needs to be done to accomplish that though.

A

Parameter
Aliases
Values
Description

action

-

-

-

ad

See audiodevice

-

-

addstun

-

String (format: username;password;url)

Adds additional STUN server

ado

See audiodevice

-

-

adevice

See audiodevice

-

-

ag

See autogain

-

-

agc

See autogain

-

-

alertvolume

-

0-100

Sets volume for alert sounds

alpha

-

Boolean

-

am

See automute

-

-

apiserver

-

URL

Sets custom API server

ar

See aspectratio

-

-

aspectratio

ar

Number/String (portrait,landscape,square)

Sets aspect ratio

audience

-

String

-

audiobitrate

-

Integer (kbps)

Sets audio bitrate

audiocontenthint

audiocontent, audiohint

String

Sets audio content processing hint

audiodevice

adevice, ad, device, d, ado

Device ID/name or 0/false/no/off

Selects audio input device

audioeffects

-

Boolean

Enables audio effects processing

autoadd

-

Stream ID(s) (comma-separated)

Auto-adds specified streams

autogain

ag, agc

Boolean

Controls automatic gain control

automute

am

Boolean

Enables automatic audio muting

autorecord

-

Boolean/Integer

Starts recording automatically

autorecordlocal

-

Boolean/Integer

-

autorecordremote

-

Boolean/Integer

-

autoreload

-

Integer (minutes)

Auto reloads page after specified minutes

autoreload24

-

Time (HH:MM)

Reloads at specified time

autostart

as

Boolean

Auto starts session

autohide

-

Boolean

-

avatarimg

bgimage, bgimg

URL

Sets avatar/background image

avatarimg2

bgimage2, bgimg2

URL

Sets secondary avatar/background image

avatarimg3

bgimage3, bgimg3

URL

Sets tertiary avatar/background image

B

Parameter
Aliases
Values
Description

background

appbg

URL

Sets application background

base64css

b64css, cssbase64, cssb64

Base64 encoded CSS

Applies custom CSS

base64js

b64js, jsbase64, jsb64

Base64 encoded JS

Applies custom JavaScript

batterymeeter

-

Boolean

Shows battery meter

beep

notify, tone

Boolean

Enables notification sounds

beepvolume

-

0-100

Sets volume for beep sounds

bgimage

See avatarimg

-

-

bgimage2

See avatarimg2

-

-

bgimage3

See avatarimg3

-

-

bgimg

See avatarimg

-

-

bgimg2

See avatarimg2

-

-

bgimg3

See avatarimg3

-

-

bigbutton

-

String

Shows large mute button with text

bitrate

-

Integer (kbps)

Sets video bitrate

bitratecutoff

bitcut

Integer

Sets bitrate cutoff threshold

blackout

blackoutmode, bo, bom

Boolean

-

blur

-

Integer (1-10)

Sets background blur amount

bc

See broadcast

-

-

bct

See broadcasttransfer

-

-

broadcast

bc

Boolean

Enables broadcast mode

broadcasttransfer

bct

Boolean

-

buffer

-

Number

Sets buffer delay

buffer2

-

Number

Alternative buffer setting

bundle

-

String

Sets bundle policy

bypass

-

Boolean

-

C

Parameter
Aliases
Values
Description

cb

See chatbutton

-

-

cbr

-

Boolean

Enables constant bitrate

cc

See closedcaptions

-

-

cccolored

cccoloured, coloredcc, colorcc, cccolor

Boolean

Enables colored closed captions

cftoken

cft

String

-

channelcount

ac, inputchannels

Integer

Sets number of audio channels

channeloffset

-

Integer

-

chat

See chatbutton

-

-

chatbutton

chat, cb

Boolean

Shows chat button

chroma

-

Color code

Sets chroma key color

chunked

chunk

Integer

Sets chunked transfer size

chunkedbuffer

sendingbuffer

Integer

Sets chunk buffer size

clean

See cleanoutput

-

-

cleanoutput

clean

Boolean

Minimizes UI elements

cleanish

-

Boolean

-

cleanstorage

clear

Boolean

Clears stored settings

clock

clock24

0-9

Shows clock with position

closedcaptions

cc, captions

Boolean

Enables closed captions

codec

codecs, videocodec

String

Sets video codec

codirector

See directorpassword

-

-

compressor

comp

Boolean/Integer

Audio compression settings

consent

-

Boolean

-

contenthint

contenttype, content, hint

String

Sets content processing hint

controlbarspace

-

Boolean

-

controls

videocontrols

Boolean

Shows video controls

controlroombitrate

crb

Boolean

-

cover

-

Boolean

Sets cover mode for video

crop

-

Integer (-100 to 100)

Sets video crop

css

-

URL

Applies external CSS

D

Parameter
Aliases
Values
Description

d

See audiodevice/videodevice

-

-

darkmode

nightmode, darktheme

Boolean

Enables dark theme

deaf

deafen

Boolean

-

defaultlabel

labelsuggestion, ls

String

Sets default label

delay

See micdelay

-

-

denoise

dn

Boolean

Controls noise suppression

device

See audiodevice/videodevice

-

-

director

dir

String/Boolean

Enables director mode

directorchat

dc

Boolean

-

directorpassword

dirpass, dp, codirector

String

Sets director password

directorview

dv

Boolean

-

displaysurface

-

String

-

dp

See directorpassword

-

-

dpi

dpr

Number

Sets display pixel ratio

drawing

-

Boolean

-

dtx

usedtx

Boolean

-

dv

See directorview

-

-

E

Parameter
Aliases
Values
Description

e2ee

-

Boolean

Enables end-to-end encryption

ec

See echocancellation

-

-

echocancellation

aec, ec

Boolean

Controls echo cancellation

effect

effects

String/Integer

Applies video effects

effectvalue

ev

Number

Sets effect intensity

electronic

-

Boolean

-

enhance

-

Boolean

-

entrymsg

welcome

String

Sets welcome message

equalizer

eq

Boolean

Enables audio equalizer

exclude

ex

Stream ID(s)

Excludes specified streams

excludeaudio

exaudio, silence

Stream ID(s)

-

experimental

-

Boolean

Enables experimental features

exposure

-

Number

Sets camera exposure

F

Parameter
Aliases
Values
Description

facingmode

-

String (user/environment)

Sets camera facing mode

fadein

-

Number/Boolean

Sets fade in effect

fakeguests

fakefeeds, fakeusers

Integer

-

fb

See feedbackbutton

-

-

feedbackbutton

fb

Boolean/Number

Shows feedback button

fileshare

fs

Boolean

Enables file sharing

fit

-

Boolean

Sets fit mode for video

fl

See forcelandscape

-

-

flagship

-

Boolean

-

flip

-

Boolean

Flips video

focus

-

Number

Sets camera focus

forceios

-

Boolean

-

forcelandscape

forcedlandscape, fl

Boolean

Forces landscape orientation

forceportrait

forcedportrait, fp

Boolean

Forces portrait orientation

forceviewerlandscape

-

Integer

-

forceviewerportrait

-

Integer

-

fp

See forceportrait

-

-

frameRate

fr, fps

Integer

Sets frame rate

fs

See fileshare

-

-

fsb

See fullscreenbutton

-

-

fullhd

-

Boolean

Enables 1080p quality

fullscreen

-

Boolean

Enables fullscreen mode

fullscreenbutton

fsb

Boolean

Shows fullscreen button

G

Parameter
Aliases
Values
Description

ga

See groupaudio

-

-

gain

See audiogain

-

-

gate

See noisegate

-

-

gating

See noisegate

-

-

gdrive

-

Boolean

-

gm

See groupmode

-

-

group

groups

String(s)

Sets group membership

groupaudio

ga

Boolean

-

groupmode

gm

Boolean

-

groupview

viewgroup, gv

String(s)

Sets group view

gv

See groupview

-

-

H

Parameter
Aliases
Values
Description

h

See height

-

-

h264profile

-

String

Sets H264 profile

hands

hand

Boolean

-

hangupbutton

hub, humb64

Boolean

Shows hangup button

hangupmessage

hum, humb64

String

Sets hangup message

height

h

Integer

Sets video height

hh

See hideheader

-

-

hidecodirector

hidedirector

Boolean

Hides director controls

hidecursor

See nocursor

-

-

hideheader

noheader, hh

Boolean

Hides header

hidemouse

See nocursor

-

-

hidesolo

hs

Boolean

-

hidescreenshare

hidess, sshide

Boolean

Hides screen share option

hint

See contenthint

-

-

holdercolor

-

Color code

-

host

-

Boolean

-

hotkeys

See midi

-

-

hs

See hidesolo

-

-

hub

See hangupbutton

-

-

hum

See hangupmessage

-

-

humb64

See hangupmessage

-

-

I

Parameter
Aliases
Values
Description

icefilter

-

String

Sets ICE filter

id

See push

-

-

iframe

See website

-

-

iframetarget

-

String

Sets iframe target

imagelist

-

JSON array

Sets list of background images

include

-

Stream ID(s)

Includes specified streams

insertablestreams

is

Boolean/String

-

intro

ib

Boolean

Shows intro

isolation

voiceisolation, vi

Boolean

-

J

Parameter
Aliases
Values
Description

js

-

URL

Applies external JavaScript

justtalk

-

String

-

K

Parameter
Aliases
Values
Description

keyframe

See keyframeinterval

-

-

keyframerate

See keyframeinterval

-

-

keyframeinterval

keyframerate, keyframe, fki

Integer

Sets keyframe interval

L

Parameter
Aliases
Values
Description

l

See label

-

-

label

l

String

Sets display name

labelsize

sizelabel, fontsize

Integer

Sets label size

lanonly

-

Boolean

-

latency

al, audiolatency

Integer

Sets audio latency

layout

-

JSON/String

Sets video layout

layouts

-

JSON array

L (continued)

Parameter
Aliases
Values
Description

limittotalbitrate

ltb

Number

Sets bitrate limit

locked

-

Number/String (portrait,landscape,square)

Locks aspect ratio

locksize

-

Boolean

-

lowcut

lc, higpass

Integer

Sets low-cut filter frequency

lowbitratescene

cutscene

String

-

lowmobilebitrate

-

Integer

-

M

Parameter
Aliases
Values
Description

maxbitrate

mvb

Integer

Sets maximum bitrate

maxbandwidth

-

Integer (0-200)

-

maxconnections

mc

Integer

Maximum allowed connections

maxframerate

mfr, mfps

Integer

Sets maximum framerate

maxpublishers

mp

Integer

Maximum allowed publishers

maxtotalscenebitrate

mtsb, tsb

Integer

-

maxvideobitrate

-

Integer

-

maxviewers

mv

Integer

Maximum allowed viewers

mc

See maxconnections

-

-

mcaudiobitrate

mcab

Integer

-

mcbitrate

mcb

Integer

-

mccodec

-

String

-

mcscale

meshcastscale

Integer

-

mcscreensharebitrate

mcssbitrate

Integer

-

mcscreensharecodec

mcsscodec

String

-

md

See micdelay

-

-

mediasettings

-

Boolean

Shows media settings

meshcast

-

String

-

meshcastcode

mccode

String

-

meter

meterstyle

Integer

Sets audio meter style

micdelay

delay, md

Integer

Sets microphone delay

mididevice

-

Integer

-

midihotkeys

-

Boolean/Integer

-

midiiframe

-

Boolean

-

midioffset

-

Integer

-

minipreview

mini

Boolean/Integer

Shows mini preview

minipreviewoffset

mpo

Integer (-20 to 120)

-

minroombitrate

mrb

Integer

-

mirror

-

Integer (0-3)

Sets mirror mode

mono

-

Boolean

Forces mono audio

morescenes

-

Integer

-

motionswitch

motiondetection

Integer

-

mp

See maxpublishers

-

-

mrb

See minroombitrate

-

-

mv

See maxviewers

-

-

mvb

See maxbitrate

-

-

N

Parameter
Aliases
Values
Description

na

See noaudio

-

-

ng

See noisegate

-

-

nme

See nomouseevents

-

-

noap

See noaudioprocessing

-

-

noaudio

na, hideaudio

Stream ID(s)

Disables audio for streams

noaudioprocessing

noap

Boolean

Disables audio processing

nocursor

hidecursor, nomouse, hidemouse

Boolean

Hides cursor

nocontrols

-

Boolean

-

nocontrolbar

-

Boolean

-

nodownloads

See nofileshare

-

-

nofec

-

Boolean

Disables forward error correction

nofileshare

nofiles

Boolean

Disables file sharing

nofullscreenbutton

nofsb

Boolean

-

noheader

See hideheader

-

-

nohub

See nohangupbutton

-

-

nohangupbutton

nohub

Boolean

Hides hangup button

noisegate

gating, gate, ng

Boolean/Integer

Sets noise gate

nomouseevents

nme

Boolean

-

nopreview

np

Boolean

Disables preview

nopush

noseed

Boolean

-

noremb

-

Boolean

-

noscale

noscaling

Boolean

Disables scaling

nosettings

ns

Boolean

Hides settings

nostats

-

Boolean

Hides statistics

notios

-

Boolean

-

novideo

nv, hidevideo

Stream ID(s)

Disables video for streams

np

See nopreview

-

-

ns

See nosettings

-

-

nv

See novideo

-

-

O

Parameter
Aliases
Values
Description

oab

See outboundaudiobitrate

-

-

obscontrols

remoteobs, obsremote, obs

Boolean/String

Enables OBS controls

obsfix

-

Boolean/Integer

-

obsoff

oo

Boolean

-

optimize

-

Integer

-

order

-

Integer

-

orderby

-

String

-

orientation

-

String

-

outboundaudiobitrate

oab

Integer

-

outboundvideobitrate

ovb

Integer

-

overlaycontrols

-

Boolean

-

ovb

See outboundvideobitrate

-

-

P

Parameter
Aliases
Values
Description

p

See password

-

-

p0

-

Boolean

-

pan

See panning

-

-

panning

pan

Boolean/String

Sets audio panning

password

pass, pw, p

String

Sets room password

pcm

-

Boolean

-

permaid

See push

-

-

pie

-

String/Boolean

-

pip

-

Boolean

Picture-in-picture mode

pip2

pipall

Boolean

-

pip3

mypip, pipme

Boolean

-

planb

-

Boolean

-

playchannel

-

Integer