Skip to content

Commit

Permalink
Add list of languages
Browse files Browse the repository at this point in the history
  • Loading branch information
definitio committed Nov 22, 2020
1 parent 8a35054 commit d8e0ab9
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ The `rhvoice` integration uses [RHVoice](https://github.com/Olga-Yakovleva/RHVoi
4. Restart Home Assistant.

## <a name="configuration"></a> Configuration

To enable text-to-speech with RHVoice, add at a minimum the following lines to your Home Assistant's `configuration.yaml` file:

```yaml
Expand All @@ -35,7 +36,6 @@ tts:
volume: 50
```
## <a name="configuration-options"></a> Configuration Options
- **host:** *(string) (Required)*
Expand All @@ -45,44 +45,56 @@ tts:
- **port:** *(string) (Optional)*

This is the port that the rhvoice-rest container can be reached at.

*Default value: `8080`*

- **format:** *(string) (Optional)*

This is the file format used for the TTS files created.

*Default value: `mp3`*

*Allowed values: `wav|mp3|opus|flac`*

- **pitch:** *(string) (Optional)*

This adjust the sound frequency of the TTS voice, lower or higher.

*Default value: `50`*

*Allowed values: `0 to 100`*

- **rate:** *(string) (Optional)*

This adjust the talking speed of the TTS voice, slower or faster.

*Default value: `50`*

*Allowed values: `0 to 100`*

- **voice:** *(string) (Optional)*

This is the voice that is used to create the TTS files. Voices are connected with a language. For best results select a voice for the text language you will use.

*Default value: `anna` (russian)*

*Allowed values: See [the list of voices and their corresponding languages on the upstream RHVoice wiki page](https://github.com/Olga-Yakovleva/RHVoice/wiki/Latest-version).*

*Allowed values:*

| Voices | Language |
|--------------------------------------------------|----------------------|
| `alan`, `bdl`, `clb`, `slt` | American English |
| `spomenka` | Esperanto |
| `natia` | Georgian |
| `azamat`, `nazgul` | Kyrgyz |
| `letícia-f123` | Brazilian Portuguese |
| `aleksandr`, `artemiy`, `anna`, `elena`, `irina` | Russian |
| `talgat` | Tatar |
| `anatol`, `natalia` | Ukrainian |

- **volume:** *(string) (Optional)*

This adjusts the volume of the voice in TTS files created, softer or louder.

*Default value: `50`*

*Allowed values: `0 to 100`*

0 comments on commit d8e0ab9

Please sign in to comment.