1/*
2 * Copyright (c) 2022 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 * @file istream_operator_callback.h
18 *
19 * @brief Declares callbacks related to {@link IStreamOperator}. The caller needs to implement these callbacks.
20 *
21 * @since 3.2
22 * @version 1.0
23 */
24
25package ohos.hdi.camera.v1_0;
26
27import ohos.hdi.camera.v1_0.Types;
28
29[callback] interface IStreamOperatorCallback {
30    /**
31     * @brief Called when the capture starts.
32     *
33     * @param captureId Indicates the ID of the capture request corresponding to the callback.
34     * @param streamIds Indicates the IDs of the streams corresponding to the callback.
35     *
36     * @since 3.2
37     * @version 1.0
38     */
39    OnCaptureStarted([in] int captureId, [in] int[] streamIds);
40
41    /**
42     * @brief Called when the capture ends.
43     *
44     * @param captureId Indicates the ID of the capture request corresponding to the callback.
45     * @param infos Indicates information related to the capture when it ends.
46     *
47     * @since 3.2
48     * @version 1.0
49     */
50    OnCaptureEnded([in] int captureId, [in] struct CaptureEndedInfo[] infos);
51
52    /**
53     * @brief Called when an error occurs during the capture.
54     *
55     * @param captureId Indicates the ID of the capture request corresponding to the callback.
56     * @param infos Indicates a list of capture error messages.
57     *
58     * @since 3.2
59     * @version 1.0
60     */
61    OnCaptureError([in] int captureId, [in] struct CaptureErrorInfo[] infos);
62
63    /**
64     * @brief Called when a frame is captured.
65     *
66     * This callback is enabled by using <b>enableShutterCallback_</b> in the {@link CaptureInfo} parameter of {@link Capture}.
67     * When <b>enableShutterCallback_</b> is set to <b>true</b>,
68     * this callback is triggered each time a frame is captured.
69     *
70     * @param captureId Indicates the ID of the capture request corresponding to the callback.
71     * @param streamIds Indicates the IDs of the streams corresponding to the callback.
72     * @param timestamp Indicates the timestamp when the callback is invoked.
73     *
74     * @since 3.2
75     * @version 1.0
76     */
77    OnFrameShutter([in] int captureId, [in] int[] streamIds, [in] unsigned long timestamp);
78}
79