You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(tts): update Premium TTS documentation and add local TTS guide images
Updated the Premium TTS Options section in README.md to clarify browser/provider TTS capture and reference the Local AI TTS Guide for self-hosted endpoints. Added supporting screenshots to the local TTS documentation.
[auto-enhanced]
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -880,7 +880,7 @@ The `voice` parameter works with partial matching, so you can use terms like "si
880
880
881
881
#### Premium TTS Options
882
882
883
-
Unlike the system TTS (free), all premium TTS options are fully supported by both the Social Stream Ninja app and OBS browser sources with direct audio capture capabilities. These options provide superior language support and much easier integration.
883
+
Unlike the system TTS (free), browser/provider TTS options are designed to play through the page, which makes OBS capture much easier when "Control audio via OBS" is enabled. Self-hosted local endpoints also work, but the endpoint still needs to be reachable from the page that is playing TTS; see the Local AI TTS Guide for localhost, CORS, and OBS browser-source setup notes.
884
884
885
885
##### Kokoro Premium FREE TTS
886
886
Social Stream Ninja now includes Kokoro TTS, a high-quality browser-based text-to-speech solution that runs directly in the browser. Benefits include:
<li><strong>Important:</strong><code>localhost</code> and <code>127.0.0.1</code> mean the same computer that is playing the TTS page. If OBS is on a different computer than your TTS server, use the server computer's LAN IP instead.</li>
670
671
<li>No API key needed for local servers</li>
671
-
<li>If the local server has CORS problems, run <code>npm run local-tts-bridge</code> and point SSN at <code>http://127.0.0.1:8124/v1/audio/speech</code></li>
672
+
<li>If the local server has CORS or local network problems in Chrome/OBS, run <code>npm run local-tts-bridge</code> on the OBS computer and point SSN at <code>http://127.0.0.1:8124/v1/audio/speech</code></li>
672
673
<li>SSN sends <code>{ model, input, voice, response_format, speed }</code> and supports binary audio, JSON audio URLs, and JSON base64 audio</li>
673
674
<li>Custom/local endpoint playback is buffered today; SSN does not progressively play streamed audio chunks yet</li>
<li>Voice: <code>&voiceopenai=af_bella</code>, speed: <code>&openaispeed=1.0</code>. Use a voice name your server supports; Kokoro voices look like <code>af_bella</code>, while openedai-speech/OpenAI-style voices may look like <code>nova</code> or <code>echo</code>.</li>
675
676
<li>See the <ahref="local-tts.html">Local AI TTS Guide</a> for self-hosted server setup</li>
<li><strong>No audio playing:</strong> Click on the page first - browsers require user interaction for audio</li>
715
-
<li><strong>Voices not showing:</strong> Restart browser after installing language packs</li>
716
-
<li><strong>OBS not capturing:</strong> For system TTS, use one of the capture methods above</li>
715
+
<li><strong>No audio playing:</strong> Check that TTS is enabled, the TTS-producing page is open, and the browser source is not muted. In a normal browser, click the page once.</li>
716
+
<li><strong>Voices not showing:</strong> Restart browser after installing language packs</li>
717
+
<li><strong>OBS not capturing:</strong> For browser/provider TTS, check <strong>Control audio via OBS</strong>. For system TTS, use one of the capture methods above</li>
718
+
<li><strong>Local endpoint works in the app test but not OBS:</strong> OBS is a separate browser. Check the endpoint from the OBS computer, especially if using <code>127.0.0.1</code>.</li>
719
+
<li><strong>Only the first letter or first words are read:</strong> remove <code>ttsquick</code> from the OBS URL if present.</li>
717
720
<li><strong>Safari issues:</strong> Safari has limited automatic TTS support</li>
718
721
<li><strong>Premium service not working:</strong> Check API key and ensure provider is correctly specified</li>
`127.0.0.1` and `localhost` mean "this same computer." If OBS is running on a different computer than your TTS server, do not point OBS at `127.0.0.1` for the server. Either:
14
+
15
+
- run this bridge on the OBS computer and point `SSN_TTS_TARGET` at the TTS server's LAN IP, or
16
+
- expose the bridge/server on your LAN and use that LAN IP from OBS.
17
+
18
+
The simplest setup is usually: OBS -> bridge on the OBS computer -> TTS server.
19
+
11
20
## How SSN Calls It
12
21
13
22
SSN sends the same OpenAI-compatible JSON body it would send to OpenAI:
0 commit comments