1 /* 2 * Copyright (c) 2021 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 1.0 22 * @version 1.0 23 */ 24 25 #ifndef HDI_STREAM_OPERATOR_CALLBACK_SERVER_H 26 #define HDI_STREAM_OPERATOR_CALLBACK_SERVER_H 27 28 #include <list> 29 #include <map> 30 #include <vector> 31 #include "types.h" 32 #include "icamera_interface.h" 33 34 namespace OHOS::Camera { 35 class IStreamOperatorCallback : public ICameraInterface { 36 public: 37 DECLARE_INTERFACE_DESCRIPTOR(u"HDI.Camera.V1_0.StreamOperatorCallback"); ~IStreamOperatorCallback()38 virtual ~IStreamOperatorCallback() {} 39 40 public: 41 /** 42 * @brief Called when the capture starts. 43 * 44 * @param captureId Indicates the ID of the capture request corresponding to the callback. 45 * @param streamIds Indicates the IDs of the streams corresponding to the callback. 46 * 47 * @since 1.0 48 * @version 1.0 49 */ 50 virtual void OnCaptureStarted(int32_t captureId, const std::vector<int32_t> &streamIds) = 0; 51 52 /** 53 * @brief Called when the capture ends. 54 * 55 * @param captureId Indicates the ID of the capture request corresponding to the callback. 56 * @param infos Indicates information related to the capture when it ends. 57 * 58 * @since 1.0 59 * @version 1.0 60 */ 61 virtual void OnCaptureEnded(int32_t captureId, 62 const std::vector<std::shared_ptr<CaptureEndedInfo>> &infos) = 0; 63 64 /** 65 * @brief Called when an error occurs during the capture. 66 * 67 * @param captureId Indicates the ID of the capture request corresponding to the callback. 68 * @param infos Indicates a list of capture error messages. 69 * 70 * @since 1.0 71 * @version 1.0 72 */ 73 virtual void OnCaptureError(int32_t captureId, 74 const std::vector<std::shared_ptr<CaptureErrorInfo>> &infos) = 0; 75 76 /** 77 * @brief Called when a frame is captured. 78 * 79 * This callback is enabled by using <b>enableShutterCallback_</b> in the {@link CaptureInfo} parameter of {@link Capture}. 80 * When <b>enableShutterCallback_</b> is set to <b>true</b>, 81 * this callback is triggered each time a frame is captured. 82 * 83 * @param captureId Indicates the ID of the capture request corresponding to the callback. 84 * @param streamIds Indicates the IDs of the streams corresponding to the callback. 85 * @param timestamp Indicates the timestamp when the callback is invoked. 86 * 87 * @since 1.0 88 * @version 1.0 89 */ 90 virtual void OnFrameShutter(int32_t captureId, 91 const std::vector<int32_t> &streamIds, uint64_t timestamp) = 0; 92 }; 93 } 94 #endif // HDI_STREAM_OPERATOR_CALLBACK_SERVER_H 95