Răsfoiți Sursa

update player doc. Push it in settings doc

nico 7 ani în urmă
părinte
comite
ff246b497c

+ 1 - 1
Docs/installation/debian_jessie.md

@@ -12,7 +12,7 @@ Install some required system libraries and softwares:
 
 ```bash
 sudo apt-get update
-sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer libav-tools
 ```
 
 Let's install the last release of python-pip

+ 1 - 1
Docs/installation/raspbian_jessie.md

@@ -28,7 +28,7 @@ Install some required system libraries and software:
 
 ```bash
 sudo apt-get update
-sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer libyaml-dev libpython2.7-dev
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer libyaml-dev libpython2.7-dev libav-tools
 ```
 
 Let's install the last release of python-pip

+ 1 - 1
Docs/installation/ubuntu_14.04.md

@@ -6,7 +6,7 @@ Install some required system libraries and softwares:
 
 ```bash
 sudo apt-get update
-sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev libjack0 libjack-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev libjack0 libjack-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer libav-tools
 ```
 
 Let's install the last release of python-pip

+ 1 - 1
Docs/installation/ubuntu_16.04.md

@@ -6,7 +6,7 @@ Install some required system libraries and softwares:
 
 ```bash
 sudo apt-get update
-sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer
+sudo apt-get install git python-dev libsmpeg0 libttspico-utils libsmpeg0 flac dialog libffi-dev libffi-dev libssl-dev portaudio19-dev build-essential libssl-dev libffi-dev sox libatlas3-base mplayer libav-tools
 ```
 Let's install the last release of python-pip
 ```bash

+ 0 - 44
Docs/player.md

@@ -1,44 +0,0 @@
-# Players
-
-With Kalliope project, you can set whatever Sound Player you want to use.
-
-## Settings
-
-The setting.yml defines the Player you want to use by default
-```yml
-default_player: "type default player here"
-```
-
-Then, still in the settings.yml file, each Player must set up its configuration following the 'players' tag :
-```yml
-players:
-   - player1:
-      player1parameter1: "value option1"
-      player1parameter2: "value option2"
-   - player2:
-      player2parameter1: "value option1"
-```
-Sometime, parameters will be necessary to use an engine. 
-Click on a Player engine link in the `Current CORE Available Players` section to know which parameter are required.
-
-## Current CORE Available Players
-
-Core players are already packaged with the installation of Kalliope an can be used out of the box. See the [complete list here](player_list.md).
-
-## Full Example
-
-In the settings.yml file :
-
-```yml
-default_player: "mplayer"
-
-players:
-  - mplayer: {}
-  - pyalsaaudio:
-     device: "default"
-     convert_to_wav: True
-  - pyaudioplayer:
-     convert_to_wav: True
-  - sounddeviceplayer:
-     convert_to_wav: True
-```

+ 1 - 2
Docs/player_list.md

@@ -1,8 +1,7 @@
 # List of available Player
 
-A player is a module that Kalliope will use when playing a sound. 
+A player is a module that Kalliope will use when playing a sound generated from a TTS engine.
 You can define them in your [settings.yml file](settings.md). 
-See the [complete player documentation](player.md) for more information.
 
 ## Core Players
 Core Players are already packaged with the installation of Kalliope an can be used out of the box.

+ 26 - 2
Docs/settings.md

@@ -46,6 +46,10 @@ Specify the name of the player module you want to use.
 ```yml
 default_player: "player_name"
 ```
+E.g
+```yml
+default_player: "mplayer"
+```
 
 #### players
 The player is the engine in charge of running sounds in Kalliope.
@@ -58,12 +62,32 @@ players:
       parameter_name: "value"
 ```
 
-See the complete list of [available players here](player.md).
+E.g
+```yml
+players:
+  - mplayer: {}
+  - pyalsaaudio:
+     device: "default"
+     convert_to_wav: True
+  - pyaudioplayer:
+     convert_to_wav: True
+  - sounddeviceplayer:
+     convert_to_wav: True
+```
+
+See the complete list of [available players here](player_list.md).
 
-when no parameters are required set an empty object:
+When no parameters are required set an empty object:
 ```yml
 players:
   - mplayer: {}
+```
+
+Sometime, parameters will be necessary to use an engine. See the [complete list here](player_list.md) to know which parameter are required.
+Core players are already packaged with the installation of Kalliope an can be used out of the box. 
+
+>**Note:** Most cloud based TTS generate a file in MP3 format. Some players are not able to read this format and then a conversion to wav is needed.
+
 
 ## Speech to text configuration
 

+ 2 - 0
kalliope/tts/acapela/README.md

@@ -13,3 +13,5 @@ This TTS is based on the [Acapela engine](http://www.acapela-group.com/)
 
 The voice name is attached to a specific language.
 To test and get the name of a voice, please refer to [this website(https://acapela-box.com/AcaBox/index.php].
+
+The generated file is mp3.