A texttospeech NativeScript plugin for Android & iOS
Run the following command from the root of your project:
$ tns plugin add nativescript-texttospeech
This command automatically installs the necessary files, as well as stores nativescript-texttospeech as a dependency in your project's package.json file.
Due to a current open issue with NativeScript, #669, the plugin needs to be added before adding any platforms with the tns add platform command.
To use the texttospeech module you must first require() it:
var tts = require("nativescript-texttospeech");After you have a reference to the module you can then call its speak(text, queue, pitch, speakRate, volume, language, callbackOnFinish) method.
// my-page.js
var tts = require("nativescript-texttospeech");
tts.speak("Sample text to be spoken", true, 1.0, 1.0, 1.0, "en-GB", this.onFinishSpeaking.bind(this));If you want to be notified when the speech has ended you can pass a function without params after the language identifier.
The callback is supported in both iOS and Android (API version >=21).
Other supported methods are:
tts.pause();
It will stop playing the current speech. In iOS an optional boolean parameter is supported: if it's true the pause will take effect immediately, otherwise (the default) it will stop after completing the current spoken word.
tts.resume();
It will continue to play current speech in iOS while on Android, due to platform limitations, will replay the text from start.
text is the only required argument - if it is not supplied the speak() method will not be called. For example, the following will run with no issues:
tts.speak("Sample text to be spoken");but the following will not call the speak() method:
tts.speak(true, 1.0, 1.0, 1.0, "en-GB");If more than one argument is supplied then they are applied from left to right. For example, the following will also run with no issues and will set values for text, queue and pitch:
tts.speak("Sample text to be spoken", true, 1.0);This means that if you only want to supply some arguments which are not necessarily in order from left to right (e.g. text and speakRate), you need to supply all arguments, even if you have to set some of them to null (or undefined). For example:
tts.speak("Sample text to be spoken", null, null, 0.75, null, null);For any arguments not given an explicit value the following defaults are used:
queue = false
pitch = 1.0
speakRate = 1.0
volume = 1.0
language = default system language
If you wish to set a custom language, you need to provide a valid ISO 639-1 language code, e.g. en-US. The plugin checks whether the supplied langauge code has the correct syntax but will not prevent setting a nonexistent language code. Please use this feature with caution.
Inspired by James Montemagno's TextToSpeech Xamarin plugin