Defines a room for guests to chat in. If used, everyone in a room will auto-connect to each other on joining, unless
&view is used. Rooms benefit from allowing for echo-free conversation and rooms can be managed by a director.
Guests in a room have limited control and will see videos at reduced quality; this is intentional.
The director flag should be set to whatever the room name is. The first director to join a room then becomes the controller of the room. They have the ability to remotely control guest's settings, such as microphone volume of a guest, and they can add and remove guests to scenes.
Several other parameters into one, designed to quick-start applications needing high-quality audio. This parameter can be considered pretty heavy duty, so it's primarily designed for professional users needing near-raw audio quality, such as music DJs.
If used on the sender's side, it disable echo-cancellation, noise-reduction, and auto-volume leveling. It also requests stereo audio from the microphone source.
When applied to the viewer's side as well, it will increase the connection's audio bitrate to 256-kbps and request stereo-audio from the sender, if it is available.
If using a room, then to view a specific stream or collection of streams, the
&room parameter must be added to any view link. The scene parameter lets the system know the connection is not a guest, but rather designed for capture.
Different scenes and scene types are available, and since a director can add and remove streams from scenes from their control room, multiple scenes can be used together to act as media slots in complex show layouts.
This parameter can be added to a guest's invite link to reduce the maximum video bandwidth they will make available to each other guest.
On mobile devices, outbound bandwidth to other guest is already set very low, but if a guest is still struggling to participate in a group room, adding
&roombitrate=0 to their invite link will disable their outbound video to other guests and free up even more CPU. See
&totalroombitrate for another option.
Specifies the custom password to be used. If left blank, the user will be prompted for the password on page load. Passwords are not stored and used purely client-side. They are used to encrypt the initial connection handshake between peers and to obfuscate room names.
&hash parameter is system-generated and is a bit like the
&password parameter, except it has the ability to validate a user-entered password.
Adding this flag will have guests only accept video connections from the director, but still share audio and accept audio-connections from other guests. This reduces the CPU and network load on guests, allowing for larger rooms, so long as the director can also support those larger rooms.