README

===========================================
           PicoTTS For Asterisk
===========================================

This provides the "PicoTTS" dialplan application, which allows you to use
the PicoTTS TTS Engine with Asterisk. This module invokes the PicoTTS TTS engine
locally, and uses it to render text to speech.
It works with asterisk versions 1.6.x, 1.8, 10

------------
Requirements
------------
Asterisk 1.6.1 (or later) header files
sox installed and executable in the default path
pico2wave installed and executable in the default path
------------
Installation
------------
$ make
$ make install

To install the sample configuration file, issue the following command after
the 'make install' command:

$ make samples

-----
Usage
-----
PicoTTS(text.language[,intkeys]) This will invoke the PicoTTS TTS engine, send a text
string,get back the resulting waveform and play it to the user, allowing any given
interrupt keys to immediately terminate and return the value, or 'any' to
allow any number back.

--------
Examples
--------
dialplan sample code for your extensions.conf

;PicoTTS Demo
exten => 1234,1,Answer()
exten => 1234,n,PicoTTS("This is a simple test in english.",any,en-US)
exten => 1234,n,PicoTTS("Esto es una prueba en español.",any,es-ES)
exten => 1234,n,Hangup()

-------
License
-------
The PicoTTS module for asterisk is distributed under the GNU General Public
License v2. See COPYING for details.