README
1===========================================
2 Flite For Asterisk
3===========================================
4
5This provides the "Flite" dialplan application, which allows you to use
6the Flite TTS Engine with Asterisk. This module invokes the Flite TTS engine
7locally, and uses it to render text to speech.
8It works with asterisk versions 1.6.x or later
9
10------------
11Requirements
12------------
13Asterisk 1.6.1 (or later) header files
14Flite 1.4 (or later) libraries and header files
15
16------------
17Installation
18------------
19$ make
20$ make install
21
22To install the sample configuration file, issue the following command:
23
24$ make samples
25
26-----
27Usage
28-----
29Flite(text[,intkeys]) This will invoke the Flite TTS engine, send a text string,
30get back the resulting waveform and play it to the user, allowing any given
31interrupt keys to immediately terminate and return the value, or 'any' to
32allow any number back.
33
34--------
35Examples
36--------
37dialplan sample code for your extensions.conf
38
39;Flite Demo
40exten => 1234,1,Answer()
41exten => 1234,n,Flite("This is a simple F lite test in english.",any)
42 ;Read a text file from disk and pass it to flite
43exten => 1234,n,ReadFile(MYTEXT=/path/myfile,200)
44exten => 1234,n,Flite("${MYTEXT}",any)
45exten => 1234,n,Hangup()
46
47-------
48License
49-------
50The Flite module for asterisk is distributed under the GNU General Public
51License v2. See COPYING for details.
52
53--------
54Homepage
55--------
56http://zaf.github.io/Asterisk-Flite/
57