React Native Speech

React Native Speech is a text-to-speech library for React Native.

Documentation

Install

npm i --save react-native-speech

Usage

Linking the Library

In order to use Speech, you must first link the library your project. There's excellent documentation on how to do this in the React Native Docs.

Speaking an Utterance

Once you've linked the library, you'll want to make it available to your app by requiring it:

var Speech = require('react-native-speech');

Speaking an utterance is as simple as calling:

Speech.speak({
  text: 'React Native Speech is awesome!  I\'m going to use it in my next project.',
  voice: 'en-US'
});

Example

Using Speech in your app will usually look like this:

var Speech = require('react-native-speech');

var YourComponent = React.createClass({
  _startHandler() {
    Speech.speak({
      text: 'Aujourd\'hui, Maman est morte. Ou peut-être hier, je ne sais pas.',
      voice: 'fr-FR'
    })
    .then(started => {
      console.log('Speech started');
    })
    .catch(error => {
      console.log('You\'ve already started a speech instance.');
    });
  },

  _pauseHandler() {
    Speech.pause();
  },

  _resumeHandler() {
    Speech.resume();
  },

  _stopHandler() {
    Speech.stop();
  },

  render() {
    return (
      <View>
        ...
        <Button onPress={this._startHandler}>
          Speak
        </Button>
        <Button onPress={this._pauseHandler}>
          Pause
        </Button>
        <Button onPress={this._resumeHandler}>
          Resume
        </Button>
        <Button onPress={this._stopHandler}>
          Stop
        </Button>
      </View>
    );
  }
});

Methods

speak(utterance)

Initializes the speech instance and speaks the utterance provided.

Arguments

utterance - An Object containing the following keys: text, voice and, optionally, rate. rate is a float where lower numbers indicate slower speech.

Examples

Speech.speak({
  text: 'I was runnin\' through the 6 with my woes',
  voice: 'en-US',
  rate: 0.4
})
.then(started => {
  // Success code
})
.catch(error => {
  // Failure code
});

Speech.speak({
  text: 'I was runnin\' through the 6 with my woes',
  voice: 'en-US'
});

pause()

Pauses the speech instance.

Example

Speech.pause();

resume()

Resumes the speech instance.

Example

Speech.resume();

stop()

Stops and destroys the speech instance.

Example

Speech.stop();

isSpeaking()

Indicates whether speech is in progress.

Example

Speech.isSpeaking()
  .then(speaking => {
    console.log(speaking); // true or false
  });

isPaused()

Indicates whether speech is paused.

Example

Speech.isPaused()
  .then(paused => {
    console.log(paused); // true or false
  });

supportedVoices()

Indicates which speech voices are available.

Example

Speech.supportedVoices()
  .then(locales => {
    console.log(locales); // ["ar-SA", "en-ZA", "nl-BE", "en-AU", "th-TH", ...]
  });

License

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

trendingtechnology / react-native-speech Goto Github PK