VoiceInteractionService.java revision 055897208d659e9734a82def88be4a806ff55448
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 17package android.service.voice; 18 19import android.annotation.SdkConstant; 20import android.app.Service; 21import android.content.ComponentName; 22import android.content.Context; 23import android.content.Intent; 24import android.hardware.soundtrigger.KeyphraseEnrollmentInfo; 25import android.os.Bundle; 26import android.os.Handler; 27import android.os.IBinder; 28import android.os.Message; 29import android.os.RemoteException; 30import android.os.ServiceManager; 31 32import android.provider.Settings; 33import com.android.internal.annotations.VisibleForTesting; 34import com.android.internal.app.IVoiceInteractionManagerService; 35 36 37/** 38 * Top-level service of the current global voice interactor, which is providing 39 * support for hotwording, the back-end of a {@link android.app.VoiceInteractor}, etc. 40 * The current VoiceInteractionService that has been selected by the user is kept 41 * always running by the system, to allow it to do things like listen for hotwords 42 * in the background to instigate voice interactions. 43 * 44 * <p>Because this service is always running, it should be kept as lightweight as 45 * possible. Heavy-weight operations (including showing UI) should be implemented 46 * in the associated {@link android.service.voice.VoiceInteractionSessionService} when 47 * an actual voice interaction is taking place, and that service should run in a 48 * separate process from this one. 49 */ 50public class VoiceInteractionService extends Service { 51 /** 52 * The {@link Intent} that must be declared as handled by the service. 53 * To be supported, the service must also require the 54 * {@link android.Manifest.permission#BIND_VOICE_INTERACTION} permission so 55 * that other applications can not abuse it. 56 */ 57 @SdkConstant(SdkConstant.SdkConstantType.SERVICE_ACTION) 58 public static final String SERVICE_INTERFACE = 59 "android.service.voice.VoiceInteractionService"; 60 61 /** 62 * Name under which a VoiceInteractionService component publishes information about itself. 63 * This meta-data should reference an XML resource containing a 64 * <code><{@link 65 * android.R.styleable#VoiceInteractionService voice-interaction-service}></code> tag. 66 */ 67 public static final String SERVICE_META_DATA = "android.voice_interaction"; 68 69 IVoiceInteractionService mInterface = new IVoiceInteractionService.Stub() { 70 @Override public void ready() { 71 mHandler.sendEmptyMessage(MSG_READY); 72 } 73 }; 74 75 MyHandler mHandler; 76 77 IVoiceInteractionManagerService mSystemService; 78 79 private KeyphraseEnrollmentInfo mKeyphraseEnrollmentInfo; 80 81 static final int MSG_READY = 1; 82 83 class MyHandler extends Handler { 84 @Override 85 public void handleMessage(Message msg) { 86 switch (msg.what) { 87 case MSG_READY: 88 onReady(); 89 break; 90 default: 91 super.handleMessage(msg); 92 } 93 } 94 } 95 96 /** 97 * Check whether the given service component is the currently active 98 * VoiceInteractionService. 99 */ 100 public static boolean isActiveService(Context context, ComponentName service) { 101 String cur = Settings.Secure.getString(context.getContentResolver(), 102 Settings.Secure.VOICE_INTERACTION_SERVICE); 103 if (cur == null || cur.isEmpty()) { 104 return false; 105 } 106 ComponentName curComp = ComponentName.unflattenFromString(cur); 107 if (curComp == null) { 108 return false; 109 } 110 return curComp.equals(cur); 111 } 112 113 /** 114 * Initiate the execution of a new {@link android.service.voice.VoiceInteractionSession}. 115 * @param args Arbitrary arguments that will be propagated to the session. 116 */ 117 public void startSession(Bundle args) { 118 if (mSystemService == null) { 119 throw new IllegalStateException("Not available until onReady() is called"); 120 } 121 try { 122 mSystemService.startSession(mInterface, args); 123 } catch (RemoteException e) { 124 } 125 } 126 127 @Override 128 public void onCreate() { 129 super.onCreate(); 130 mHandler = new MyHandler(); 131 } 132 133 @Override 134 public IBinder onBind(Intent intent) { 135 if (SERVICE_INTERFACE.equals(intent.getAction())) { 136 return mInterface.asBinder(); 137 } 138 return null; 139 } 140 141 /** 142 * Called during service initialization to tell you when the system is ready 143 * to receive interaction from it. You should generally do initialization here 144 * rather than in {@link #onCreate()}. Methods such as {@link #startSession} 145 * and {@link #getAlwaysOnHotwordDetector} will not be operational until this point. 146 */ 147 public void onReady() { 148 mSystemService = IVoiceInteractionManagerService.Stub.asInterface( 149 ServiceManager.getService(Context.VOICE_INTERACTION_MANAGER_SERVICE)); 150 mKeyphraseEnrollmentInfo = new KeyphraseEnrollmentInfo(getPackageManager()); 151 } 152 153 /** 154 * @param keyphrase The keyphrase that's being used, for example "Hello Android". 155 * @param locale The locale for which the enrollment needs to be performed. 156 * This is a Java locale, for example "en_US". 157 * @param callback The callback to notify of detection events. 158 * @return An always-on hotword detector for the given keyphrase and locale. 159 */ 160 public final AlwaysOnHotwordDetector getAlwaysOnHotwordDetector( 161 String keyphrase, String locale, AlwaysOnHotwordDetector.Callback callback) { 162 if (mSystemService == null) { 163 throw new IllegalStateException("Not available until onReady() is called"); 164 } 165 // TODO: Cache instances and return the same one instead of creating a new interactor 166 // for the same keyphrase/locale combination. 167 return new AlwaysOnHotwordDetector(keyphrase, locale, callback, 168 mKeyphraseEnrollmentInfo, mInterface, mSystemService); 169 } 170 171 /** 172 * @return Details of keyphrases available for enrollment. 173 * @hide 174 */ 175 @VisibleForTesting 176 protected final KeyphraseEnrollmentInfo getKeyphraseEnrollmentInfo() { 177 return mKeyphraseEnrollmentInfo; 178 } 179} 180