bartek/android-tts-server
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update help and README

Browse Source
This commit is contained in:
Bartłomiej Przemysław Pluta
2020-05-31 16:51:43 +02:00
parent ad07a25210
commit 1ce1ae95fe
2 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -91,4 +91,17 @@ served through the `/sonos/{fileName}` endpoint and Sonos device is requested to
change its source stream URL to this file. The already generated files are stored in cache
directory so there is no need to resynthesize frequently-used message which reduces
the overall time needed to complete the request. You are still able to invalidate
this cache via application settings.
this cache via application settings.
## The `/gong.wav` endpoint
```
GET /gong.wav
```
*Returns:* `200 OK` with gong wave file (`Content-Type: audio/x-wav`)
This endpoint is designed for serving gong wave to Sonos devices
and – similar to `/sonos/{fileName}` – is not intended
to be used directly by you. If gong is enabled in the settings,
Sonos is requested to change its source stream URL to a gong
file prior to the actual announcement being served by `/sonos/{fileName}` endpoint.

20
app/src/main/assets/help/help.html
View File

@@ -53,8 +53,8 @@ POST /say
<p><b>Returns:</b> <code>200 OK</code> with empty body</p>
<p>
The <code>/say</code> endpoint allows you to perform TTS task using device's speakers or the
external ones connected to it via jack, Bluetooth etc. For example if you have some
old PC-speakers you are able to connect your device to them via line port and
external ones connected to it via jack, Bluetooth etc. For example if you have some
old PC-speakers you are able to connect your device to them via line port and
get a complete speech-based notification system.
</p>
@@ -111,5 +111,21 @@ GET /sonos/{fileName}
the overall time needed to complete the request. You are still able to invalidate
this cache via application settings.
</p>
<h2>The <code>/gong.wav</code> endpoint</h2>
<pre>
GET /gong.wav
</pre>
<p>
<b>Returns: </b> <code>200 OK</code>
with gong wave file (<code>Content-Type: audio/x-wav</code>)
</p>
<p>
This endpoint is designed for serving gong wave file
to Sonos devices and &ndash; similar to <code>/sonos/{fileName}</code> &ndash;
is not intended to be used directly by you. If gong is enabled in the settings,
Sonos is requested to change its source stream URL to a gong file prior to
the actual announcement being served by <code>/sonos/{fileName}</code> endpoint.
</p>
</body>
</html>