/*
 * Copyright (c) 2026 Huawei Device Co., Ltd.
 * 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.
 */

/**
 * @addtogroup HdfFaceAuth
 * @{
 *
 * @brief Provides APIs for the face auth driver.
 *
 * The face auth driver provides a unified interface for the face auth service to access the face auth driver.
 * After obtaining the face auth driver proxy, the service can call related APIs to obtain executors.
 * After obtaining the face auth executors, the service can call related APIs to get executor information, get
 * template information, and enroll, authenticate, and delete templates, etc.
 *
 * @since 3.2
 */

/**
 * @file IFaceAuthInterface.idl
 *
 * @brief Defines the API for getting the executor list of the face auth driver.
 *
 * @since 3.2
 */

package ohos.hdi.face_auth.v3_0;

import ohos.hdi.face_auth.v3_0.IAllInOneExecutor;
import ohos.hdi.face_auth.v3_0.ICameraControllerCallback;
sequenceable ohos.hdi.camera.v1_0.BufferProducerSequenceable;

/**
 * @brief Defines the API for getting the executor list of the face auth driver.
 *
 * @since 3.2
 * @version 3.0
 */
interface IFaceAuthInterface {
    /**
     * @brief Obtains the executor list of the driver.
     *
     * @param allInOneExecutors Indicates the all-in-one executor list of the driver.
     * See {@link IAllInOneExecutor}.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 3.2
     * @version 2.0
     */
    GetExecutorList([out] IAllInOneExecutor[] allInOneExecutors);
    /**
     * @brief Set buffer producer.
     *
     * @param bufferProducer Indicates bufferProducer set to executor.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 3.2
     * @version 2.0
     */
    SetBufferProducer([in] BufferProducerSequenceable bufferProducer);
    /**
     * @brief Set camera controller.
     *
     * @param cameraController Indicates camera controller.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 6.1
     * @version 1.0
     */
    SetCameraController([in] ICameraControllerCallback cameraController);
    /**
     * @brief Gets camera settings based on camera ability.
     *
     * @param cameraAbility Indicates the camera ability.
     * @param cameraSettings Indicates the camera settings.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 6.1
     * @version 1.0
     */
    GetCameraSettings([in] unsigned long scheduleId, [in] unsigned char[] cameraAbility, [out] unsigned char[] cameraSettings);
    /**
     * @brief Sets the secure sequence ID for the capture session.
     *
     * @param scheduleId Indicates the schedule ID of the capture session.
     * @param secureSeqId Indicates the secure sequence ID.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 6.1
     * @version 1.0
     */
    SetCameraSecureSeqId([in] unsigned long scheduleId, [in] unsigned long secureSeqId);
    /**
     * @brief Reports an error during capture operations.
     *
     * @param scheduleId Indicates the schedule ID of the capture session.
     * @param resultCode Indicates the result code.
     *
     * @return Returns <b>0</b> if the operation is successful.
     * @return Returns a non-zero value if the operation fails.
     *
     * @since 6.1
     * @version 1.0
     */
    [oneway] OnCameraError([in] unsigned long scheduleId, [in] int resultCode);
}
/** @} */