/*
 * Copyright (c) 2024 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.
 */

/**
 * @file istream_operator.h
 *
 * @brief Declares APIs for stream operations.
 *
 * @since 5.0
 * @version 1.3
 */

package ohos.hdi.camera.v1_3;

import ohos.hdi.camera.v1_2.IStreamOperator;

interface IStreamOperator extends ohos.hdi.camera.v1_2.IStreamOperator {

    /**
     * @brief Enables metadata reporting and other information.
     *
     * Only metadata that is enabled can be reported by using {@link OnResult}.
     *
     * @param results Indicates the metadata and other information for which reporting are to be enabled.
     * @param streamId Indicates the ID of the stream to enable metadata reporting.
     *
     * @return Returns <b>NO_ERROR</b> if the operation is successful; returns an error code defined
     * in {@link CamRetCode} otherwise.
     *
     * @since 5.0
     * @version 1.0
     */
    EnableResult([in] int streamId, [in] unsigned char[] results);

    /**
     * @brief Disable metadata reporting and other information.
     *
     * After metadata reporting is disabled, the metadata is not reported by calling {@link OnResult}.
     * To enable metadata reporting, you must call {@link EnableResult}.
     *
     * @param results Indicates the metadata and other information for which reporting are to be disabled.
     * @param streamId Indicates the ID of the stream to disable metadata reporting.
     *
     * @return Returns <b>NO_ERROR</b> if the operation is successful; returns an error code defined
     * in {@link CamRetCode} otherwise.
     *
     * @since 5.0
     * @version 1.0
     */
    DisableResult([in] int streamId, [in] unsigned char[] results);
}