For the complete documentation index, see llms.txt. This page is also available as Markdown.

Screen-share Parameters

Labels, audio filters, type, bitrate, quality etc.

Screen-share parameters are separated by where they are applied:

  • Source side options belong on publisher links, such as &push, guest invite links, or room participants who will share a screen.

  • Viewer side options belong on receive links, such as &view or &scene, and control how incoming screen shares are requested or displayed.

Use &screensharehide when the screen-sharing publisher should not see their own local screen-share preview. Use &noscreenshare when a viewer or scene link should not load incoming screen shares.

General options

Parameter
Explanation

Sets the audio mode for screen-shares to stereo and changes default audio settings to improve audio quality

Source side options

Parameter
Explanation

Disables camera-sharing as an option

Shows the "Share your Screen" button before asking the user to select screen-share options

Turns automatic echo cancellation for screen-shares on or off

Turns audio auto-normalization for screen-shares on or off

Attempts to show the mouse cursor on screen shares

Turns audio noise reduction for screen-shares on or off

Sets a target FPS for a screen share

Hides the publisher's local screen-share preview window

Pre-sets the stream ID for a secondary screen-share stream

Gives the screen-share stream the same label as the guest

Sets a custom screen-share quality

=motion prioritizes frame rate; =detail prioritizes resolution

Changes the screen-share aspect ratio on the publisher side

Defines how a guest's webcam and screen share interact in a room

Makes the screen share behave like a webcam share

Disables the option to select audio when screen sharing

Forces the screen-share button to appear for guests

Disables local audio playback of a Chrome tab while screen-sharing it

Makes the current tab the default screen-share source

Excludes the current tab as a screen-share source option

Excludes system audio as an audio source when display sharing

Pre-selects display-share rather than tab-share when screen-sharing

Chooses whether screen-shares prefer WHEP relays or stay P2P

Selects a screen-share layout style preset

Viewer side options

Parameter
Explanation

Manually sets the video bitrate for incoming screen shares

Sets &scale=100, but only for screen-shares

Starts incoming screen shares paused

Force-enables or blocks incoming screen-share video/audio tracks on a viewer link

Prevents viewer and scene links from loading incoming screen shares

Last updated

Was this helpful?