Home› Video› Low Code› Query Parameters

Query String Parameters

The Low Code embed's default behaviour is determined by whatever you configured in the Visual Builder when setting up your subdomain. Query string parameters let you override that configuration on a per-URL basis at runtime — without touching the Visual Builder.

This is useful when you need different behaviour for different participants in the same room. For example, you might show the user list to a moderator but hide it from participants, or pre-fill a participant's display name so they skip the landing page. Append parameters directly to any of the three join URL patterns described in the Overview — Join URL Patterns.

How to Use

Append a ? after the join URL and then list parameters as key=value pairs.

Single parameter:

https://YOUR_SUBDOMAIN.yourvideo.live/ROOM_ID?name=Alice

Multiple parameters (join them with &):

https://YOUR_SUBDOMAIN.yourvideo.live/ROOM_ID?name=Alice&video=no&landing=no
Parameters you do not pass retain their Visual Builder defaults. You only need to include parameters you want to change for a particular URL.
Entry to Session

These parameters control how a user enters the video session — their identity, their initial media state, and whether they pass through the landing page.

Parameter Type Description
name String Display name of the participant or moderator joining the session.
user_ref String Your application's unique identifier for this user. Useful for tracking session participation in your backend.
video yes / no Join with camera on (yes) or off (no).
audio yes / no Join with microphone on (yes) or off (no).
landing yes / no When set to no, the user bypasses the landing page and joins the session directly. The name parameter must be provided when landing=no.
Feature Toggles

Each feature that can be enabled or disabled in the Visual Builder can also be toggled per URL. Use these parameters to turn specific capabilities on or off for a particular join link.

Parameter Type Description
screenshare yes / no Enable or disable screen sharing.
whiteboard yes / no Enable or disable the collaborative whiteboard.
live_streaming yes / no Enable or disable the ability to start an HLS/RTMP live stream.
group_chat yes / no Enable or disable the group chat panel.
pvt_chat yes / no Enable or disable private (one-to-one) chat between participants.
room_lock yes / no Enable or disable the room lock feature.
UI & UX

Background Image

Set a custom background image behind the video tiles. The image is rendered using standard CSS background properties. The host server for the image must support CORS.

Parameter Type Required Description
bg_img_url String Required Fully qualified HTTPS URL of the background image.
bg_img_repeat no-repeat / repeat-x / repeat-y Optional Controls how the image tiles. If omitted, the image is repeated in both directions.
bg_img_position String Optional Two-word value controlling image placement. First word is horizontal: left, center, or right. Second word is vertical: top, center, or bottom. Example: center top.

Miscellaneous UI Options

Parameter Type Description
toggle_mirror_view yes / no Adds a "Toggle Mirror for All" button to the toolbar. When clicked, all participants' video displays are flipped horizontally.
reactions_to_toolbar yes / no Moves the reactions/confetti icon from the session header into the toolbar.
remove_top_record_icon yes / no Hides the blinking recording indicator shown at the top of the session when a recording is active.
show_share_to_self yes / no Shows the presenter's own screen share feed on the presenter's side of the UI. Note: this may produce a mirror effect.
device_prompt yes / no Displays an explanatory UI panel telling the user why camera and microphone access is required before they join.
User List

Control whether the participant list panel is shown for each role. This lets you show the list to moderators while hiding it from participants.

Parameter Type Description
user_list_participant yes / no Show or hide the participant list on the participant's UI.
user_list_moderator yes / no Show or hide the participant list on the moderator's UI.
Toolbar & Layout

Fixed Toolbar

By default, the toolbar auto-hides after a period of inactivity. Set this parameter to keep it permanently visible.

Parameter Type Description
Fixed_toolbar yes / no When yes, the toolbar remains continuously visible and does not auto-hide.

Grid View

Set the initial video grid layout when the session opens.

Parameter Values Description
grid_view gallery / leader Start the session in gallery view (all participants equally sized) or leader view (one dominant speaker highlighted). Default is gallery.
Top Bar Elements

Control the visibility of the top bar and each element it contains. Hiding the top bar also hides all elements under it regardless of their individual settings.

Parameter Type Description
topbar yes / no Show or hide the entire top bar. When hidden, all elements under it are also hidden.
user_count yes / no Show or hide the live participant count in the top bar.
room_name yes / no Show or hide the room name in the top bar.
clock yes / no Show or hide the session clock in the top bar.
Waiting Lobby

Lobby Timeout

When moderated entry is active, participants wait in a lobby until the moderator admits them. Use these parameters to set a maximum wait time and define where the participant is redirected if the timeout expires.

Parameter Type Description
lobby_timeout Number (seconds) Maximum time, in seconds, a participant can wait in the lobby before being redirected. Default is 120 seconds (2 minutes).
lobby_exit_url String (URL) The URL to redirect the participant to when the lobby_timeout threshold is reached.

Lobby Decorations

Enrich the waiting lobby experience with images, text messages, a video, or background music. All external media must be hosted on servers with CORS enabled. Use these parameters in the Participant join URL only.

Image Slideshow — Up to 3 images displayed as a carousel:

ParameterTypeDescription
lobby_img_1String (URL)First image in the slideshow.
lobby_img_2String (URL)Second image in the slideshow.
lobby_img_3String (URL)Third image in the slideshow.

Text Carousel — Up to 3 rotating text messages:

ParameterTypeDescription
lobby_text_1StringFirst text message in the carousel.
lobby_text_2StringSecond text message in the carousel.
lobby_text_3StringThird text message in the carousel.

Video Playback — A video file played in the lobby using the HTML5 <video> element:

ParameterTypeDescription
lobby_videoString (URL)URL of the video file to play. Must be an HTML5 <video>-compatible format.

Background Music — An audio file played while waiting, using the HTML5 <audio> element:

Background music can accompany image and text carousels but cannot be used together with lobby video playback.
ParameterTypeDescription
lobby_musicString (URL)URL of the audio file to play as background music. Must be an HTML5 <audio>-compatible format.
Exit Behaviour

Control where a user lands after they click the Disconnect button or after the session ends.

Parameter Type Description
exit_url String (URL) The URL to redirect the user to when they click Disconnect.
exit_url_target self / parent Where to open the exit_url. Use self to redirect in the current window (default), or parent to redirect the parent page when the embed is inside an IFRAME.
Virtual Background Library

Provide a custom library of images users can select as their virtual background. You can also specify which image should be applied automatically when their local stream starts. All image URLs must be hosted on HTTPS with CORS enabled.

Parameter Type Description
virtual_bg_imgs String (URL) URL pointing to an image (or comma-separated list of image URLs) to populate the virtual background picker for the user.
my_virtual_img String (URL) URL of the image to apply automatically as the user's virtual background when their local stream starts. Can be from the virtual_bg_imgs library or any other HTTPS-hosted image.
← Overview Parent Window Comm. →