1 /*
2  * Copyright (C) 2014 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.hardware.soundtrigger;
18 
19 import android.hardware.soundtrigger.SoundTrigger;
20 
21 /**
22  * @hide
23  */
24 oneway interface IRecognitionStatusCallback {
25     /**
26      * Called when the keyphrase is spoken.
27      *
28      * @param recognitionEvent Object containing data relating to the
29      *                         keyphrase recognition event such as keyphrase
30      *                         extras.
31      */
onKeyphraseDetected(in SoundTrigger.KeyphraseRecognitionEvent recognitionEvent)32     void onKeyphraseDetected(in SoundTrigger.KeyphraseRecognitionEvent recognitionEvent);
33 
34    /**
35      * Called when a generic sound trigger event is witnessed.
36      *
37      * @param recognitionEvent Object containing data relating to the
38      *                         recognition event such as trigger audio data (if
39      *                         requested).
40      */
41 
onGenericSoundTriggerDetected(in SoundTrigger.GenericRecognitionEvent recognitionEvent)42     void onGenericSoundTriggerDetected(in SoundTrigger.GenericRecognitionEvent recognitionEvent);
43 
44     /**
45      * Called when the recognition is paused temporarily for some reason.
46      */
onRecognitionPaused()47     void onRecognitionPaused();
48     /**
49      * Called when the recognition is resumed after it was temporarily paused.
50      */
onRecognitionResumed()51     void onRecognitionResumed();
52 
53     // Error callbacks to follow
54     /**
55      * Called when this recognition has been preempted by another.
56      */
onPreempted()57     void onPreempted();
58 
59     /**
60      * Called when the underlying ST module service has died.
61      */
onModuleDied()62     void onModuleDied();
63 
64     /**
65      * Called when the service failed to gracefully resume recognition following a pause.
66      * @param status - The received error code.
67      */
onResumeFailed(int status)68     void onResumeFailed(int status);
69 
70     /**
71      * Called when the service failed to pause recognition when required.
72      * TODO(b/276507281) Remove. This should never happen, so we should abort instead.
73      * @param status - The received error code.
74      */
onPauseFailed(int status)75     void onPauseFailed(int status);
76 }
77