1 /* 2 * Copyright (C) 2020 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 package android.hardware.fingerprint; 17 18 import android.hardware.fingerprint.IUdfpsOverlayControllerCallback; 19 20 /** 21 * Interface for interacting with the under-display fingerprint sensor (UDFPS) overlay. 22 * @hide 23 */ 24 oneway interface IUdfpsOverlayController { 25 const int REASON_UNKNOWN = 0; 26 const int REASON_ENROLL_FIND_SENSOR = 1; 27 const int REASON_ENROLL_ENROLLING = 2; 28 const int REASON_AUTH_BP = 3; // BiometricPrompt 29 const int REASON_AUTH_FPM_KEYGUARD = 4; // FingerprintManager usage from Keyguard 30 const int REASON_AUTH_FPM_OTHER = 5; // Other FingerprintManager usage 31 32 // Shows the overlay. showUdfpsOverlay(int sensorId, int reason, IUdfpsOverlayControllerCallback callback)33 void showUdfpsOverlay(int sensorId, int reason, IUdfpsOverlayControllerCallback callback); 34 35 // Hides the overlay. hideUdfpsOverlay(int sensorId)36 void hideUdfpsOverlay(int sensorId); 37 38 // Good image captured. Turn off HBM. Success/Reject comes after, which is when hideUdfpsOverlay 39 // will be called. onAcquiredGood(int sensorId)40 void onAcquiredGood(int sensorId); 41 42 // Notifies of enrollment progress changes. onEnrollmentProgress(int sensorId, int remaining)43 void onEnrollmentProgress(int sensorId, int remaining); 44 45 // Notifies when a non-terminal error occurs (e.g. user moved their finger too fast). onEnrollmentHelp(int sensorId)46 void onEnrollmentHelp(int sensorId); 47 48 // Shows debug messages on the UDFPS overlay. setDebugMessage(int sensorId, String message)49 void setDebugMessage(int sensorId, String message); 50 } 51