# 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="settings-parameters/and-language"><code>&#x26;language</code></a></td><td>Sets the interface language</td></tr><tr><td><a href="settings-parameters/remote"><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="settings-parameters/and-controlobs"><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="settings-parameters/and-allowedscenes"><code>&#x26;allowedscenes</code></a></td><td>Option to filter which OBS scenes a remote guest has access to controlling when using <a href="settings-parameters/and-controlobs"><code>&#x26;controlobs</code></a></td></tr><tr><td><a href="settings-parameters/and-stats"><code>&#x26;stats</code></a></td><td>Shows the connection/media stats window by default</td></tr><tr><td><a href="settings-parameters/sticky"><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="settings-parameters/and-clearstorage"><code>&#x26;clearstorage</code></a></td><td>Will clear all the saved user preferences for all sessions</td></tr><tr><td><a href="settings-parameters/and-disablehotkeys"><code>&#x26;disablehotkeys</code></a></td><td>Disables hotkeys (like <code>CRTL + M</code>)</td></tr><tr><td><a href="settings-parameters/showlist"><code>&#x26;showlist</code></a></td><td>Shows list of hidden guests</td></tr><tr><td><a href="settings-parameters/and-nopush"><code>&#x26;nopush</code></a></td><td>Blocks outbound publishing connections</td></tr><tr><td><a href="settings-parameters/and-hidehome"><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="settings-parameters/and-hidetranslate"><code>&#x26;hidetranslate</code></a></td><td>Hides the option to translate VDO.Ninja</td></tr><tr><td><a href="settings-parameters/and-clock"><code>&#x26;clock</code></a></td><td>Shows the current time</td></tr><tr><td><a href="settings-parameters/and-clock24-alpha"><code>&#x26;clock24</code></a>*</td><td>The same as <a href="settings-parameters/and-clock"><code>&#x26;clock</code></a> option, except it uses 24-hour time for the display</td></tr><tr><td><a href="settings-parameters/and-timer"><code>&#x26;timer</code></a></td><td>Positions the countdown timer</td></tr><tr><td><a href="settings-parameters/and-powerpoint"><code>&#x26;powerpoint</code></a></td><td>Adds a built-in basic controller to control PowerPoint</td></tr><tr><td><a href="settings-parameters/and-widget"><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="settings-parameters/and-token"><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](https://docs.vdo.ninja/releases/v24)

### Connection Recovery (Trials)

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

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

### Chat Lite Overlay Integration

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

### Synthetic Test Media (Automation)

* [`&testmedia`](https://docs.vdo.ninja/advanced-settings/settings-parameters/and-testmedia) (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="settings-parameters/transcribe"><code>&#x26;transcribe</code></a></td><td>Enables transcription and closed captioning</td></tr><tr><td><a href="settings-parameters/and-signalmeter"><code>&#x26;signalmeter</code></a></td><td>Visualizes the packet loss of a guest</td></tr><tr><td><a href="settings-parameters/and-batterymeter"><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="settings-parameters/consent"><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="settings-parameters/and-prompt"><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="buttons-and-control-bar-parameters/and-hands"><code>&#x26;hands</code></a></td><td>Enables a "Raise Hand" button for guests</td></tr><tr><td><a href="settings-parameters/and-notify"><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="settings-parameters/r2d2"><code>&#x26;r2d2</code></a></td><td>Easter egg <a href="settings-parameters/and-notify"><code>&#x26;notify</code></a> sound</td></tr><tr><td><a href="settings-parameters/directorchat"><code>&#x26;directorchat</code></a></td><td>Message ONLY the director</td></tr><tr><td><a href="settings-parameters/and-maxconnections"><code>&#x26;maxconnections</code></a></td><td>Limits total of view and push connections</td></tr><tr><td><a href="settings-parameters/and-maxviewers"><code>&#x26;maxviewers</code></a></td><td>Limits the number of viewers allowed</td></tr><tr><td><a href="settings-parameters/and-chunked"><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="settings-parameters/and-retransmit"><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="settings-parameters/and-rampuptime"><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="settings-parameters/sensor"><code>&#x26;sensor</code></a></td><td>Access device sensor data at given rate</td></tr><tr><td><a href="settings-parameters/and-sensorfilter"><code>&#x26;sensorfilter</code></a></td><td>An option to explicitly list what <a href="settings-parameters/sensor"><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="settings-parameters/and-postimage"><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="settings-parameters/and-postinterval"><code>&#x26;postinterval</code></a></td><td>Time interval in seconds for <a href="settings-parameters/and-postimage"><code>&#x26;postimage</code></a></td></tr><tr><td><a href="settings-parameters/and-slot"><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](https://docs.vdo.ninja/releases/v24)

## Viewer Side Options

**Viewer's Settings**, which are aspects that are controllable by the viewer's side. These parameters are mostly added to [`&room`](https://docs.vdo.ninja/advanced-settings/setup-parameters/room) (viewing other guests), [`&view`](https://docs.vdo.ninja/advanced-settings/mixer-scene-parameters/view) and [`&scene`](https://docs.vdo.ninja/advanced-settings/mixer-scene-parameters/scene) or [`&solo`](https://docs.vdo.ninja/advanced-settings/mixer-scene-parameters/and-solo) 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="settings-parameters/and-closedcaptions"><code>&#x26;closedcaptions</code></a></td><td>Enables displaying of closed captioning text</td></tr><tr><td><a href="settings-parameters/and-nocaptionlabels"><code>&#x26;nocaptionlabels</code></a>*</td><td>Disables showing the names when using the <a href="settings-parameters/and-closedcaptions"><code>&#x26;closedcaptions</code></a> feature</td></tr><tr><td><a href="settings-parameters/enhance"><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="settings-parameters/and-bitratecutoff"><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="settings-parameters/and-cutscene"><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="settings-parameters/and-statsinterval"><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="settings-parameters/keyframerate"><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="settings-parameters/and-maxpublishers"><code>&#x26;maxpublishers</code></a></td><td>Limits the number of remote peer connections that are publishers</td></tr><tr><td><a href="settings-parameters/and-showconnections"><code>&#x26;showconnections</code></a></td><td>Displays the total number of p2p connections of a remote stream</td></tr><tr><td><a href="settings-parameters/and-obsfix"><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="settings-parameters/streamlabs"><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="settings-parameters/and-getfaces"><code>&#x26;getfaces</code></a></td><td>Will request a continuous stream of face bounding boxes</td></tr><tr><td><a href="settings-parameters/and-nochunked"><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](https://docs.vdo.ninja/releases/v24)