VoiceInteractor.java revision a2c076d54048258cf88ab14551ce5fdf5a09c6e8
191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn/* 291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * Copyright (C) 2014 The Android Open Source Project 391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * 491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * Licensed under the Apache License, Version 2.0 (the "License"); 591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * you may not use this file except in compliance with the License. 691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * You may obtain a copy of the License at 791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * 891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * http://www.apache.org/licenses/LICENSE-2.0 991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * 1091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * Unless required by applicable law or agreed to in writing, software 1191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * distributed under the License is distributed on an "AS IS" BASIS, 1291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * See the License for the specific language governing permissions and 1491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * limitations under the License. 1591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn */ 1691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 1791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornpackage android.app; 1891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 1991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.content.Context; 2091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.os.Bundle; 2191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.os.IBinder; 2291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.os.Looper; 2391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.os.Message; 2491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.os.RemoteException; 2518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackbornimport android.util.ArrayMap; 2691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport android.util.Log; 2791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport com.android.internal.app.IVoiceInteractor; 2891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport com.android.internal.app.IVoiceInteractorCallback; 2991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport com.android.internal.app.IVoiceInteractorRequest; 3091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport com.android.internal.os.HandlerCaller; 3191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornimport com.android.internal.os.SomeArgs; 3291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 3320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackbornimport java.util.ArrayList; 3491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 3591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn/** 36a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * Interface for an {@link Activity} to interact with the user through voice. Use 37a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * {@link android.app.Activity#getVoiceInteractor() Activity.getVoiceInteractor} 38a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * to retrieve the interface, if the activity is currently involved in a voice interaction. 39a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * 40a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * <p>The voice interactor revolves around submitting voice interaction requests to the 41a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * back-end voice interaction service that is working with the user. These requests are 42a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * submitted with {@link #submitRequest}, providing a new instance of a 43a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * {@link Request} subclass describing the type of operation to perform -- currently the 44a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * possible requests are {@link ConfirmationRequest} and {@link CommandRequest}. 45a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * 46a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * <p>Once a request is submitted, the voice system will process it and evetually deliver 47a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * the result to the request object. The application can cancel a pending request at any 48a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * time. 49a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * 50a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * <p>The VoiceInteractor is integrated with Activity's state saving mechanism, so that 51a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * if an activity is being restarted with retained state, it will retain the current 52a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * VoiceInteractor and any outstanding requests. Because of this, you should always use 53a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * {@link Request#getActivity() Request.getActivity} to get back to the activity of a 54a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * request, rather than holding on to the actvitity instance yourself, either explicitly 55a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * or implicitly through a non-static inner class. 5691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn */ 5791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackbornpublic class VoiceInteractor { 5891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn static final String TAG = "VoiceInteractor"; 5991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn static final boolean DEBUG = true; 6091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 6191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn final IVoiceInteractor mInteractor; 6220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 6320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn Context mContext; 6420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn Activity mActivity; 6520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 6691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn final HandlerCaller mHandlerCaller; 6791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn final HandlerCaller.Callback mHandlerCallerCallback = new HandlerCaller.Callback() { 6891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn @Override 6991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn public void executeMessage(Message msg) { 7091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn SomeArgs args = (SomeArgs)msg.obj; 7118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Request request; 7291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn switch (msg.what) { 7391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn case MSG_CONFIRMATION_RESULT: 7418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request = pullRequest((IVoiceInteractorRequest)args.arg1, true); 7591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn if (DEBUG) Log.d(TAG, "onConfirmResult: req=" 7618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn + ((IVoiceInteractorRequest)args.arg1).asBinder() + "/" + request 7718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn + " confirmed=" + msg.arg1 + " result=" + args.arg2); 7818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn if (request != null) { 7918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn ((ConfirmationRequest)request).onConfirmationResult(msg.arg1 != 0, 8018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn (Bundle) args.arg2); 8118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.clear(); 8218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 8391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn break; 84a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn case MSG_ABORT_VOICE_RESULT: 85a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn request = pullRequest((IVoiceInteractorRequest)args.arg1, true); 86a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn if (DEBUG) Log.d(TAG, "onAbortVoice: req=" 87a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn + ((IVoiceInteractorRequest)args.arg1).asBinder() + "/" + request 88a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn + " result=" + args.arg1); 89a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn if (request != null) { 90a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn ((AbortVoiceRequest)request).onAbortResult((Bundle) args.arg2); 91a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn request.clear(); 92a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 93a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn break; 9491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn case MSG_COMMAND_RESULT: 9518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request = pullRequest((IVoiceInteractorRequest)args.arg1, msg.arg1 != 0); 9691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn if (DEBUG) Log.d(TAG, "onCommandResult: req=" 9718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn + ((IVoiceInteractorRequest)args.arg1).asBinder() + "/" + request 9891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn + " result=" + args.arg2); 9918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn if (request != null) { 10018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn ((CommandRequest)request).onCommandResult((Bundle) args.arg2); 10118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn if (msg.arg1 != 0) { 10218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.clear(); 10318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 10418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 10591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn break; 10691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn case MSG_CANCEL_RESULT: 10718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request = pullRequest((IVoiceInteractorRequest)args.arg1, true); 10891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn if (DEBUG) Log.d(TAG, "onCancelResult: req=" 10918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn + ((IVoiceInteractorRequest)args.arg1).asBinder() + "/" + request); 11018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn if (request != null) { 11118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.onCancel(); 11218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.clear(); 11318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 11491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn break; 11591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 11691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 11791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn }; 11891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 11918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final IVoiceInteractorCallback.Stub mCallback = new IVoiceInteractorCallback.Stub() { 12018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn @Override 12118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void deliverConfirmationResult(IVoiceInteractorRequest request, boolean confirmed, 12218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Bundle result) { 12318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mHandlerCaller.sendMessage(mHandlerCaller.obtainMessageIOO( 12418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn MSG_CONFIRMATION_RESULT, confirmed ? 1 : 0, request, result)); 12518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 12618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 12718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn @Override 128a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn public void deliverAbortVoiceResult(IVoiceInteractorRequest request, Bundle result) { 129a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn mHandlerCaller.sendMessage(mHandlerCaller.obtainMessageOO( 130a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn MSG_ABORT_VOICE_RESULT, request, result)); 131a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 132a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn 133a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn @Override 13418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void deliverCommandResult(IVoiceInteractorRequest request, boolean complete, 13518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Bundle result) { 13618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mHandlerCaller.sendMessage(mHandlerCaller.obtainMessageIOO( 13718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn MSG_COMMAND_RESULT, complete ? 1 : 0, request, result)); 13818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 13918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 14018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn @Override 14118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void deliverCancel(IVoiceInteractorRequest request) throws RemoteException { 14218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mHandlerCaller.sendMessage(mHandlerCaller.obtainMessageO( 14318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn MSG_CANCEL_RESULT, request)); 14418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 14518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn }; 14618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 14718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final ArrayMap<IBinder, Request> mActiveRequests = new ArrayMap<IBinder, Request>(); 14891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 14991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn static final int MSG_CONFIRMATION_RESULT = 1; 150a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn static final int MSG_ABORT_VOICE_RESULT = 2; 151a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn static final int MSG_COMMAND_RESULT = 3; 152a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn static final int MSG_CANCEL_RESULT = 4; 15391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 15418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public static abstract class Request { 15518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorRequest mRequestInterface; 15618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Context mContext; 15718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Activity mActivity; 15891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 15918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public Request() { 16091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 16191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 16291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn public void cancel() { 16391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn try { 16491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn mRequestInterface.cancel(); 16591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } catch (RemoteException e) { 16691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn Log.w(TAG, "Voice interactor has died", e); 16791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 16891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 16918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 17018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public Context getContext() { 17118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn return mContext; 17218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 17318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 17418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public Activity getActivity() { 17518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn return mActivity; 17618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 17718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 17818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void onCancel() { 17918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 18018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 18120d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn public void onAttached(Activity activity) { 18220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 18320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 18420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn public void onDetached() { 18520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 18620d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 18718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn void clear() { 18818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mRequestInterface = null; 18918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mContext = null; 19018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mActivity = null; 19118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 19218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 19318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn abstract IVoiceInteractorRequest submit(IVoiceInteractor interactor, 19418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn String packageName, IVoiceInteractorCallback callback) throws RemoteException; 19591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 19691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 19718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public static class ConfirmationRequest extends Request { 19818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final CharSequence mPrompt; 19918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final Bundle mExtras; 20091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 20118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn /** 20218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * Confirms an operation with the user via the trusted system 20318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * VoiceInteractionService. This allows an Activity to complete an unsafe operation that 20418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * would require the user to touch the screen when voice interaction mode is not enabled. 20518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * The result of the confirmation will be returned through an asynchronous call to 20618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * either {@link #onConfirmationResult(boolean, android.os.Bundle)} or 20718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * {@link #onCancel()}. 20818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * 20918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * <p>In some cases this may be a simple yes / no confirmation or the confirmation could 21018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * include context information about how the action will be completed 21118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * (e.g. booking a cab might include details about how long until the cab arrives) 21218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * so the user can give a confirmation. 21318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * @param prompt Optional confirmation text to read to the user as the action being 21418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * confirmed. 21518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * @param extras Additional optional information. 21618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn */ 21718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public ConfirmationRequest(CharSequence prompt, Bundle extras) { 21818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mPrompt = prompt; 21918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mExtras = extras; 22018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 22191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 22218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void onConfirmationResult(boolean confirmed, Bundle result) { 22318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 22491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 22518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorRequest submit(IVoiceInteractor interactor, String packageName, 22618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorCallback callback) throws RemoteException { 227a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn return interactor.startConfirmation(packageName, callback, mPrompt, mExtras); 22818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 229a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 230a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn 231a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn public static class AbortVoiceRequest extends Request { 232a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn final CharSequence mMessage; 233a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn final Bundle mExtras; 234a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn 235a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn /** 236a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * Reports that the current interaction can not be complete with voice, so the 237a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * application will need to switch to a traditional input UI. Applications should 238a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * only use this when they need to completely bail out of the voice interaction 239a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * and switch to a traditional UI. When the resonsponse comes back, the voice 240a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * system has handled the request and is ready to switch; at that point the application 241a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * can start a new non-voice activity. Be sure when starting the new activity 242a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * to use {@link android.content.Intent#FLAG_ACTIVITY_NEW_TASK 243a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * Intent.FLAG_ACTIVITY_NEW_TASK} to keep the new activity out of the current voice 244a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * interaction task. 245a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * 246a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * @param message Optional message to tell user about not being able to complete 247a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * the interaction with voice. 248a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn * @param extras Additional optional information. 249a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn */ 250a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn public AbortVoiceRequest(CharSequence message, Bundle extras) { 251a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn mMessage = message; 252a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn mExtras = extras; 253a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 254a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn 255a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn public void onAbortResult(Bundle result) { 256a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 257a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn 258a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn IVoiceInteractorRequest submit(IVoiceInteractor interactor, String packageName, 259a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn IVoiceInteractorCallback callback) throws RemoteException { 260a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn return interactor.startAbortVoice(packageName, callback, mMessage, mExtras); 261a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 262a2c076d54048258cf88ab14551ce5fdf5a09c6e8Dianne Hackborn } 26391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 26418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public static class CommandRequest extends Request { 26518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final String mCommand; 26618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn final Bundle mArgs; 26718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn 26818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn /** 26918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * Execute a command using the trusted system VoiceInteractionService. 27018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * This allows an Activity to request additional information from the user needed to 27118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * complete an action (e.g. booking a table might have several possible times that the 27218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * user could select from or an app might need the user to agree to a terms of service). 27318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * The result of the confirmation will be returned through an asynchronous call to 27418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * either {@link #onCommandResult(android.os.Bundle)} or 27518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * {@link #onCancel()}. 27618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * 27718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * <p>The command is a string that describes the generic operation to be performed. 27818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * The command will determine how the properties in extras are interpreted and the set of 27918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * available commands is expected to grow over time. An example might be 28018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * "com.google.voice.commands.REQUEST_NUMBER_BAGS" to request the number of bags as part of 28118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * airline check-in. (This is not an actual working example.) 28218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * 28318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * @param command The desired command to perform. 28418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn * @param args Additional arguments to control execution of the command. 28518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn */ 28618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public CommandRequest(String command, Bundle args) { 28718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mCommand = command; 28818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mArgs = args; 28991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 29091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 29118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public void onCommandResult(Bundle result) { 29291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 29391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 29418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorRequest submit(IVoiceInteractor interactor, String packageName, 29518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorCallback callback) throws RemoteException { 29618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn return interactor.startConfirmation(packageName, callback, mCommand, mArgs); 29791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 29818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 29991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 30020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn VoiceInteractor(IVoiceInteractor interactor, Context context, Activity activity, 30118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Looper looper) { 30220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn mInteractor = interactor; 30391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn mContext = context; 30418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mActivity = activity; 30591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn mHandlerCaller = new HandlerCaller(context, looper, mHandlerCallerCallback, true); 30691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 30791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 30818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Request pullRequest(IVoiceInteractorRequest request, boolean complete) { 30991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn synchronized (mActiveRequests) { 31091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn Request req = mActiveRequests.get(request.asBinder()); 31118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn if (req != null && complete) { 31218f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mActiveRequests.remove(request.asBinder()); 31391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 31491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn return req; 31591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 31691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 31791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 31820d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn private ArrayList<Request> makeRequestList() { 31920d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn final int N = mActiveRequests.size(); 32020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn if (N < 1) { 32120d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn return null; 32220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 32320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn ArrayList<Request> list = new ArrayList<Request>(N); 32420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn for (int i=0; i<N; i++) { 32520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn list.add(mActiveRequests.valueAt(i)); 32620d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 32720d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn return list; 32820d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 32920d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 33020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn void attachActivity(Activity activity) { 33120d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn if (mActivity == activity) { 33220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn return; 33320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 33420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn mContext = activity; 33520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn mActivity = activity; 33620d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn ArrayList<Request> reqs = makeRequestList(); 33720d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn if (reqs != null) { 33820d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn for (int i=0; i<reqs.size(); i++) { 33920d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn Request req = reqs.get(i); 34020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.mContext = activity; 34120d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.mActivity = activity; 34220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.onAttached(activity); 34320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 34420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 34520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 34620d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 34720d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn void detachActivity() { 34820d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn ArrayList<Request> reqs = makeRequestList(); 34920d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn if (reqs != null) { 35020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn for (int i=0; i<reqs.size(); i++) { 35120d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn Request req = reqs.get(i); 35220d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.onDetached(); 35320d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.mActivity = null; 35420d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn req.mContext = null; 35520d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 35620d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 35720d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn mContext = null; 35820d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn mActivity = null; 35920d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn } 36020d94749043d0851f1da10c7749fd7eb13a35081Dianne Hackborn 36118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn public boolean submitRequest(Request request) { 36291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn try { 36318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn IVoiceInteractorRequest ireq = request.submit(mInteractor, 36418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mContext.getOpPackageName(), mCallback); 36518f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.mRequestInterface = ireq; 36618f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.mContext = mContext; 36718f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn request.mActivity = mActivity; 36818f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn synchronized (mActiveRequests) { 36918f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn mActiveRequests.put(ireq.asBinder(), request); 37018f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn } 37118f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn return true; 37291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } catch (RemoteException e) { 37318f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn Log.w(TAG, "Remove voice interactor service died", e); 37418f0d357f9693fe787a3e3777d8fdf01357a6e3fDianne Hackborn return false; 37591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 37691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 37791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn 37891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn /** 37991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * Queries the supported commands available from the VoiceinteractionService. 38091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * The command is a string that describes the generic operation to be performed. 38191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * An example might be "com.google.voice.commands.REQUEST_NUMBER_BAGS" to request the number 38291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * of bags as part of airline check-in. (This is not an actual working example.) 38391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * 38491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn * @param commands 38591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn */ 38691097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn public boolean[] supportsCommands(String[] commands) { 38791097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn try { 38891097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn boolean[] res = mInteractor.supportsCommands(mContext.getOpPackageName(), commands); 38991097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn if (DEBUG) Log.d(TAG, "supportsCommands: cmds=" + commands + " res=" + res); 39091097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn return res; 39191097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } catch (RemoteException e) { 39291097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn throw new RuntimeException("Voice interactor has died", e); 39391097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 39491097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn } 39591097de49b0f683b00e26a75dbc0ac6082344137Dianne Hackborn} 396