| android.speech.tts.SynthesisCallback |
A callback to return speech data synthesized by a text to speech engine.
The engine can provide streaming audio by calling
start(int, int, int), then audioAvailable(byte[], int, int) until all audio has been provided, then finally
done().
error() can be called at any stage in the synthesis process to
indicate that an error has occurred, but if the call is made after a call
to done(), it might be discarded.
After start(int, int, int) been called, done() must be called regardless of errors.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
The service should call this method when synthesized audio is ready for consumption.
| |||||||||||
The service should call this method when all the synthesized audio for a request has
been passed to
audioAvailable(byte[], int, int). | |||||||||||
The service should call this method if the speech synthesis fails.
| |||||||||||
The service should call this when it starts to synthesize audio for this
request.
| |||||||||||
The service should call this method when synthesized audio is ready for consumption.
This method should only be called on the synthesis thread,
while in onSynthesizeText(SynthesisRequest, SynthesisCallback).
| buffer | The generated audio data. This method will not hold on to buffer,
so the caller is free to modify it after this method returns. |
|---|---|
| offset | The offset into buffer where the audio data starts. |
| length | The number of bytes of audio data in buffer. This must be
less than or equal to the return value of getMaxBufferSize(). |
The service should call this method when all the synthesized audio for a request has
been passed to audioAvailable(byte[], int, int).
This method should only be called on the synthesis thread,
while in onSynthesizeText(SynthesisRequest, SynthesisCallback).
This method has to be called if start(int, int, int) was called.
The service should call this method if the speech synthesis fails.
This method should only be called on the synthesis thread,
while in onSynthesizeText(SynthesisRequest, SynthesisCallback).
audioAvailable(byte[], int, int). Calls to audioAvailable(byte[], int, int) with data lengths
larger than this value will not succeed.
The service should call this when it starts to synthesize audio for this
request.
This method should only be called on the synthesis thread,
while in onSynthesizeText(SynthesisRequest, SynthesisCallback).
| sampleRateInHz | Sample rate in HZ of the generated audio. |
|---|---|
| audioFormat | Audio format of the generated audio. Must be one of
the ENCODING_ constants defined in AudioFormat. |
| channelCount | The number of channels. Must be 1 or 2. |