summaryrefslogtreecommitdiff
path: root/core/java/android/hardware/face/FaceSensorProperties.java
blob: f6131278591904c0c83e61fedb966b9e6cba20d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/*
 * Copyright (C) 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.face;

import android.annotation.IntDef;
import android.annotation.NonNull;
import android.hardware.biometrics.ComponentInfoInternal;
import android.hardware.biometrics.SensorProperties;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.ArrayList;
import java.util.List;

/**
 * Container for face sensor properties.
 * @hide
 */
public class FaceSensorProperties extends SensorProperties {
    /**
     * @hide
     */
    public static final int TYPE_UNKNOWN = 0;

    /**
     * @hide
     */
    public static final int TYPE_RGB = 1;

    /**
     * @hide
     */
    public static final int TYPE_IR = 2;

    /**
     * @hide
     */
    @IntDef({TYPE_UNKNOWN,
            TYPE_RGB,
            TYPE_IR})
    @Retention(RetentionPolicy.SOURCE)
    public @interface SensorType {}

    @FaceSensorProperties.SensorType
    final int mSensorType;

    /**
     * @hide
     */
    public static FaceSensorProperties from(FaceSensorPropertiesInternal internalProp) {
        final List<ComponentInfo> componentInfo = new ArrayList<>();
        for (ComponentInfoInternal internalComp : internalProp.componentInfo) {
            componentInfo.add(ComponentInfo.from(internalComp));
        }
        return new FaceSensorProperties(internalProp.sensorId,
                internalProp.sensorStrength,
                componentInfo,
                internalProp.sensorType);
    }
    /**
     * @hide
     */
    public FaceSensorProperties(int sensorId, int sensorStrength,
            @NonNull List<ComponentInfo> componentInfo,
            @FaceSensorProperties.SensorType int sensorType) {
        super(sensorId, sensorStrength, componentInfo);
        mSensorType = sensorType;
    }

    /**
     * @hide
     * @return The sensor's type.
     */
    @FaceSensorProperties.SensorType
    public int getSensorType() {
        return mSensorType;
    }
}