Final Pull (untouched from some day) (#5)

* Update TiTtsModule.java

Author: Informate

README.md

@@ -5,8 +5,24 @@ Simple tts (text-to-speech) module for Titanium SDK. Allows you to say a sentenc
 ## Methods
 
 -   <b>init()</b>
--   <b>speak(string)</b> - There is a character limit of 4000 characters per speak method
--   <b>synthesizeToFile(string)</b>
+-   <b>init( engine: string )</b> - Init specific TTS Engine if available
+-   <b>speak({ text: string, uid: string, volume: float, pan: float, flush: boolean })</b> - There is a character limit (of 4000 characters) per speak method. The exact maximum allowed length can be read from the bufferlen property.
+-   <b>synthesizeToFile({ text: string, filename: string, uid: string, volume: float, pan: float, blob: boolean })</b>
+-   <b>stop()</b>
+-   <b>shutdown()</b>
+-   <b>setup({ voice: string, language: string, volume: float, pan: float, speed: float, pitch: float, flush: boolean, uid: boolean, filename: string, blob: boolean})</b> - Default configuration for Speaker
+-   <b>getVoices( filter: string )</b> - Returns a string with voices separated by a `|`. Optionally you can pass in a string to filter on voices names, for example `de-de` to only get German voices.
+-   <b>getVoiceList( filter: string )</b>
+-   <b>getEngines()</b>
+-   <b>getEngineList()</b>
+-   <b>getEnginePackageList()</b> - The Engines' Package Name for init(engine) and setEngine(engine).
+-   <b>getLanguages()</b>
+-   <b>getLanguageList()</b>
+-   <b>getVoiceFeatures( voice: string )</b>
+-   <b>initSilent()</b> - Init without events emitter (except for the init event once).
+-   <b>emitEvents()</b> - Start events emitter.
+-   <b>separateSpeaker()</b> - Return a new Instance of TTS ( Experimental feature, marked as Deprecated to notify it).
+-   <b>setEngine( engine: string )</b> - Deprecated, because do not emit the init event when the engine is ready. Use init(engine) instead.
 
 ## Properties
 
@@ -15,35 +31,84 @@ Simple tts (text-to-speech) module for Titanium SDK. Allows you to say a sentenc
 -   <b>voices</b> (getter): string. Returns a string with voices separated by a `|`. Optional you can pass in `de-de` to only get German voices.
 -   <b>voice</b> (setter): string
 -   <b>language</b> (setter): string. e.g. `de` or `en`
+-   <b>speaking</b> (getter): boolean. (DO NOT RELY ON THIS ON INIT! You could need to start flushing the queque after init. )
+-   <b>bufferlen</b> (getter): int. Maximum length of the text string to read (Usually 4000 character)
 
 ## Events
 
--   <b>init()</b>: when TTS is ready
--   <b>done()</b>: returns `blob` with the sound file
+-   <b>init</b>: when TTS is ready - CallBack({ status: int })
+-   <b>stop</b>: when TTS stops - CallBack({ uid: string, interrupted: boolean })
+-   <b>error</b>: when TTS fails - CallBack({ uid: string, code: int })
+-   <b>done</b>: when TTS has done (Could include a Blob for synthesizeToFile)- CallBack({ uid: string, blob: Blob })
 
+## Voices' names
+
+ Voices' names are in the format:
+
+    <lang>-<region>-x-<flags>-<type>
+    
+ Where:
+  - &lt;lang&gt; and &lt;region&gt; are 2 char ISO codes (i.e. `it`, `de`, `en`)
+  - &lt;flags&gt; is a usually 3 char voice description
+  - &lt;type&gt; can be `local` (on device voice), `network` (on cloud voice) or `language` (not specified)
+
+## Engines' names
+
+ Engines' names from getEngines and getEngineList are in the format:
+
+    <name> @<package>
+    
+ Where:
+  - &lt;name&gt; is the engine label name
+  - &lt;package&gt; is the engine pakage name for setEngine(engine) and init(engine)
+
+ Engines' Package Names List can be retrived from getEnginePackageList().
+
+## Setup Attributes
+
+ - volume: Float, Range [ 0 , 1 ], Default 1.
+ - pan: Float, Range [ -1 , 1 ], Default 0.
+ - pitch: Float, Default 1, lower for lower voice tone, greater to increase.
+ - speed: Float, Default 1, 2 double speed, 0.5 half speed.
+ - flush: Boolean, FLUSH the speak queque or ADD the text to speak to the queue (only for speak method).
+ - blob: Retrive Blob to done event (only for synthesizeToFile method).
+ - filename: File name (only for synthesizeToFile method).
+ - uid: Utterance ID.
+
+## Notes
+
+ - There is a limit of bufferlen (4000) characters for each call to speak and synthesizeToFile.
+ - Sometimes after the init event a queque FLUSH could be needed to start speaking (especially if speaking is true).
+ 
 ## Example
 
 ```js
 const tts = require("ti.tts");
 const win = Ti.UI.createWindow();
 
-win.open();
+tts.addEventListener("init", function(e) {
+
+	tts.speak({text:"Hello World!", flush:true});
+});
 
 win.addEventListener("open", function() {
 	tts.init();
 });
-tts.addEventListener("init", function(e) {
-	tts.speak("Hello");
+win.addEventListener("close", function() {
+	tts.shutdown();
 });
+
+win.open();
 ```
 
 ## Note
 
 Needs Android 21 or higher.
 
 
-## Author
+## Authors
 
 * Michael Gangolf (<a href="https://github.com/m1ga">@MichaelGangolf</a> / <a href="https://www.migaweb.de">Web</a>)
+* T. A. (<a href="https://github.com/informate">@TA</a> / <a href="https://www.informate.it">Web</a>)
 
 <span class="badge-buymeacoffee"><a href="https://www.buymeacoffee.com/miga" title="donate"><img src="https://img.shields.io/badge/buy%20me%20a%20coke-donate-orange.svg" alt="Buy Me A Coke donate button" /></a></span>