1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.speech.tts;
/**
* Interface for callbacks from TextToSpeechService
*
* {@hide}
*/
oneway interface ITextToSpeechCallback {
/**
* Tells the client that the synthesis has started playing.
*
* @param utteranceId Unique id identifying the synthesis request.
*/
void onStart(String utteranceId);
/**
* Tells the client that the synthesis has finished playing.
*
* @param utteranceId Unique id identifying the synthesis request.
*/
void onSuccess(String utteranceId);
/**
* Tells the client that the synthesis was stopped.
*
* @param utteranceId Unique id identifying the synthesis request.
*/
void onStop(String utteranceId, boolean isStarted);
/**
* Tells the client that the synthesis has failed.
*
* @param utteranceId Unique id identifying the synthesis request.
* @param errorCode One of the values from
* {@link android.speech.tts.v2.TextToSpeech}.
*/
void onError(String utteranceId, int errorCode);
/**
* Tells the client that the TTS engine has started synthesizing the audio for a request.
*
* <p>
* This doesn't mean the synthesis request has already started playing (for example when there
* are synthesis requests ahead of it in the queue), but after receiving this callback you can
* expect onAudioAvailable to be called.
* </p>
*
* @param utteranceId Unique id identifying the synthesis request.
* @param sampleRateInHz Sample rate in HZ of the generated audio.
* @param audioFormat The audio format of the generated audio in the {@link #onAudioAvailable}
* call. Should be one of {@link android.media.AudioFormat.ENCODING_PCM_8BIT},
* {@link android.media.AudioFormat.ENCODING_PCM_16BIT} or
* {@link android.media.AudioFormat.ENCODING_PCM_FLOAT}.
* @param channelCount The number of channels.
*/
void onBeginSynthesis(String utteranceId, int sampleRateInHz, int audioFormat, int channelCount);
/**
* Tells the client about a chunk of the synthesized audio.
*
* <p>
* Called when a chunk of the synthesized audio is ready. This may be called more than once for
* every synthesis request, thereby streaming the audio to the client.
* </p>
*
* @param utteranceId Unique id identifying the synthesis request.
* @param audio The raw audio bytes. Its format is specified by the {@link #onStartAudio}
* callback.
*/
void onAudioAvailable(String utteranceId, in byte[] audio);
/**
* Tells the client that the engine is about to speak the specified range of the utterance.
*
* <p>
* Only called if the engine supplies timing information by calling
* {@link SynthesisCallback#rangeStart(int, int, int)} and only when the request is played back
* by the service, not when using {@link android.speech.tts.TextToSpeech#synthesizeToFile}.
* </p>
*
* @param utteranceId Unique id identifying the synthesis request.
* @param start The start character index of the range in the utterance text.
* @param end The end character index of the range (exclusive) in the utterance text.
* @param frame The start position in frames in the audio of the request where this range is
* spoken.
*/
void onRangeStart(String utteranceId, int start, int end, int frame);
}
|
