# Settings Parameters

They are separated in three groups: [general options](#general-options) (push and view), [source side](#source-side-options) (push) options and [viewer side](#viewer-side-options) (view) options.

## General Options

You can use them for publisher, viewer and director URLs.

<table><thead><tr><th width="267.57142857142856">Parameter</th><th>Explanation</th></tr></thead><tbody><tr><td><a href="/pages/-MZNYz1fm4K07rtKKEuA"><code>&#x26;language</code></a></td><td>Sets the interface language</td></tr><tr><td><a href="/pages/-MZX0aUm-36CtnkhYT1y"><code>&#x26;remote</code></a></td><td>Allows remote operation of the zoom and focus, and access to statistics</td></tr><tr><td><a href="/pages/hUgQS4BzpqNKETI8vDeC"><code>&#x26;controlobs</code></a></td><td>The ability for VDO.Ninja to Remotely Control OBS Studio while streaming/directing</td></tr><tr><td><a href="/pages/lYvQRM2zCOtBnY6C9R0h"><code>&#x26;allowedscenes</code></a></td><td>Option to filter which OBS scenes a remote guest has access to controlling when using <a href="/pages/hUgQS4BzpqNKETI8vDeC"><code>&#x26;controlobs</code></a></td></tr><tr><td><a href="/pages/-MZX2MyEc5RfMhC0kDHR"><code>&#x26;stats</code></a></td><td>Shows the connection/media stats window by default</td></tr><tr><td><a href="/pages/-MZX7i1thwp6sw0qxzK6"><code>&#x26;sticky</code></a></td><td>Allows a user to save and then later restore their streaming session settings</td></tr><tr><td><a href="/pages/mPbgT9nmFHUkGLULyA4B"><code>&#x26;clearstorage</code></a></td><td>Will clear all the saved user preferences for all sessions</td></tr><tr><td><a href="/pages/cuvr8p2uFhQ65Q4FydI3"><code>&#x26;disablehotkeys</code></a></td><td>Disables hotkeys (like <code>CRTL + M</code>)</td></tr><tr><td><a href="/pages/-MZX8oUkUNyUP31skS1E"><code>&#x26;showlist</code></a></td><td>Shows list of hidden guests</td></tr><tr><td><a href="/pages/0tNjcgUvkXyirOyUCoh0"><code>&#x26;nopush</code></a></td><td>Blocks outbound publishing connections</td></tr><tr><td><a href="/pages/SdEpPAYFDEoS1BqFImet"><code>&#x26;hidehome</code></a></td><td>Hides the VDO.Ninja homepage and many links that lead to it</td></tr><tr><td><a href="/pages/J3sigYuHyl5xlAk6Y5D5"><code>&#x26;hidetranslate</code></a></td><td>Hides the option to translate VDO.Ninja</td></tr><tr><td><a href="/pages/i4CGJSQ4HprscBZcPr6k"><code>&#x26;clock</code></a></td><td>Shows the current time</td></tr><tr><td><a href="/pages/CfwPSZVzj3hneiT2ACZZ"><code>&#x26;clock24</code></a>*</td><td>The same as <a href="/pages/i4CGJSQ4HprscBZcPr6k"><code>&#x26;clock</code></a> option, except it uses 24-hour time for the display</td></tr><tr><td><a href="/pages/s902imkaZXKhoNM5e0LT"><code>&#x26;timer</code></a></td><td>Positions the countdown timer</td></tr><tr><td><a href="/pages/BVpOC7o54iMotoGfVYv7"><code>&#x26;powerpoint</code></a></td><td>Adds a built-in basic controller to control PowerPoint</td></tr><tr><td><a href="/pages/sV620XBoKlvZahYraArd"><code>&#x26;widget</code></a></td><td>Will load a side-bar with an IFrame embed, with support for YouTube / Twitch / Social Stream</td></tr><tr><td><a href="/pages/BsY4fLt9iKG8NTBT8XjV"><code>&#x26;token</code></a></td><td>A token for invite/scene links to determine whose the director of a room</td></tr></tbody></table>

\*NEW IN [VERSION 24](/releases/v24.md)

### Connection Recovery (Trials)

These options help with unstable peer-to-peer links and recovery behavior:

* [`&autorecover`](/advanced-settings/settings-parameters/and-autorecover.md)
* [`&p2pfailtimeout`](/advanced-settings/settings-parameters/and-p2pfailtimeout.md)
* [`&peerrecoversteps`](/advanced-settings/settings-parameters/and-peerrecoversteps.md) (alias: `&p2precoversteps`)

### Chat Lite Overlay Integration

* [`&chatlite`](/advanced-settings/settings-parameters/and-chatlite.md)
* [`&chatlitebutton`](/advanced-settings/settings-parameters/and-chatlite.md) (alias: `&ssnchatbutton`)
* [`&chatlitesession`](/advanced-settings/settings-parameters/and-chatlite.md) (alias: `&ssnsession`)

### Synthetic Test Media (Automation)

* [`&testmedia`](/advanced-settings/settings-parameters/and-testmedia.md) (alias: `&syntheticmedia`)
* Companion flags: `&testaudio`, `&testvideo`, `&testfps`, `&testwidth`, `&testheight`, `&testtone`

## Source Side Options

**Source Settings**, which are settings specific to publishing. The parameters can be added to a publishing link, like for example a guest, a director or just a basic push link.

<table><thead><tr><th width="235.57142857142856">Parameter</th><th>Explanation</th></tr></thead><tbody><tr><td><a href="/pages/-MZXfGtmqEiLjP9Et_IZ"><code>&#x26;transcribe</code></a></td><td>Enables transcription and closed captioning</td></tr><tr><td><a href="/pages/4gxER1batsLMtgwFpbil"><code>&#x26;signalmeter</code></a></td><td>Visualizes the packet loss of a guest</td></tr><tr><td><a href="/pages/jm9N3ToMedWN7tulFQ4T"><code>&#x26;batterymeter</code></a></td><td>Shows the battery meter for guests that are on devices with a battery that's draining/charging</td></tr><tr><td><a href="/pages/-Mj8Nm2p9fZbEv3R6dhZ"><code>&#x26;consent</code></a></td><td>Will ask the user for content to remote change their camera or microphone</td></tr><tr><td><a href="/pages/qv4dEscZAckfaCZMsW5i"><code>&#x26;prompt</code></a></td><td>Another security option, for those concerned about random spying of their streams</td></tr><tr><td><a href="/pages/-MZXVvQvDeHYho8cPc5K"><code>&#x26;hands</code></a></td><td>Enables a "Raise Hand" button for guests</td></tr><tr><td><a href="/pages/-MZWybInamPM9MOAbJvg"><code>&#x26;notify</code></a></td><td>Audio alerts for raised hands, chat messages and if somebody joins the room</td></tr><tr><td><a href="/pages/-Mc_TLFydHT7ec0mMcU6"><code>&#x26;r2d2</code></a></td><td>Easter egg <a href="/pages/-MZWybInamPM9MOAbJvg"><code>&#x26;notify</code></a> sound</td></tr><tr><td><a href="/pages/-Mb8YOd6C3NyfYobJhOv"><code>&#x26;directorchat</code></a></td><td>Message ONLY the director</td></tr><tr><td><a href="/pages/-MZNZiPijKINWmO-NGdo"><code>&#x26;maxconnections</code></a></td><td>Limits total of view and push connections</td></tr><tr><td><a href="/pages/-MZXemt39dQVxvOnzoFJ"><code>&#x26;maxviewers</code></a></td><td>Limits the number of viewers allowed</td></tr><tr><td><a href="/pages/RuI5uNIo2aV3KSIBc2p1"><code>&#x26;chunked</code></a></td><td>Does not use webRTC's video streaming protocols; rather it uses a custom-made protocol</td></tr><tr><td><a href="/pages/6rDMxFD7pJ6hlVMQHnjp"><code>&#x26;retransmit</code></a>*</td><td>Will relay the incoming 'chunked' media stream to others connected to you, without transcoding</td></tr><tr><td><a href="/pages/9aq7Qc9QCYsbY2rljwh7"><code>&#x26;rampuptime</code></a></td><td>When a guest connects, this tries to load video from that guest for a few seconds, even if not yet added to a scene</td></tr><tr><td><a href="/pages/-MZXfqVnCuNhc45zkG1X"><code>&#x26;sensor</code></a></td><td>Access device sensor data at given rate</td></tr><tr><td><a href="/pages/TAPz7Yz8SjCVOkyt9jeQ"><code>&#x26;sensorfilter</code></a></td><td>An option to explicitly list what <a href="/pages/-MZXfqVnCuNhc45zkG1X"><code>&#x26;sensor</code></a> data you want to capture and transmit</td></tr><tr><td><a href="https://github.com/steveseguin/vdo.ninja/blob/gitbook/advanced-settings/settings-parameters/and-sensorsorigin.md"><code>&#x26;sensorsorigin</code></a></td><td>Require external sensor bridge messages to match a specific <code>postMessage</code> origin</td></tr><tr><td><a href="/pages/ov9Zv4aToHYgIOisljdv"><code>&#x26;postimage</code></a></td><td>Post a snapshot of your local camera to a HTTPS/POST URL</td></tr><tr><td><a href="/pages/LdoWj6QBJ7FrCanqz0ll"><code>&#x26;postinterval</code></a></td><td>Time interval in seconds for <a href="/pages/ov9Zv4aToHYgIOisljdv"><code>&#x26;postimage</code></a></td></tr><tr><td><a href="/pages/BYPvlE2VwmCDC2WSudsu"><code>&#x26;slot</code></a></td><td>Tells the director which slot the guest should prefer to be in</td></tr></tbody></table>

\*NEW IN [VERSION 24](/releases/v24.md)

## Viewer Side Options

**Viewer's Settings**, which are aspects that are controllable by the viewer's side. These parameters are mostly added to [`&room`](/advanced-settings/setup-parameters/room.md) (viewing other guests), [`&view`](/advanced-settings/mixer-scene-parameters/view.md) and [`&scene`](/advanced-settings/mixer-scene-parameters/scene.md) or [`&solo`](/advanced-settings/mixer-scene-parameters/and-solo.md) links, but some of them can also be added to the director's URL.

<table><thead><tr><th width="244.57142857142856">Parameter</th><th>Explanation</th></tr></thead><tbody><tr><td><a href="/pages/-MZdu6iErcfXbfPCHVU7"><code>&#x26;closedcaptions</code></a></td><td>Enables displaying of closed captioning text</td></tr><tr><td><a href="/pages/MDriQFoHkafErQe4qHel"><code>&#x26;nocaptionlabels</code></a>*</td><td>Disables showing the names when using the <a href="/pages/-MZdu6iErcfXbfPCHVU7"><code>&#x26;closedcaptions</code></a> feature</td></tr><tr><td><a href="/pages/-MZduf7zHYl2J-7x_7zW"><code>&#x26;enhance</code></a></td><td>Tells the remote source that you would like them to prioritize the audio stream over other streams</td></tr><tr><td><a href="/pages/Au3ddVY4cb1jqKDVIqjL"><code>&#x26;bitratecutoff</code></a></td><td>If the total bitrate drops below the specified bitrate, the viewer will auto-hide the audio and video for that stream</td></tr><tr><td><a href="/pages/QMRKMsVJuYFuWjb04E4g"><code>&#x26;cutscene</code></a></td><td>Specifies an OBS cut scene to switch to when the bitrate drops below a threshold</td></tr><tr><td><a href="/pages/iiP3u0sKColyFk3VrxlQ"><code>&#x26;statsinterval</code></a></td><td>Lets you change the default stats update interval from 3-seconds to something else</td></tr><tr><td><a href="/pages/-MZdutI2JiIeMJrZLwhm"><code>&#x26;keyframerate</code></a></td><td>This tells the remote publishers to send keyframes at a specified rate</td></tr><tr><td><a href="/pages/-MZdv3KTVKeo1goeZl98"><code>&#x26;maxpublishers</code></a></td><td>Limits the number of remote peer connections that are publishers</td></tr><tr><td><a href="/pages/MmYuqEzbRgkL55QK4BwZ"><code>&#x26;showconnections</code></a></td><td>Displays the total number of p2p connections of a remote stream</td></tr><tr><td><a href="/pages/-MZdvLGaslaC9t-A70Mm"><code>&#x26;obsfix</code></a></td><td>Disables or adjusts the sensitivity of the VP8/VP9 Codec packet loss 'fix' for OBS</td></tr><tr><td><a href="/pages/-MZdvsXX_POi7AcDICOw"><code>&#x26;streamlabs</code></a></td><td>Tells VDO.Ninja to not block VDO.Ninja from attempting to run when using Streamlabs for MacOS</td></tr><tr><td><a href="/pages/mpHP264L1PWT0nRm5iF1"><code>&#x26;getfaces</code></a></td><td>Will request a continuous stream of face bounding boxes</td></tr><tr><td><a href="/pages/eqd66SGb0Enj0YDLwElo"><code>&#x26;nochunked</code></a></td><td>Will ignore the chunked version and use the low-latency version</td></tr></tbody></table>

\*NEW IN [VERSION 24](/releases/v24.md)


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.