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     // Shows the overlay  for the given sensor with a reason from BiometricOverlayConstants.
showUdfpsOverlay(long requestId, int sensorId, int reason, IUdfpsOverlayControllerCallback callback)26     void showUdfpsOverlay(long requestId, int sensorId, int reason, IUdfpsOverlayControllerCallback callback);
27 
28     // Hides the overlay.
hideUdfpsOverlay(int sensorId)29     void hideUdfpsOverlay(int sensorId);
30 
31     // Check acquiredInfo for the acquired type (BiometricFingerprintConstants#FingerprintAcquired).
32     // Check BiometricFingerprintConstants#shouldTurnOffHbm for whether the acquiredInfo
33     // should turn off HBM.
onAcquired(int sensorId, int acquiredInfo)34     void onAcquired(int sensorId, int acquiredInfo);
35 
36     // Notifies of enrollment progress changes.
onEnrollmentProgress(int sensorId, int remaining)37     void onEnrollmentProgress(int sensorId, int remaining);
38 
39     // Notifies when a non-terminal error occurs (e.g. user moved their finger too fast).
onEnrollmentHelp(int sensorId)40     void onEnrollmentHelp(int sensorId);
41 
42     // Shows debug messages on the UDFPS overlay.
setDebugMessage(int sensorId, String message)43     void setDebugMessage(int sensorId, String message);
44 }
45