blob: 378b5645377c91ada00e968aeecd92eb4b9d8c8a [file] [log] [blame] [edit]
/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.biometrics.fingerprint@2.3;
import @2.2::IBiometricsFingerprint;
/**
* New use of this interface is strongly discouraged. The recommended option is
* to use the AIDL interface, android.hardware.biometrics.fingerprint
* (IFingerprint).
*
* The interface for biometric fingerprint authentication.
*/
interface IBiometricsFingerprint extends @2.2::IBiometricsFingerprint {
/**
* Returns whether the fingerprint sensor is an under-display fingerprint
* sensor.
* @param sensorId the unique sensor ID for which the operation should be
* performed.
* @return isUdfps indicating whether the specified sensor is an
* under-display fingerprint sensor.
*/
isUdfps(uint32_t sensorId) generates (bool isUdfps);
/**
* Notifies about a touch occurring within the under-display fingerprint
* sensor area.
*
* It it assumed that the device can only have one active under-display
* fingerprint sensor at a time.
*
* If multiple fingers are detected within the sensor area, only the
* chronologically first event will be reported.
*
* @param x The screen x-coordinate of the center of the touch contact area, in
* display pixels.
* @param y The screen y-coordinate of the center of the touch contact area, in
* display pixels.
* @param minor The length of the minor axis of an ellipse that describes the
* touch area, in display pixels.
* @param major The length of the major axis of an ellipse that describes the
* touch area, in display pixels.
*/
onFingerDown(uint32_t x, uint32_t y, float minor, float major);
/**
* Notifies about a finger leaving the under-display fingerprint sensor area.
*
* It it assumed that the device can only have one active under-display
* fingerprint sensor at a time.
*
* If multiple fingers have left the sensor area, only the finger which
* previously caused a "finger down" event will be reported.
*/
onFingerUp();
};