1 /*
2  * Copyright (C) 2021 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 
17 package com.android.systemui.biometrics;
18 
19 import android.annotation.Nullable;
20 
21 /**
22  * Interface that should be implemented by UI's that need to coordinate user touches,
23  * views/animations, and modules that start/stop display illumination.
24  */
25 interface UdfpsIlluminator {
26     /**
27      * @param hbmProvider Invoked when HBM should be enabled or disabled.
28      */
setHbmProvider(@ullable UdfpsHbmProvider hbmProvider)29     void setHbmProvider(@Nullable UdfpsHbmProvider hbmProvider);
30 
31     /**
32      * Invoked when illumination should start.
33      * @param onIlluminatedRunnable Invoked when the display has been illuminated.
34      */
startIllumination(@ullable Runnable onIlluminatedRunnable)35     void startIllumination(@Nullable Runnable onIlluminatedRunnable);
36 
37     /**
38      * Invoked when illumination should end.
39      */
stopIllumination()40     void stopIllumination();
41 }
42