cordova-plugin-tts's Introduction

Cordova Text-to-Speech Plugin

Platforms

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

Installation

cordova plugin add com.wordsbaking.cordova.tts

And then add the plugin definition to the top-level config.xml file within the element:

<plugin name="TTS" value="com.wordsbaking.cordova.tts"/>

Usage

// 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
    }, function () {
        alert('success');
    }, function (reason) {
        alert(reason);
    });

If you want to cancel speech then just say nothing:

// cancel usage
TTS.speak('', function () {
        alert('success');
    }, function (reason) {
        alert(reason);
    });

API Definitions

The onfulfilled callback will be called when the speech finishes, and the onrejected callback (Windows Phone only) will be called when an error occurs.

If the API is invoked when it's still speaking, the previous speaking will be canceled immediately, but the onfulfilled callback of the previous speaking will be called when it stops.

declare module TTS {
    interface IOptions {
        /** text to speak */
        text: string;
        /** a string like 'en-US', 'zh-CN', etc */
        locale?: string;
        /** speed rate, 0 ~ 1 */
        rate?: number;
    }

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

    /** for my own usage, or you may want to use my promise library ThenFail (https://github.com/vilic/thenfail)... */
    function speak(options: IOptions): ThenFail<void>;
    function speak(text: string): ThenFail<void>;
}

Recommend Projects