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 com.android.internal.app;
18 
19 import android.app.PendingIntent;
20 import android.content.ComponentName;
21 import android.hardware.soundtrigger.IRecognitionStatusCallback;
22 import android.hardware.soundtrigger.SoundTrigger;
23 import android.hardware.soundtrigger.ModelParams;
24 import android.os.Bundle;
25 import android.os.ParcelUuid;
26 
27 /**
28  * Service interface for a generic sound recognition model.
29  * @hide
30  */
31 interface ISoundTriggerSession {
32 
getSoundModel(in ParcelUuid soundModelId)33     SoundTrigger.GenericSoundModel getSoundModel(in ParcelUuid soundModelId);
34 
updateSoundModel(in SoundTrigger.GenericSoundModel soundModel)35     void updateSoundModel(in SoundTrigger.GenericSoundModel soundModel);
36 
deleteSoundModel(in ParcelUuid soundModelId)37     void deleteSoundModel(in ParcelUuid soundModelId);
38 
startRecognition(in SoundTrigger.GenericSoundModel soundModel, in IRecognitionStatusCallback callback, in SoundTrigger.RecognitionConfig config, boolean runInBatterySaver)39     int startRecognition(in SoundTrigger.GenericSoundModel soundModel,
40          in IRecognitionStatusCallback callback,
41          in SoundTrigger.RecognitionConfig config, boolean runInBatterySaver);
42 
stopRecognition(in ParcelUuid soundModelId, in IRecognitionStatusCallback callback)43     int stopRecognition(in ParcelUuid soundModelId, in IRecognitionStatusCallback callback);
44 
loadGenericSoundModel(in SoundTrigger.GenericSoundModel soundModel)45     int loadGenericSoundModel(in SoundTrigger.GenericSoundModel soundModel);
loadKeyphraseSoundModel(in SoundTrigger.KeyphraseSoundModel soundModel)46     int loadKeyphraseSoundModel(in SoundTrigger.KeyphraseSoundModel soundModel);
47 
startRecognitionForService(in ParcelUuid soundModelId, in Bundle params, in ComponentName callbackIntent,in SoundTrigger.RecognitionConfig config)48     int startRecognitionForService(in ParcelUuid soundModelId, in Bundle params,
49          in ComponentName callbackIntent,in SoundTrigger.RecognitionConfig config);
50 
stopRecognitionForService(in ParcelUuid soundModelId)51     int stopRecognitionForService(in ParcelUuid soundModelId);
52 
unloadSoundModel(in ParcelUuid soundModelId)53     int unloadSoundModel(in ParcelUuid soundModelId);
54 
55     /** For both ...Intent and ...Service based usage */
isRecognitionActive(in ParcelUuid parcelUuid)56     boolean isRecognitionActive(in ParcelUuid parcelUuid);
57 
getModelState(in ParcelUuid soundModelId)58     int getModelState(in ParcelUuid soundModelId);
59 
getModuleProperties()60     @nullable SoundTrigger.ModuleProperties getModuleProperties();
61 
setParameter(in ParcelUuid soundModelId, in ModelParams modelParam, int value)62     int setParameter(in ParcelUuid soundModelId, in ModelParams modelParam,
63         int value);
64 
getParameter(in ParcelUuid soundModelId, in ModelParams modelParam)65     int getParameter(in ParcelUuid soundModelId, in ModelParams modelParam);
66 
queryParameter(in ParcelUuid soundModelId, in ModelParams modelParam)67     @nullable SoundTrigger.ModelParamRange queryParameter(in ParcelUuid soundModelId,
68         in ModelParams modelParam);
69 }
70