1 /*
2  * Copyright (C) 2009 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  */
16 
17 package android.speech;
18 
19 import android.os.Bundle;
20 import android.content.Intent;
21 import android.speech.IRecognitionListener;
22 
23 /**
24 * A Service interface to speech recognition. Call startListening when
25 * you want to begin capturing audio; RecognitionService will automatically
26 * determine when the user has finished speaking, stream the audio to the
27 * recognition servers, and notify you when results are ready. In most of the cases,
28 * this class should not be used directly, instead use {@link SpeechRecognizer} for
29 * accessing recognition service.
30 * {@hide}
31 */
32 oneway interface IRecognitionService {
33     /**
34      * Starts listening for speech. Please note that the recognition service supports
35      * one listener only, therefore, if this function is called from two different threads,
36      * only the latest one will get the notifications
37      *
38      * @param recognizerIntent the intent from which the invocation occurred. Additionally,
39      *        this intent can contain extra parameters to manipulate the behavior of the recognition
40      *        client. For more information see {@link RecognizerIntent}.
41      * @param listener to receive callbacks, note that this must be non-null
42      */
startListening(in Intent recognizerIntent, in IRecognitionListener listener)43     void startListening(in Intent recognizerIntent, in IRecognitionListener listener);
44 
45     /**
46      * Stops listening for speech. Speech captured so far will be recognized as
47      * if the user had stopped speaking at this point. The function has no effect unless it
48      * is called during the speech capturing.
49      *
50      * @param listener to receive callbacks, note that this must be non-null
51      */
stopListening(in IRecognitionListener listener)52     void stopListening(in IRecognitionListener listener);
53 
54     /**
55      * Cancels the speech recognition.
56      *
57      * @param listener to receive callbacks, note that this must be non-null
58      */
cancel(in IRecognitionListener listener)59     void cancel(in IRecognitionListener listener);
60 }
61