Cordova Text-to-Speech Plugin

Platforms

iOS 7+
Windows Phone 8
Android 4.0.3+ (API Level 15+)

Installation

cordova plugin add https://github.com/kanayo/cordova-plugin-tts.git

Usage

// make sure your the code gets executed only after `deviceready`.
document.addEventListener('deviceready', function () {
    // basic usage
    TTS.speak('hello, world!', function () {
            alert('success');
        }, function (reason) {
            alert(reason);
        });
    
    // or with more options
    TTS.speak({
            text: 'hello, world!',
            locale: 'en-GB',
            rate: 0.75,
            preDelay: 1000
        }, function () {
            alert('success');
        }, function (reason) {
            alert(reason);
        });
}, false);

API Definitions

The onfulfilled callback will be called when the speech finishes, and the onrejected callback will be called when an error occurs.

speak() adds an utterence to a queue and returns immediately.

To interurupt and flush the queue, call stop()

declare module TTS {
    interface IOptions {
        /** text to speak */
        text: string;
        /** a string like 'en-US', 'zh-CN', etc (default: en-US)*/
        locale?: string;
        /** speed rate, 0 ~ 1 (default: 1)*/
        rate?: number;
        /** ms delay before utterance (default: 0) **/
        preDelay?: number;
        /** ms delay after utterance (default: 0)**/
        postDelay?: number;
    }

    function speak(options: IOptions, onfulfilled: () => void, onrejected: (reason) => void): void;
    function speak(text: string, onfulfilled: () => void, onrejected: (reason) => void): void;
    function stop(): void;
}