Update help and README
This commit is contained in:
15
README.md
15
README.md
@@ -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
|
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
|
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
|
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.
|
||||||
|
|||||||
@@ -53,8 +53,8 @@ POST /say
|
|||||||
<p><b>Returns:</b> <code>200 OK</code> with empty body</p>
|
<p><b>Returns:</b> <code>200 OK</code> with empty body</p>
|
||||||
<p>
|
<p>
|
||||||
The <code>/say</code> endpoint allows you to perform TTS task using device's speakers or the
|
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
|
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
|
old PC-speakers you are able to connect your device to them via line port and
|
||||||
get a complete speech-based notification system.
|
get a complete speech-based notification system.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@@ -111,5 +111,21 @@ GET /sonos/{fileName}
|
|||||||
the overall time needed to complete the request. You are still able to invalidate
|
the overall time needed to complete the request. You are still able to invalidate
|
||||||
this cache via application settings.
|
this cache via application settings.
|
||||||
</p>
|
</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 – similar to <code>/sonos/{fileName}</code> –
|
||||||
|
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>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
Reference in New Issue
Block a user