ITextToSpeechCallback.aidl revision 4b73867a12a9339c7788e8949aac4a32d2eee22b 
1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package android.speech.tts;
17
18/**
19 * Interface for callbacks from TextToSpeechService
20 *
21 * {@hide}
22 */
23oneway interface ITextToSpeechCallback {
24    /**
25     * Tells the client that the synthesis has started.
26     *
27     * @param utteranceId Unique id identifying synthesis request.
28     */
29    void onStart(String utteranceId);
30
31    /**
32     * Tells the client that the synthesis has finished.
33     *
34     * @param utteranceId Unique id identifying synthesis request.
35     */
36    void onSuccess(String utteranceId);
37
38    /**
39     * Tells the client that the synthesis was stopped.
40     *
41     * @param utteranceId Unique id identifying synthesis request.
42     */
43    void onStop(String utteranceId, boolean isStarted);
44
45    /**
46     * Tells the client that the synthesis has failed.
47     *
48     * @param utteranceId Unique id identifying synthesis request.
49     * @param errorCode One of the values from
50     *        {@link android.speech.tts.v2.TextToSpeech}.
51     */
52    void onError(String utteranceId, int errorCode);
53
54}
55