Setup Parameters

Stream ID, create a room, password, labels, groups, devices, auto-start, welcoming guests, sharing a website/file

They are separated in two groups: general options (push and view) and source side (push) options.

General options

You can add them to both, source (&push) and viewer (&view, &scene or &solo) sides.

Parameter	Explanation
&push	The stream ID that you are publishing with will be the defined value
&room	Sets a room ID for the session to join
&password	Sets a password to view a stream or to join a room
&hash	Checks the password
&e2ee*	Support for something called "end to end encryption" using "insertable streams"
&label	Sets a display name label
&labelsuggestion	The same as &label, except it asks the user still for a user name
&permaid	Will save that stream ID to local storage and reuse it every time &permaid is used without a stream ID
&group	Puts guests into sub-groups, so they only see others in the same group
&groupaudio	Tells the system to not filter out audio streams when using &group
&groupview	The same as &group, except it lets you see those groups without actually needing to join them with your mic/camera
&datamode	Combines a bunch of flags together; no video, no audio, GUI, etc.
&audiooutput	Like &sink, but selects the audio output device
&sink	Outputs the audio to the specified audio output device, rather than the default

*NEW IN VERSION 24

Source side options

You have to add them to the source side (&push).

Parameter	Explanation
&audiodevice	Pre-configures the selected audio device
&videodevice	Pre-configures the selected video device
&vdo	Like &videodevice for selecting a default video device, but you can still choose to change the camera
&device	Same as &audiodevice or &videodevice, but applies to both
&miconly	Share audio-only; no video publishing allowed
&miconlyoption	A mic only button shows if a guest joining a room
&safemode	Tries to load the camera/audio with as little possible complexity as possible
&autostart	Skips the camera/audio device or screenshare selection
&easyexit	Won't ask the user to confirm that they wish to exit or leave the page
&webcam	Disables screen-sharing as an option
&webcam2	Will show the "Share your Camera" button before asking the user to select camera options
&screenshare	Disables camera-sharing as an option
&screenshare2	Will show the "Share your Screen" button before asking the user to select screenshare options
&website	Only shares a website with viewers
&fileshare	Allows the user to select a video or audio file as a source for streaming
&intro	When combined with the either &webcam or &screenshare, this option won't auto-load the camera/mic selection page
&host	Shows a pop up to invite more guests to the room
&tips	Shows a help-screen on the guest joining
&welcome	Adds a message the guest will see when joining the room
&welcomeb64*	The same as &welcome, except this takes an input as a base64 encoded string
&welcomeimage	Lets you specify an image that appears for a few seconds once a guest joins
&hangupmessage*	Option for a custom hang-up message
&humb64*	The same as &hangupmessage, except this takes an input as a base64 encoded string
&groupmode	Added to the URL, when not assigned to a group, you don't hear or see anything

*NEW IN VERSION 24