Android Text-to-Speech simplified.
Clone or download
Latest commit ebb626b Oct 27, 2016

README.md

Speakerbox

Circle CI Build Status

Android Text-to-Speech simplified.

Usage

Speakerbox simplifies basic TextToSpeech tasks and adds new tools including muting and text substitution.

Initialization

Speakerbox creates and manages a new instance of TextToSpeech for a given activity.

Speakerbox speakerbox = new Speakerbox(activity);

There is no need to create your own OnInitListener. If you pass text to Speakerbox before the TextToSpeech engine has finished initializing it will save the text and automatically play it once initialization is complete.

Play

Synthesizing text to speech with Speakerbox is simple. The text will play immediately or once initialization is complete (see above).

Speakerbox speakerbox = new Speakerbox(activity);
speakerbox.play("Hi");

// Hi

Mute/Unmute

Speakerbox adds the ability to mute/unmute spoken text.

Speakerbox speakerbox = new Speakerbox(activity);
speakerbox.mute();
speakerbox.play("Quiet please");
speakerbox.unmute();
spearkerbox.play("Cry out loud");

// Cry out loud

Remix

Substitute spoken text on the fly using the remix feature.

Speakerbox speakerbox = new Speakerbox(activity);
speakerbox.remix("min", "minutes");
speakerbox.play("The show starts in 5 min.");

// The show starts in 5 minutes.

Shutdown

Speakerbox will automatically shutdown the TextToSpeech engine and release its resources when the host activity is destroyed so you don't have to.

Install

Download Jar

Download the latest JAR.

Maven

Include dependency using Maven.

<dependency>
  <groupId>com.mapzen.android</groupId>
  <artifactId>speakerbox</artifactId>
  <version>1.4.1</version>
</dependency>

Gradle

Include dependency using Gradle.

compile 'com.mapzen.android:speakerbox:1.4.1'