IFingerprintService.aidl revision fe6439f02db3a541d77a7afb27e3bca1ae7493ed 
1/*
2 * Copyright (C) 2014 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 */
16package android.hardware.fingerprint;
17
18import android.os.Bundle;
19import android.hardware.fingerprint.IFingerprintServiceReceiver;
20import android.hardware.fingerprint.Fingerprint;
21import java.util.List;
22
23/**
24 * Communication channel from client to the fingerprint service.
25 * @hide
26 */
27interface IFingerprintService {
28    // Authenticate the given sessionId with a fingerprint
29    void authenticate(IBinder token, long sessionId, int groupId,
30            IFingerprintServiceReceiver receiver, int flags);
31
32    // Cancel authentication for the given sessionId
33    void cancelAuthentication(IBinder token);
34
35    // Start fingerprint enrollment
36    void enroll(IBinder token, in byte [] cryptoToken, int groupId, IFingerprintServiceReceiver receiver,
37            int flags);
38
39    // Cancel enrollment in progress
40    void cancelEnrollment(IBinder token);
41
42    // Any errors resulting from this call will be returned to the listener
43    void remove(IBinder token, int fingerId, int groupId, IFingerprintServiceReceiver receiver);
44
45    // Rename the fingerprint specified by fingerId and groupId to the given name
46    void rename(int fingerId, int groupId, String name);
47
48    // Get a list of enrolled fingerprints in the given group.
49    List<Fingerprint> getEnrolledFingerprints(int groupId);
50
51    // Determine if HAL is loaded and ready
52    boolean isHardwareDetected(long deviceId);
53
54    // Get a pre-enrollment authentication token
55    long preEnroll(IBinder token);
56
57    // Gets the number of hardware devices
58    // int getHardwareDeviceCount();
59
60    // Gets the unique device id for hardware enumerated at i
61    // long getHardwareDevice(int i);
62
63}
64