Jelajahi Sumber

update TTS doc

nico 8 tahun lalu
induk
melakukan
2feff34b47
2 mengubah file dengan 87 tambahan dan 4 penghapusan
  1. 3 3
      Docs/stt.md
  2. 84 1
      Docs/tts.md

+ 3 - 3
Docs/stt.md

@@ -3,13 +3,12 @@
 This chapter describes how STT engine works.
 
 The STT is a programs or API that converts the speech into text.
-Each STT has a specific configuration and supports multiple voices and/or languages.
+Each STT has a specific configuration and supports multiple languages.
 
 The configuration of each STT you use must appear in the [settings.yml](settings.md) file.
 
-The syntax used is YAML.
 
-## General defaults
+## Settings
 
 The setting.yml defines the STT you want to use by default
 ```
@@ -25,6 +24,7 @@ speech_to_text:
    - STT2:
       STT2parameter1: "value option1"
 ```
+Sometime, an API key will be necessary to use an engine. Click on a TTS engine link in the `Current Available STT` section to know which parameter are required.
 
 ## Current Available STT
 

+ 84 - 1
Docs/tts.md

@@ -1 +1,84 @@
-# Text to speech (TTS)
+# Text to speech (TTS)
+
+This chapter describes how TTS engine works.
+
+The TTS is a programs or API that converts a text into a speech.
+Each TTS has a specific configuration and supports multiple voices and/or languages.
+
+The configuration of each TTS you use must appear in the [settings.yml](settings.md) file.
+
+
+## Settings
+
+### default_text_to_speech
+
+The `setting.yml` defines the STT you want to use by default
+```
+default_text_to_speech: "type default TTS engine name here"
+```
+
+### text_to_speech
+
+Still in the `settings.yml` file, each TTS must set up its configuration following the 'text_to_speech' tag :
+```
+text_to_speech:
+   - TTS1:
+      TTS1parameter1: "value option1"
+      TTS1parameter2: "value option2"
+   - TTS2:
+      TTS2parameter1: "value option1"
+```
+Click on a TTS engine link in the `Current Available TTS` section to know which parameter are required.
+
+
+### cache_path
+
+TTS engines work all the same, we give them a text, they give back an audio file and we play the audio file. The generated audio file is placed in cache until it 
+is played by the audio player. Before generating a new audio file, Kalliope will take a look to the cache to load it directly without having to call the 
+TSS engine if the file has been generated before.
+
+You must set a path where the cache will be saved in the tag `cache_path`. This one is placed in /tmp by default.
+```
+cache_path: "/tmp/kalliope_tts_cache"
+```
+
+>**Note:** The path must be a valid path, and the current user must has enough right to read and write in it.
+
+>**Note:** The cache can be enabled or disabled by a neuron. See the [neuron documentation](neurons.md).
+
+>**Note:** The consumed disk space can dramatically increase in the cache path folder. It is recommended to set your neuron correctly to clean up automatically
+generated audio files that will not be played more than once.
+
+## Current Available TTS
+
+- [acapela](../tts/acapela/README.md)
+- [googletts](../tts/googletts/README.md)
+- [pico2wave](../tts/pico2wave/README.md)
+- [voicerss](../tts/voicerss/README.md)
+- [voxygen](../tts/voxygen/README.md)
+
+## Full Example
+
+```
+default_text_to_speech: "voicerss"
+
+cache_path: "/tmp/kalliope_tts_cache"
+
+text_to_speech:
+  - pico2wave:
+      language: "fr-FR"
+      cache: True
+  - voxygen:
+      voice: "Agnes"
+      cache: True
+  - acapela:
+      language: "sonid15"
+      voice: "Manon"
+      cache: True
+  - googletts:
+      language: "fr"
+      cache: True
+  - voicerss:
+      language: "fr-fr"
+      cache: True
+```