> 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/settings-parameters/and-chatlite.md).

# \&chatlite

General Option! ([`&view`](/advanced-settings/mixer-scene-parameters/view.md), [`&room`](/advanced-settings/setup-parameters/room.md), [`&scene`](/advanced-settings/mixer-scene-parameters/scene.md), [`&director`](/advanced-settings/director-parameters/director.md))

## Aliases

* `&ssnlite`
* `&socialstreamlite`

## Details

`&chatlite` enables the built-in Social Stream Ninja Lite activity overlay integration. It can show an in-page chat overlay and expose a control-bar button that toggles the overlay.

This feature is URL-gated and opt-in.

Social Stream Ninja Lite can use native provider cards (YouTube/Twitch/Kick) and Social Stream WebSocket relay mode for broader event inputs.

In simple terms: this adds a small local chat/activity overlay inside VDO.Ninja so you can see supported chat feeds without leaving the page. It is not the full Social Stream Ninja extension, and normal VDO.Ninja pages do not load it unless one of the Chat Lite URL flags is present.

## Basic setup

1. Add `&chatlite=1` to the VDO.Ninja link where you want the overlay.
2. Click the Social Stream Ninja Lite control-bar button while holding `SHIFT` to open the setup window.
3. Connect YouTube, Twitch, Kick, or the Social Stream WebSocket relay source.
4. Keep the setup window and VDO.Ninja page using the same session ID.

For a button without opening the overlay immediately, use `&chatlitebutton=1`. For a specific session name, add `&chatlitesession=YOURSESSION`.

### Companion flags

Use these optional parameters with `&chatlite`:

<table><thead><tr><th width="255">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><code>&#x26;chatlitebutton</code> (alias: <code>&#x26;ssnchatbutton</code>)</td><td>Show/hide the Chat Lite control button</td></tr><tr><td><code>&#x26;chatlitesession</code> (alias: <code>&#x26;ssnsession</code>)</td><td>Set the session ID used by the overlay</td></tr><tr><td><code>&#x26;chatliteprofile</code></td><td>Apply a profile preset in the Chat Lite UI</td></tr><tr><td><code>&#x26;chatliteposition</code></td><td>Set overlay position behavior for activity mode</td></tr><tr><td><code>&#x26;chatlitemax</code></td><td>Set max retained/visible activity messages</td></tr><tr><td><code>&#x26;chatlitetransparent</code></td><td>Toggle transparent embed background</td></tr><tr><td><code>&#x26;chatlitenoavatar</code> (alias: <code>&#x26;chatlitehideavatar</code>)</td><td>Hide source avatars in activity view</td></tr><tr><td><code>&#x26;chatliteconfig</code></td><td>Auto-open the Chat Lite setup window</td></tr><tr><td><code>&#x26;chatlitetts</code></td><td>Set TTS mode (for example <code>on</code>, <code>all</code>, <code>donations</code>)</td></tr></tbody></table>

### UI shortcuts

When the Chat Lite button is visible:

* Click: toggle overlay visibility
* `SHIFT` + click: open configuration popup
* `ALT`/`CTRL` + click: toggle native browser TTS

## Native TTS

`&chatlitetts=on` or `&chatlitetts=all` enables native browser text-to-speech for incoming Lite activity messages. `&chatlitetts=donations` speaks only donation/member-style events.

This uses the browser/system `speechSynthesis` voices. It is useful on desktop and mobile browsers, including Android and iOS when the browser permits it. Some browsers require a user gesture before speech can start.

Only text content is spoken. HTML tags, scripts, event handlers, style blocks, iframe content, and media-only nodes are filtered out before speech text is built. Images are spoken only when they provide useful `alt` or `title` text.

## Notes and limits

* The built-in Chat Lite overlay works best inside the same browser profile that opened VDO.Ninja.
* The "copy overlay link" flow should be treated as a local pop-out/activity view, not a guaranteed cross-browser or cross-machine OBS overlay link.
* If you want a true standalone Social Stream overlay over SSN WebSockets, use the Social Stream theme overlays instead of the built-in Chat Lite activity page.
* Pop-outs and setup windows opened from the same VDO.Ninja page stay paired to that page; manually opened standalone Chat Lite pages still use the default browser-level session behavior.
* This Lite integration does not currently try to match every Social Stream Ninja feature. Full emote-provider support, advanced TTS engines, and extension-only capture behavior should still use Social Stream Ninja directly.
* The activity renderer sanitizes incoming HTML before display. Links and images are restricted to safe renderable URLs, and executable markup is dropped.

## Examples

Enable overlay and button:

`https://vdo.ninja/?view=stream123&chatlite=1`

Set a specific session and transparent mode:

`https://vdo.ninja/?view=stream123&chatlite=1&chatlitesession=myshow&chatlitetransparent=1`

Auto-open setup UI:

`https://vdo.ninja/?room=myroom&chatlitebutton=1&chatliteconfig=1`

Enable compact bottom-right overlay with native TTS:

`https://vdo.ninja/?view=stream123&chatlite=1&chatliteprofile=compact&chatliteposition=bottom-right&chatlitemax=8&chatlitetts=all`

Enable the overlay but speak only donation/member-style events:

`https://vdo.ninja/?view=stream123&chatlite=1&chatlitetts=donations`

## Related

{% content-ref url="/pages/1P2KMlrjFb7FX57poS1I" %}
[Chat Lite](/steves-helper-apps/chat-lite.md)
{% endcontent-ref %}

{% content-ref url="/pages/2pGU9TxBaXEy72kvDG33" %}
[Social Stream Ninja](/steves-helper-apps/social-stream-ninja.md)
{% endcontent-ref %}


---

# 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 dynamically by asking a question.

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

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
