Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
funkyfranky authored Apr 26, 2023
1 parent dff662a commit 0553733
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,24 @@ NOTE:
* The TTS messages are played synchronously, *i.e.* they are played one after the other and do not overlap each other.

![image](https://user-images.githubusercontent.com/28947887/234686638-79272a70-aaff-426d-9d01-6252bf779a1b.png)

## JSON
This is an example how the send JSON data could look like:
```json
{
"command": "moose_text2speech",
"text": "This is the text that is converted to speech.",
"provider": 0,
"voice": "Microsoft David Desktop",
"culture": "en-US",
"gender": "male",
"volume": 100
}
```
* `command`: This must be "moose_text2speech" for the listener to know that this received data was meant to be converted to speech.
* `text`: This is the text that is converted to speech.
* `provider`: 0=Microsoft (default), 1=Google TTS engine
* `voice`: The explicit voice to use.
* `culture`: (Optional) The languange code, *e.g.* "en-US", "en-GB", "de-DE", ...
* `gender`: (Optional) Can be "male", "female" or "neutral".
* `volume`: (Optional) For Microsoft a value in [0,100] (default 100). For Google [-96, 10] as the volume gain in DB (default 0).

0 comments on commit 0553733

Please sign in to comment.