> For the complete documentation index, see [llms.txt](https://docs.vdo.ninja/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vdo.ninja/advanced-settings/screen-share-parameters.md).

# 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`](/advanced-settings/setup-parameters/push.md), guest invite links, or room participants who will share a screen.
* **Viewer side** options belong on receive links, such as [`&view`](/advanced-settings/mixer-scene-parameters/view.md) or [`&scene`](/advanced-settings/mixer-scene-parameters/scene.md), and control how incoming screen shares are requested or displayed.

Use [`&screensharehide`](/advanced-settings/screen-share-parameters/and-screensharehide.md) when the screen-sharing publisher should not see their own local screen-share preview. Use [`&noscreenshare`](/advanced-settings/screen-share-parameters/and-noscreenshare.md) when a viewer or scene link should not load incoming screen shares.

## General options

| Parameter                                                                                   | Explanation                                                                                                 |
| ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [`&screensharestereo`](/advanced-settings/screen-share-parameters/and-screensharestereo.md) | Sets the audio mode for screen-shares to stereo and changes default audio settings to improve audio quality |

## Source side options

| Parameter                                                                                                                                      | Explanation                                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| [`&screenshare`](/advanced-settings/setup-parameters/screenshare.md)                                                                           | Disables camera-sharing as an option                                                       |
| [`&screenshare2`](/advanced-settings/setup-parameters/and-screenshare2.md)                                                                     | Shows the "Share your Screen" button before asking the user to select screen-share options |
| [`&screenshareaec`](/advanced-settings/screen-share-parameters/and-screenshareaec.md)                                                          | Turns automatic echo cancellation for screen-shares on or off                              |
| [`&screenshareautogain`](/advanced-settings/screen-share-parameters/and-screenshareautogain.md)                                                | Turns audio auto-normalization for screen-shares on or off                                 |
| [`&screensharecursor`](/advanced-settings/screen-share-parameters/cursor.md)                                                                   | Attempts to show the mouse cursor on screen shares                                         |
| [`&screensharedenoise`](/advanced-settings/screen-share-parameters/and-screensharedenoise.md)                                                  | Turns audio noise reduction for screen-shares on or off                                    |
| [`&screensharefps`](/advanced-settings/screen-share-parameters/screensharefps.md)                                                              | Sets a target FPS for a screen share                                                       |
| [`&screensharehide`](/advanced-settings/screen-share-parameters/and-screensharehide.md)                                                        | Hides the publisher's local screen-share preview window                                    |
| [`&screenshareid`](/advanced-settings/screen-share-parameters/screenshareid.md)                                                                | Pre-sets the stream ID for a secondary screen-share stream                                 |
| [`&screensharelabel`](/advanced-settings/screen-share-parameters/and-screensharelabel.md)                                                      | Gives the screen-share stream the same label as the guest                                  |
| [`&screensharequality`](/advanced-settings/screen-share-parameters/screensharequality.md)                                                      | Sets a custom screen-share quality                                                         |
| [`&screensharecontenthint`](/advanced-settings/screen-share-parameters/and-screensharecontenthint.md)                                          | `=motion` prioritizes frame rate; `=detail` prioritizes resolution                         |
| [`&screenshareaspectratio`](/advanced-settings/screen-share-parameters/and-screenshareaspectratio.md)                                          | Changes the screen-share aspect ratio on the publisher side                                |
| [`&screensharetype`](/advanced-settings/screen-share-parameters/and-screensharetype.md)                                                        | Defines how a guest's webcam and screen share interact in a room                           |
| [`&smallshare`](/advanced-settings/screen-share-parameters/and-smallshare.md)                                                                  | Makes the screen share behave like a webcam share                                          |
| [`&screensharevideoonly`](/advanced-settings/screen-share-parameters/and-screensharevideoonly.md)                                              | Disables the option to select audio when screen sharing                                    |
| [`&screensharebutton`](/advanced-settings/buttons-and-control-bar-parameters/and-screensharebutton.md)                                         | Forces the screen-share button to appear for guests                                        |
| [`&suppresslocalaudio`](/advanced-settings/screen-share-parameters/and-suppresslocalaudio.md)                                                  | Disables local audio playback of a Chrome tab while screen-sharing it                      |
| [`&prefercurrenttab`](/advanced-settings/screen-share-parameters/and-prefercurrenttab.md)                                                      | Makes the current tab the default screen-share source                                      |
| [`&selfbrowsersurface`](/advanced-settings/screen-share-parameters/and-selfbrowsersurface.md)                                                  | Excludes the current tab as a screen-share source option                                   |
| [`&systemaudio`](/advanced-settings/screen-share-parameters/and-systemaudio.md)                                                                | Excludes system audio as an audio source when display sharing                              |
| [`&displaysurface`](/advanced-settings/screen-share-parameters/and-displaysurface.md)                                                          | Pre-selects display-share rather than tab-share when screen-sharing                        |
| [`&screenwhep`](https://github.com/steveseguin/vdo.ninja/blob/gitbook/advanced-settings/screen-share-parameters/and-screenwhep.md)             | Chooses whether screen-shares prefer WHEP relays or stay P2P                               |
| [`&screensharestyle`](https://github.com/steveseguin/vdo.ninja/blob/gitbook/advanced-settings/screen-share-parameters/and-screensharestyle.md) | Selects a screen-share layout style preset                                                 |

## Viewer side options

| Parameter                                                                                                                                                                                                                                                                                                                                             | Explanation                                                                                   |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| [`&screensharebitrate`](/advanced-settings/screen-share-parameters/and-screensharebitrate.md)                                                                                                                                                                                                                                                         | Manually sets the video bitrate for incoming screen shares                                    |
| [`&sharperscreen`](/advanced-settings/screen-share-parameters/and-sharperscreen.md)                                                                                                                                                                                                                                                                   | Sets [`&scale=100`](/advanced-settings/video-parameters/scale.md), but only for screen-shares |
| [`&sspaused`](/advanced-settings/screen-share-parameters/and-sspaused.md)                                                                                                                                                                                                                                                                             | Starts incoming screen shares paused                                                          |
| <p><a href="https://github.com/steveseguin/vdo.ninja/blob/gitbook/advanced-settings/screen-share-parameters/and-allowscreenmedia.md"><code>\&allowscreenvideo</code></a><br><a href="https://github.com/steveseguin/vdo.ninja/blob/gitbook/advanced-settings/screen-share-parameters/and-allowscreenmedia.md"><code>\&allowscreenaudio</code></a></p> | Force-enables or blocks incoming screen-share video/audio tracks on a viewer link             |
| [`&noscreenshare`](/advanced-settings/screen-share-parameters/and-noscreenshare.md)                                                                                                                                                                                                                                                                   | Prevents viewer and scene links from loading incoming screen shares                           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.vdo.ninja/advanced-settings/screen-share-parameters.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.