Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ee16bdc3 authored by Sandeep Siddhartha's avatar Sandeep Siddhartha
Browse files

Address API review comments 

- Make Callback an abstract class
- Split manage intents into 3 different methods
- Remove RECOGNITION_FLAGS_NONE

Bug: 17255602
Change-Id: I1329f889bb2ab35938f42d2ecfe755d2b17ec542
parent 19d431f3

api/current.txt

+5 −6
Original line number Diff line number Diff line
@@ -27198,16 +27198,14 @@ package android.service.textservice { 
package android.service.voice {















  public class AlwaysOnHotwordDetector {













    method public android.content.Intent getManageIntent(int);













    method public android.content.Intent createIntentToEnroll();













    method public android.content.Intent createIntentToReEnroll();













    method public android.content.Intent createIntentToUnEnroll();















    method public int getSupportedRecognitionModes();















    method public boolean startRecognition(int);















    method public boolean stopRecognition();













    field public static final int MANAGE_ACTION_ENROLL = 0; // 0x0













    field public static final int MANAGE_ACTION_RE_ENROLL = 1; // 0x1













    field public static final int MANAGE_ACTION_UN_ENROLL = 2; // 0x2















    field public static final int RECOGNITION_FLAG_ALLOW_MULTIPLE_TRIGGERS = 2; // 0x2















    field public static final int RECOGNITION_FLAG_CAPTURE_TRIGGER_AUDIO = 1; // 0x1













    field public static final int RECOGNITION_FLAG_NONE = 0; // 0x0















    field public static final int RECOGNITION_MODE_USER_IDENTIFICATION = 2; // 0x2















    field public static final int RECOGNITION_MODE_VOICE_TRIGGER = 1; // 0x1















    field public static final int STATE_HARDWARE_UNAVAILABLE = -2; // 0xfffffffe









@@ -27216,7 +27214,8 @@ package android.service.voice {













    field public static final int STATE_KEYPHRASE_UNSUPPORTED = -1; // 0xffffffff















  }



























  public static abstract interface AlwaysOnHotwordDetector.Callback {













  public static abstract class AlwaysOnHotwordDetector.Callback {













    ctor public AlwaysOnHotwordDetector.Callback();















    method public abstract void onAvailabilityChanged(int);















    method public abstract void onDetected(android.service.voice.AlwaysOnHotwordDetector.EventPayload);















    method public abstract void onError();

























core/java/android/service/voice/AlwaysOnHotwordDetector.java



+82
−29




























Original line number
Diff line number
Diff line








@@ -19,6 +19,7 @@ package android.service.voice;













import android.annotation.IntDef;















import android.annotation.NonNull;















import android.annotation.Nullable;













import android.app.Activity;















import android.content.Intent;















import android.hardware.soundtrigger.IRecognitionStatusCallback;















import android.hardware.soundtrigger.KeyphraseEnrollmentInfo;










@@ -84,20 +85,31 @@ public class AlwaysOnHotwordDetector {













    private static final int STATE_NOT_READY = 0;































    // Keyphrase management actions. Used in getManageIntent() ----//













    /** @hide */















    @Retention(RetentionPolicy.SOURCE)















    @IntDef(value = {















                MANAGE_ACTION_ENROLL,















                MANAGE_ACTION_RE_ENROLL,















                MANAGE_ACTION_UN_ENROLL















            })













    public @interface ManageActions {}













    private @interface ManageActions {}





























    /** Indicates that we need to enroll. */













    /**













     * Indicates that we need to enroll.













     *













     * @hide













     */















    public static final int MANAGE_ACTION_ENROLL = 0;













    /** Indicates that we need to re-enroll. */













    /**













     * Indicates that we need to re-enroll.













     *













     * @hide













     */















    public static final int MANAGE_ACTION_RE_ENROLL = 1;













    /** Indicates that we need to un-enroll. */













    /**













     * Indicates that we need to un-enroll.













     *













     * @hide













     */















    public static final int MANAGE_ACTION_UN_ENROLL = 2;































    //-- Flags for startRecognition    ----//









@@ -111,7 +123,11 @@ public class AlwaysOnHotwordDetector {













            })















    public @interface RecognitionFlags {}





























    /** Empty flag for {@link #startRecognition(int)}. */













    /**













     * Empty flag for {@link #startRecognition(int)}.













     *













     * @hide













     */















    public static final int RECOGNITION_FLAG_NONE = 0;















    /**















     * Recognition flag for {@link #startRecognition(int)} that indicates










@@ -264,7 +280,7 @@ public class AlwaysOnHotwordDetector {













    /**















     * Callbacks for always-on hotword detection.















     */













    public interface Callback {













    public static abstract class Callback {















        /**















         * Called when the hotword availability changes.















         * This indicates a change in the availability of recognition for the given keyphrase.









@@ -278,7 +294,7 @@ public class AlwaysOnHotwordDetector {













         * @see AlwaysOnHotwordDetector#STATE_KEYPHRASE_UNENROLLED















         * @see AlwaysOnHotwordDetector#STATE_KEYPHRASE_ENROLLED















         */













        void onAvailabilityChanged(int status);













        public abstract void onAvailabilityChanged(int status);















        /**















         * Called when the keyphrase is spoken.















         * This implicitly stops listening for the keyphrase once it's detected.









@@ -289,23 +305,23 @@ public class AlwaysOnHotwordDetector {













         *        This may contain the trigger audio, if requested when calling















         *        {@link AlwaysOnHotwordDetector#startRecognition(int)}.















         */













        void onDetected(@NonNull EventPayload eventPayload);













        public abstract void onDetected(@NonNull EventPayload eventPayload);















        /**















         * Called when the detection fails due to an error.















         */













        void onError();













        public abstract void onError();















        /**















         * Called when the recognition is paused temporarily for some reason.















         * This is an informational callback, and the clients shouldn't be doing anything here















         * except showing an indication on their UI if they have to.















         */













        void onRecognitionPaused();













        public abstract void onRecognitionPaused();















        /**















         * Called when the recognition is resumed after it was temporarily paused.















         * This is an informational callback, and the clients shouldn't be doing anything here















         * except showing an indication on their UI if they have to.















         */













        void onRecognitionResumed();













        public abstract void onRecognitionResumed();















    }































    /**










@@ -372,10 +388,10 @@ public class AlwaysOnHotwordDetector {













    /**















     * Starts recognition for the associated keyphrase.















     *













     * @see #RECOGNITION_FLAG_CAPTURE_TRIGGER_AUDIO













     * @see #RECOGNITION_FLAG_ALLOW_MULTIPLE_TRIGGERS













     *















     * @param recognitionFlags The flags to control the recognition properties.













     *        The allowed flags are {@link #RECOGNITION_FLAG_NONE},













     *        {@link #RECOGNITION_FLAG_CAPTURE_TRIGGER_AUDIO} and













     *        {@link #RECOGNITION_FLAG_ALLOW_MULTIPLE_TRIGGERS}.















     * @return Indicates whether the call succeeded or not.















     * @throws UnsupportedOperationException if the recognition isn't supported.















     *         Callers should only call this method after a supported state callback on










@@ -430,12 +446,34 @@ public class AlwaysOnHotwordDetector {













    }































    /**













     * Gets an intent to manage the associated keyphrase.













     * Creates an intent to start the enrollment for the associated keyphrase.













     * This intent must be invoked using {@link Activity#startActivityForResult(Intent, int)}.













     * Starting re-enrollment is only valid if the keyphrase is un-enrolled,













     * i.e. {@link #STATE_KEYPHRASE_UNENROLLED},













     * otherwise {@link #createIntentToReEnroll()} should be preferred.













     *













     * @return An {@link Intent} to start enrollment for the given keyphrase.













     * @throws UnsupportedOperationException if managing they keyphrase isn't supported.













     *         Callers should only call this method after a supported state callback on













     *         {@link Callback#onAvailabilityChanged(int)} to avoid this exception.













     * @throws IllegalStateException if the detector is in an invalid state.













     *         This may happen if another detector has been instantiated or the













     *         {@link VoiceInteractionService} hosting this detector has been shut down.













     */













    public Intent createIntentToEnroll() {













        if (DBG) Slog.d(TAG, "createIntentToEnroll");













        synchronized (mLock) {













            return getManageIntentLocked(MANAGE_ACTION_ENROLL);













        }













    }



























    /**













     * Creates an intent to start the un-enrollment for the associated keyphrase.













     * This intent must be invoked using {@link Activity#startActivityForResult(Intent, int)}.













     * Starting re-enrollment is only valid if the keyphrase is already enrolled,













     * i.e. {@link #STATE_KEYPHRASE_ENROLLED}, otherwise invoking this may result in an error.















     *













     * @param action The manage action that needs to be performed.













     *        One of {@link #MANAGE_ACTION_ENROLL}, {@link #MANAGE_ACTION_RE_ENROLL} or













     *        {@link #MANAGE_ACTION_UN_ENROLL}.













     * @return An {@link Intent} to manage the given keyphrase.













     * @return An {@link Intent} to start un-enrollment for the given keyphrase.















     * @throws UnsupportedOperationException if managing they keyphrase isn't supported.















     *         Callers should only call this method after a supported state callback on















     *         {@link Callback#onAvailabilityChanged(int)} to avoid this exception.









@@ -443,10 +481,31 @@ public class AlwaysOnHotwordDetector {













     *         This may happen if another detector has been instantiated or the















     *         {@link VoiceInteractionService} hosting this detector has been shut down.















     */













    public Intent getManageIntent(@ManageActions int action) {













        if (DBG) Slog.d(TAG, "getManageIntent(" + action + ")");













    public Intent createIntentToUnEnroll() {













        if (DBG) Slog.d(TAG, "createIntentToUnEnroll");















        synchronized (mLock) {













            return getManageIntentLocked(action);













            return getManageIntentLocked(MANAGE_ACTION_UN_ENROLL);













        }













    }



























    /**













     * Creates an intent to start the re-enrollment for the associated keyphrase.













     * This intent must be invoked using {@link Activity#startActivityForResult(Intent, int)}.













     * Starting re-enrollment is only valid if the keyphrase is already enrolled,













     * i.e. {@link #STATE_KEYPHRASE_ENROLLED}, otherwise invoking this may result in an error.













     *













     * @return An {@link Intent} to start re-enrollment for the given keyphrase.













     * @throws UnsupportedOperationException if managing they keyphrase isn't supported.













     *         Callers should only call this method after a supported state callback on













     *         {@link Callback#onAvailabilityChanged(int)} to avoid this exception.













     * @throws IllegalStateException if the detector is in an invalid state.













     *         This may happen if another detector has been instantiated or the













     *         {@link VoiceInteractionService} hosting this detector has been shut down.













     */













    public Intent createIntentToReEnroll() {













        if (DBG) Slog.d(TAG, "createIntentToReEnroll");













        synchronized (mLock) {













            return getManageIntentLocked(MANAGE_ACTION_RE_ENROLL);















        }















    }

























@@ -462,12 +521,6 @@ public class AlwaysOnHotwordDetector {













                    "Managing the given keyphrase is not supported");















        }





























        if (action != MANAGE_ACTION_ENROLL













                && action != MANAGE_ACTION_RE_ENROLL













                && action != MANAGE_ACTION_UN_ENROLL) {













            throw new IllegalArgumentException("Invalid action specified " + action);













        }





























        return mKeyphraseEnrollmentInfo.getManageKeyphraseIntent(action, mText, mLocale);















    }

















































tests/VoiceInteraction/src/com/android/test/voiceinteraction/MainInteractionService.java



+1
−2




























Original line number
Diff line number
Diff line








@@ -92,8 +92,7 @@ public class MainInteractionService extends VoiceInteractionService {













                break;















            case AlwaysOnHotwordDetector.STATE_KEYPHRASE_UNENROLLED:















                Log.i(TAG, "STATE_KEYPHRASE_UNENROLLED");













                Intent enroll = mHotwordDetector.getManageIntent(













                        AlwaysOnHotwordDetector.MANAGE_ACTION_ENROLL);













                Intent enroll = mHotwordDetector.createIntentToEnroll();















                Log.i(TAG, "Need to enroll with " + enroll);















                break;















            case AlwaysOnHotwordDetector.STATE_KEYPHRASE_ENROLLED: