README.md

openfpt-ng-tts

An AngularJS service to speak the text via the OpenFPT TTS (text-to-speech) API.

Installation

Install through bower:

# from the terminal at the root of your project
bower install openfpt-ng-tts --save

Or you can install by this repo (not recommended)

# from the terminal at the root of your project
bower install fpt-corp/angular-tts --save

Add to your module deps

angular.module('xxx', ['fpt.angular-tts']);

Use

Get the API Key

Go to Open FPT API Developer Portal to get your API Key

Create a HTML Audio players on HTML file

    <audio id="openfpt-tts"> </audio>

Inject the service

Add openfptTts as injection to use in angular controller

angular.module('myApp').controller('HomeCtrl', ['$scope', 'openfptTts', function ($scope, openfptTts) {
    // Your code goes here   
}];

Global config

openfptTts.apiKey = 'YOUR_API_GOES_HERE';
openfptTts.elementId = 'openfpt-tts'; //default is 'openfpt-tts'
openfptTts.voice = 'both'; //default is 'both'
openfptTts.speed = 0; //default is 0

• voice option can be male | female | both. When voice is set to both, the engine will speak with male voice and female voice sequentially.
• speed option can be:
  • -3 : extreme slow
  • -2 : very slow
  • -1 : slow
  • 0 : normal (default)
  • 1 : fast
  • 2 : very fast
  • 3 : extreme fast

Method

openfptTts.speak(text, options, cb): Speak a singleline of text.

• text string: Text you want to speak.
• cb nodejs callback cb(err)

openfptTts.speakArray(textArray, options, cb): Speak sequentially.

• textArray array[string]: Text you want to speak.
• cb nodejs callback cb(err)