1/*
2 * Copyright (c) 2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @addtogroup HdfFaceAuth
18 * @{
19 *
20 * @brief Provides APIs for the face auth driver.
21 *
22 * The face auth driver provides a unified interface for the face auth service to access the face auth driver.
23 * After obtaining the face auth driver proxy, the service can call related APIs to obtain executors.
24 * After obtaining the face auth executors, the service can call related APIs to get executor information, get
25 * template information, and enroll, authenticate, and delete templates, etc.
26 *
27 * @since 3.2
28 */
29
30/**
31 * @file IFaceAuthInterface.idl
32 *
33 * @brief Defines the API for getting the executor list of the face auth driver.
34 *
35 * @since 3.2
36 */
37
38package ohos.hdi.face_auth.v2_0;
39
40import ohos.hdi.face_auth.v2_0.IAllInOneExecutor;
41sequenceable ohos.hdi.camera.v1_0.BufferProducerSequenceable;
42
43/**
44 * @brief Defines the API for getting the executor list of the face auth driver.
45 *
46 * @since 3.2
47 * @version 2.0
48 */
49interface IFaceAuthInterface {
50    /**
51     * @brief Obtains the executor list of the driver.
52     *
53     * @param allInOneExecutors Indicates the all-in-one executor list of the driver.
54     * See {@link IAllInOneExecutor}.
55     *
56     * @return Returns <b>0</b> if the operation is successful.
57     * @return Returns a non-zero value if the operation fails.
58     *
59     * @since 3.2
60     * @version 2.0
61     */
62    GetExecutorList([out] IAllInOneExecutor[] allInOneExecutors);
63    /**
64     * @brief Set buffer producer.
65     *
66     * @param bufferProducer Indicates bufferProducer set to executor.
67     *
68     * @return Returns <b>0</b> if the operation is successful.
69     * @return Returns a non-zero value if the operation fails.
70     *
71     * @since 3.2
72     * @version 2.0
73     */
74    SetBufferProducer([in] BufferProducerSequenceable bufferProducer);
75}
76/** @} */