diff --git a/en/device_api/hdi/camera/icamera_device.h b/en/device_api/hdi/camera/icamera_device.h
index 8f365af24b061fe8087d8c33fe99e749357e6411..3068645a41c2a4a3559298256146821da8043647 100644
--- a/en/device_api/hdi/camera/icamera_device.h
+++ b/en/device_api/hdi/camera/icamera_device.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -61,8 +61,8 @@ public:
*
* @param streamOperator Indicates the stream operation handle.
*
- * @return Returns NO_ERROR if the operation is successful; returns
- * an error code defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} if the operation fails.
*
* @since 1.0
* @version 1.0
@@ -77,8 +77,8 @@ public:
* @param settings Indicates the camera parameters, including the sensor frame rate and
* 3A parameters. 3A stands for automatic focus (AF), automatic exposure (AE), and automatic white-balance (AWB).
*
- * @return Returns NO_ERROR if the operation is successful; returns an error code
- * defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} if the operation fails.
*
* @since 1.0
* @version 1.0
@@ -91,8 +91,8 @@ public:
* @param mode Indicates the metadata reporting mode to set, which can be frame-by-frame reporting
* or reporting upon device status change. For details, see {@link ResultCallbackMode}.
*
- * @return Returns NO_ERROR if the operation is successful; returns an error
- * code defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} if the operation fails.
*
* @since 1.0
* @version 1.0
@@ -106,8 +106,8 @@ public:
*
* @param results Indicates all enabled metadata.
*
- * @return Returns NO_ERROR if the operation is successful; returns an error
- * code defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} if the operation fails.
*
* @since 1.0
* @version 1.0
@@ -121,8 +121,8 @@ public:
*
* @param results Indicates the metadata for which reporting is to be enabled.
*
- * @return Returns NO_ERROR if the operation is successful; returns an error
- * code defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} if the operation fails.
*
* @see DisableResult
*
@@ -139,7 +139,7 @@ public:
*
* @param results Indicates the metadata for which reporting is to be disabled.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @see EnableResult
diff --git a/en/device_api/hdi/camera/icamera_device_callback.h b/en/device_api/hdi/camera/icamera_device_callback.h
index 3961b92a4f14e099f9e0ff04f040196d8724607e..94abd80e116b0d6c592194a565a25813dc2c064e 100644
--- a/en/device_api/hdi/camera/icamera_device_callback.h
+++ b/en/device_api/hdi/camera/icamera_device_callback.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -63,7 +63,7 @@ public:
/**
* @brief Called to report metadata related to the camera device.
- * For details about the reporting mode, see {@link SetResultMode}.
+ * For details about the data reporting mode, see {@link SetResultMode}.
*
* @param timestamp Indicates the timestamp when the metadata is reported.
* @param result Indicates the metadata reported. The reported metadata is specified by {@link EnableResult}.
diff --git a/en/device_api/hdi/camera/icamera_host.h b/en/device_api/hdi/camera/icamera_host.h
index 9f58cdf72d13c500ce6056fd889c11069d6bd539..f9deeb8c51e79f0f0c7bf20f6050088f3aac90dd 100644
--- a/en/device_api/hdi/camera/icamera_host.h
+++ b/en/device_api/hdi/camera/icamera_host.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -28,7 +28,7 @@
/**
* @file icamera_host.h
*
- * @brief Management class of the camera service that provides Hardware Driver Interfaces (HDIs) for the upper layer.
+ * @brief Declares the camera service management class that provides Hardware Device Interfaces (HDIs) for the upper layer.
*
* @since 1.0
* @version 1.0
@@ -58,10 +58,10 @@ public:
* This function provides the entry to the camera service. You must use this function to
* obtain an ICameraHost instance before performing other operations.
*
- * @param serviceName Indicates the name of the ICameraHost instance to obtain.
+ * @param serviceName Indicates the pointer to the name of the ICameraHost instance.
* Currently, the name is fixed at camera_service.
*
- * @return Returns the ICameraHost instance if the operation is successful;
+ * @return Returns the ICameraHost instance if the operation is successful.
* @return Returns nullptr otherwise.
*
* @since 1.0
@@ -70,11 +70,11 @@ public:
static sptr Get(const char *serviceName);
/**
- * @brief Sets callbacks. For details about the callbacks, see {@link ICameraHostCallback}.
+ * @brief Sets a callback.
*
- * @param callback Indicates the callbacks to set.
+ * @param callback Indicates the callback to set. For details, see {@link ICameraHostCallback}.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -87,7 +87,7 @@ public:
*
* @param cameraIds Indicates the IDs of available camera devices.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -96,13 +96,13 @@ public:
virtual CamRetCode GetCameraIds(std::vector &cameraIds) = 0;
/**
- * @brief Obtains the abilities of a camera device.
+ * @brief Obtains the capability of a camera device.
*
* @param cameraId Indicates the ID of the camera device, which can be obtained by calling {@link GetCameraIds}.
*
- * @param ability Returns the abilities of the camera device.
+ * @param ability Indicates the capability of the camera device.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @see GetCameraIds
@@ -116,14 +116,14 @@ public:
/**
* @brief Opens a camera device.
*
- * By calling this function, you can obtain the ICameraDevice instance and
- * operate the specific camera device mapping to the instance.
+ * By calling this function, you can obtain an ICameraDevice instance and
+ * operate the camera device mapping to the instance.
*
* @param cameraId Indicates the ID of the camera device, which can be obtained by calling {@link GetCameraIds}.
* @param callback Indicates the callback related to the camera. For details, see {@link ICameraDeviceCallback}.
* @param device Indicates the ICameraDevice instance corresponding to the ID of the camera device.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @see GetCameraIds
@@ -144,7 +144,7 @@ public:
* @param isEnable Specifies whether to turn on or off the flash. The value true
* means to turn on the flash, and false means the opposite.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @see GetCameraIds
diff --git a/en/device_api/hdi/camera/icamera_host_callback.h b/en/device_api/hdi/camera/icamera_host_callback.h
index 92a191418760ddb389f7c491391e79a5cb33a187..922cec19c3330957ab4a2fb2bf265142f4c89736 100644
--- a/en/device_api/hdi/camera/icamera_host_callback.h
+++ b/en/device_api/hdi/camera/icamera_host_callback.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -51,7 +51,7 @@ public:
public:
/**
- * @brief Called when the camera status changes to report the latest status.
+ * @brief Called when the camera status changes.
*
* @param cameraId Indicates the ID of the camera whose status changes.
* @param status Indicates the latest status of the camera.
@@ -62,7 +62,7 @@ public:
virtual void OnCameraStatus(const std::string &cameraId, CameraStatus status) = 0;
/**
- * @brief Called when the flash status changes to report the latest status.
+ * @brief Called when the flash status changes.
*
* @param cameraId Indicates the ID of the camera to which the flash whose status changes is bound.
* @param status Indicates the latest status of the flash.
@@ -73,10 +73,10 @@ public:
virtual void OnFlashlightStatus(const std::string &cameraId, FlashlightStatus status) = 0;
/**
- * @brief Called when the camera event occurs.
+ * @brief Called when a camera event occurs.
*
* @param cameraId Indicates the ID of the camera to which the camera event is bound.
- * @param event Indicates the camera event type.
+ * @param event Indicates the camera event.
*
* @since 1.0
* @version 1.0
diff --git a/en/device_api/hdi/camera/ioffline_stream_operator.h b/en/device_api/hdi/camera/ioffline_stream_operator.h
index 752a4d53eab27835c6451fcad23e8ad1a8e3d60a..aba9ff2b54279f5fdab0386df27add7bfbad75ae 100644
--- a/en/device_api/hdi/camera/ioffline_stream_operator.h
+++ b/en/device_api/hdi/camera/ioffline_stream_operator.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -55,7 +55,7 @@ public:
*
* @param captureId Indicates the ID of the capture request to cancel.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -68,7 +68,7 @@ public:
*
* @param streamIds Indicates the IDs of the offline streams to release.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -79,8 +79,7 @@ public:
/**
* @brief Releases all offline streams.
*
- *
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
diff --git a/en/device_api/hdi/camera/istream_operator.h b/en/device_api/hdi/camera/istream_operator.h
index 936bc5fb99a9df87aee30d543e3ee915b8243dec..087ef6ae42a116ba3978412ded34b6829a61576c 100644
--- a/en/device_api/hdi/camera/istream_operator.h
+++ b/en/device_api/hdi/camera/istream_operator.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -54,32 +54,32 @@ public:
virtual ~IStreamOperator() {}
/**
- * @brief Checks whether a specific stream can be dynamically created.
+ * @brief Checks whether streams can be dynamically created.
*
* A stream is a sequence of data elements output from a bottom-layer device, processed by the current module,
* and then transmitted to an upper-layer service or application.
* The current module supports preview streams, video streams, photographing streams, and the like.
* For details, see {@link StreamIntent}.
*
- * This function is used to check whether a stream or streams can be dynamically created based on the
- * operation mode, configuration information, and existing streams in the current module.
+ * This function is used to check whether streams can be dynamically created based on the
+ * operation mode, configuration, and existing streams in the current module.
* If the streams can be created without stopping the existing streams or making the upper-layer service or
* application unaware of the stopping of the existing streams,
* type is set to DYNAMIC_SUPPORTED so that the upper-layer service or application
- * can directly add the new stream.
+ * can directly add the new streams.
* If the streams can be created only after the upper-layer service or application stops capturing all streams,
* type is set to RE_CONFIGURED_REQUIRED.
- * If the streams are not supported, type is set to NOT_SUPPORTED.
+ * If the streams to be created are not supported, type is set to NOT_SUPPORTED.
* This function must be called prior to {@link CreateStreams}.
*
* @param mode Indicates the operation mode of the streams. For details, see {@link OperationMode}.
* @param modeSetting Indicates the stream configuration parameters, including the frame rate and 3A.
* 3A stands for automatic focus (AF), automatic exposure (AE), and automatic white-balance (AWB).
* @param info Indicates the stream configuration information. For details, see {@link StreamInfo}.
- * @param type Indicates the support type of the dynamically created stream.
+ * @param type Indicates the support type of the streams.
* The supported types are defined in {@link StreamSupportType}.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -99,9 +99,9 @@ public:
*
* @param streamInfos Indicates the list of stream information, which is defined by {@link StreamInfo}.
* The passed stream information may be changed. Therefore, you can run {@link GetStreamAttributes} to
- * obtain the latest stream attributes after the stream is created.
+ * obtain the latest stream attributes after the streams are created.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -114,8 +114,8 @@ public:
*
* @param streamIds Indicates the IDs of the streams to release.
*
- * @return Returns NO_ERROR if the operation is successful;
- * returns an error code defined in {@link CamRetCode} otherwise.
+ * @return Returns NO_ERROR if the operation is successful.
+ * @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
* @version 1.0
@@ -123,13 +123,14 @@ public:
virtual CamRetCode ReleaseStreams(const std::vector &streamIds) = 0;
/**
- * @brief Configures a stream.
+ * @brief Commits streams.
*
* This function must be called after {@link CreateStreams}.
*
- * @param mode Indicates the operation mode of the stream. For details, see {@link OperationMode}.
+ * @param mode Indicates the operation mode of the streams. For details, see {@link OperationMode}.
* @param modeSetting Indicates the stream configuration parameters, including the frame rate and zoom information.
- * @return Returns NO_ERROR if the operation is successful;
+ *
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -146,7 +147,7 @@ public:
* may be overridden. Therefore, the stream attributes obtained by using this function may be
* different from the stream information passed in {@link CreateStreams}.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -163,7 +164,7 @@ public:
* call {@link DetachBufferQueue} to detach the existing procedure handle and then
* call this function to attach the new one.
* You do not need to attach a procedure handle for IoT devices that do not support or require
- * image data caching and transferring of preview streams.
+ * image data caching and preview stream forwarding.
* In this case, set bufferQueue_ in the {@link StreamInfo} parameter of {@link CreateStreams}
* to null,
* and set tunneledMode_ to false.
@@ -171,7 +172,7 @@ public:
* @param streamId Indicates the ID of the stream to which the procedure handle is to be attached.
* @param producer Indicates the producer handle to be attached.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -184,7 +185,7 @@ public:
*
* @param streamId Indicates the ID of the stream from which the procedure handle is to be detached.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -198,12 +199,12 @@ public:
* This function must be called after {@link CommitStreams}.
* There are two image capture modes: continuous capture and single capture.
* A continuous capture is performed inside the module after being triggered,
- * and the consumer can continuously receive captured image data after calling this function only once.
+ * and you can continuously receive captured image data after calling this function only once.
* If this function is called again, the current capture is stopped, the capture request configuration is updated,
* and a new capture is performed.
- * This mode is mainly used in preview, video recording, or continuous shooting scenarios.
+ * Continuous capture is mainly used in preview, video recording, or continuous shooting scenarios.
* After a single capture is triggered, only one frame of image data is captured.
- * This mode applies to the single shooting scenario.
+ * Single capture applies to the single shooting scenario.
* When the capture is started, {@link OnCaptureStarted} is called to notify of the start.
* To stop a continuous capture, call {@link CancelCapture}.
* When the capture ends, {@link OnCaptureEnded} is called to notify the caller of the information
@@ -219,7 +220,7 @@ public:
* @param isStreaming Specifies whether to continuously capture images.
* The value true means to continuously capture images, and false means the opposite.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -235,7 +236,7 @@ public:
*
* @param captureId Indicates the ID of the capture request to cancel.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
@@ -244,19 +245,19 @@ public:
virtual CamRetCode CancelCapture(int captureId) = 0;
/**
- * @brief Converts a specific stream to an offline stream.
+ * @brief Converts streams to the offline stream.
*
* Only photographing streams can be converted into offline streams.
* Due to the limited processing capability, some devices may spend a long period of time on
* algorithm processing during photographing, causing the capture requests to stack in the module.
- * Converting to an offline stream enables the bottom-layer device to close and
+ * Converting to the offline stream enables the bottom-layer device to close and
* the offline stream to take over for subsequent processing.
*
* @param streamIds Indicates the IDs of the streams to be converted.
- * @param callback Indicates the callback for conversion to offline streams.
+ * @param callback Indicates the callback for conversion to the offline stream.
* @param offlineOperator Indicates the offline stream after conversion.
*
- * @return Returns NO_ERROR if the operation is successful;
+ * @return Returns NO_ERROR if the operation is successful.
* @return Returns an error code defined in {@link CamRetCode} otherwise.
*
* @since 1.0
diff --git a/en/device_api/hdi/camera/istream_operator_callback.h b/en/device_api/hdi/camera/istream_operator_callback.h
index c5203d0feee8e312fb1a35fefd0341991b277973..b99e177e531f53610abedcf82458d470badcd932 100644
--- a/en/device_api/hdi/camera/istream_operator_callback.h
+++ b/en/device_api/hdi/camera/istream_operator_callback.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
diff --git a/en/device_api/hdi/camera/types.h b/en/device_api/hdi/camera/types.h
index a004b9abf924ef5eba14aaed9042f1ab0041f7b2..e6437020eea5a8f8c85a4c8b58aa93d5dbddf2aa 100644
--- a/en/device_api/hdi/camera/types.h
+++ b/en/device_api/hdi/camera/types.h
@@ -19,8 +19,8 @@
*
* @brief Provides APIs for the camera module.
*
- * You can use the APIs to perform operations on camera devices, streams,
- * and offline streams, and implement various callbacks.
+ * You can use the APIs to perform operations on camera devices and streams
+ * (including offline streams), and implement various callbacks.
*
* @since 1.0
*/
@@ -28,8 +28,7 @@
/**
* @file types.h
*
- * @brief Declares data types
- * used by the Hardware Driver Interfaces (HDIs) of this module.
+ * @brief Declares data types used by the Hardware Device Interfaces (HDIs) of this module.
*
* @since 1.0
* @version 1.0
@@ -91,86 +90,86 @@ enum CamRetCode : int32_t {
};
/**
- * @brief Enumerates metadata reporting modes.
+ * @brief Enumerates the metadata reporting modes.
*/
enum ResultCallbackMode : int32_t {
/**
- * Frame-by-frame reporting
+ * Frame-by-frame reporting.
*/
PER_FRAME,
/**
- * Reporting upon device status change
+ * Reporting upon device status change.
*/
ON_CHANGED
};
/**
- * @brief Enumerates stream operation modes.
+ * @brief Enumerates the stream operation modes.
*/
enum OperationMode : int32_t {
/**
- * Normal
+ * Normal.
*/
NORMAL = 0,
};
/**
- * @brief Enumerates stream types.
+ * @brief Enumerates the stream types.
*/
enum StreamIntent : int32_t {
/**
- * Preview streams, indicating that stream data is used for preview
+ * Preview streams, indicating that stream data is used for preview.
*/
PREVIEW = 0,
/**
- * Video streams, indicating that stream data is used to encode and generate videos
+ * Video streams, indicating that stream data is used to encode and generate videos.
*/
VIDEO = 1,
/**
- * Photographing streams, indicating that stream data is used to encode and generate images
+ * Photographing streams, indicating that stream data is used to encode and generate images.
*/
STILL_CAPTURE = 2,
/**
- * Stream data that is used to store thumbnails
+ * Stream data used to store thumbnails.
*/
POST_VIEW = 3,
/**
- * Stream data that is used for image analysis
+ * Stream data used for image analysis.
*/
ANALYZE = 4,
/**
- * Custom type
+ * Custom type.
*/
CUSTOM = 5,
};
/**
- * @brief Enumerates encoding types of stream data.
+ * @brief Enumerates the encoding types of stream data.
*/
enum EncodeType : int32_t {
/**
- * Unspecified
+ * Unspecified.
*/
ENCODE_TYPE_NULL = 0,
/**
- * H.264
+ * H.264.
*/
ENCODE_TYPE_H264 = 1,
/**
- * H.265
+ * H.265.
*/
ENCODE_TYPE_H265 = 2,
/**
- * JPEG
+ * JPEG.
*/
ENCODE_TYPE_JPEG = 3,
};
@@ -216,7 +215,7 @@ struct StreamInfo {
* the hardware abstraction layer (HAL) does not directly interact with the upper layer.
* Instead, it uses the producer handle provided by the graphics layer to transfer frame data.
* You need to disable the tunnel mode for IoT devices that do not support
- * or require image data caching and forwarding of preview streams.
+ * or require image data caching and preview stream forwarding.
*/
bool tunneledMode_;
@@ -329,7 +328,7 @@ struct CaptureInfo {
};
/**
- * @brief Enumerates camera device statuses.
+ * @brief Enumerates the camera device statuses.
*/
enum CameraStatus {
/**
@@ -344,7 +343,7 @@ enum CameraStatus {
};
/**
- * @brief Enumerates flash statuses.
+ * @brief Enumerates the flash statuses.
*/
enum FlashlightStatus : uint32_t {
/**
@@ -364,22 +363,22 @@ enum FlashlightStatus : uint32_t {
};
/**
- * @brief Camera event.
+ * @brief Enumerates the camera events.
*/
enum CameraEvent : uint32_t {
/**
- * Camera device add event.
+ * An event indicating that a camera device is added.
*/
CAMERA_EVENT_DEVICE_ADD = 0,
/**
- * Camera device remove event.
+ * An event indicating that a camera device is removed.
*/
CAMERA_EVENT_DEVICE_RMV = 1,
};
/**
- * @brief Enumerates camera device error types, which are used by {@link OnError}.
+ * @brief Enumerates the camera device error types, which are used by {@link OnError}.
*/
enum ErrorType : uint32_t {
/**
@@ -409,16 +408,16 @@ struct CaptureEndedInfo {
};
/**
- * @brief Enumerates stream error types, which are used by {@link CaptureErrorInfo}.
+ * @brief Enumerates the stream error types, which are used by {@link CaptureErrorInfo}.
*/
enum StreamError {
/**
- * Unknown error
+ * Unknown error.
*/
UNKNOWN_ERROR = 0,
/**
- * Packet loss
+ * Packet loss.
*/
BUFFER_LOST = 1,
};
@@ -428,12 +427,12 @@ enum StreamError {
*/
struct CaptureErrorInfo {
/**
- * Stream ID
+ * Stream ID.
*/
int streamId_;
/**
- * Error type
+ * Error type.
*/
StreamError error_;
};