metadata_output.h

Overview

The file declares the metadata output concepts.

File to include: <ohcamera/metadata_output.h>

Library: libohcamera.so

System capability: SystemCapability.Multimedia.Camera.Core

Since: 11

Related module: OH_Camera

Summary

Structs

Name	typedef Keyword	Description
MetadataOutput_Callbacks	MetadataOutput_Callbacks	Describes the callbacks related to metadata output.
Camera_MetadataOutput	Camera_MetadataOutput	Describes the metadata output object. You can use OH_CameraManager_CreateMetadataOutput to create such an object.

Functions

Name	typedef Keyword	Description
typedef void (OH_MetadataOutput_OnMetadataObjectAvailable)(Camera_MetadataOutput metadataOutput, Camera_MetadataObject* metadataObject, uint32_t size)	OH_MetadataOutput_OnMetadataObjectAvailable	Defines the callback defined in the MetadataOutput_Callbacks struct and used to report metadata output data.
typedef void (OH_MetadataOutput_OnError)(Camera_MetadataOutput metadataOutput, Camera_ErrorCode errorCode)	OH_MetadataOutput_OnError	Defines the callback defined in the MetadataOutput_Callbacks struct and used to report metadata output errors.
Camera_ErrorCode OH_MetadataOutput_RegisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)	-	Registers a callback to listen for metadata output events.
Camera_ErrorCode OH_MetadataOutput_UnregisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)	-	Unregisters the callback used to listen for metadata output events.
Camera_ErrorCode OH_MetadataOutput_Start(Camera_MetadataOutput* metadataOutput)	-	Starts metadata output.
Camera_ErrorCode OH_MetadataOutput_Stop(Camera_MetadataOutput* metadataOutput)	-	Stops metadata output.
Camera_ErrorCode OH_MetadataOutput_Release(Camera_MetadataOutput* metadataOutput)	-	Releases a MetadataOutput instance.
Camera_ErrorCode OH_MetadataOutput_AddMetadataObjectTypes(Camera_MetadataOutput* metadataOutput, Camera_MetadataObjectType* types, uint32_t size)	-	Adds the metadata object types.
Camera_ErrorCode OH_MetadataOutput_RemoveMetadataObjectTypes(Camera_MetadataOutput* metadataOutput, Camera_MetadataObjectType* types, uint32_t size)	-	Removes the metadata object types.

Function Description

OH_MetadataOutput_OnMetadataObjectAvailable()

typedef void (*OH_MetadataOutput_OnMetadataObjectAvailable)(Camera_MetadataOutput* metadataOutput, Camera_MetadataObject* metadataObject, uint32_t size)

Description

Defines the callback defined in the MetadataOutput_Callbacks struct and used to report metadata output data.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to the MetadataOutput instance that transfers the callback.
Camera_MetadataObject* metadataObject	Pointer to the metadata output data.
uint32_t size	Size of the metadata object.

OH_MetadataOutput_OnError()

typedef void (*OH_MetadataOutput_OnError)(Camera_MetadataOutput* metadataOutput, Camera_ErrorCode errorCode)

Description

Defines the callback defined in the MetadataOutput_Callbacks struct and used to report metadata output errors.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to the MetadataOutput instance that transfers the callback.
Camera_ErrorCode errorCode	Error code reported during metadata output.

See also

CAMERA_SERVICE_FATAL_ERROR

OH_MetadataOutput_RegisterCallback()

Camera_ErrorCode OH_MetadataOutput_RegisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)

Description

Registers a callback to listen for metadata output events.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to a MetadataOutput instance.
MetadataOutput_Callbacks* callback	Pointer to the target callback.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect.

OH_MetadataOutput_UnregisterCallback()

Camera_ErrorCode OH_MetadataOutput_UnregisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)

Description

Unregisters the callback used to listen for metadata output events.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to a MetadataOutput instance.
MetadataOutput_Callbacks* callback	Pointer to the target callback.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect.

OH_MetadataOutput_Start()

Camera_ErrorCode OH_MetadataOutput_Start(Camera_MetadataOutput* metadataOutput)

Description

Starts metadata output.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to the MetadataOutput instance to start.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect. CAMERA_SESSION_NOT_CONFIG: The capture session is not configured. CAMERA_SERVICE_FATAL_ERROR: The camera service is abnormal.

OH_MetadataOutput_Stop()

Camera_ErrorCode OH_MetadataOutput_Stop(Camera_MetadataOutput* metadataOutput)

Description

Stops metadata output.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to the MetadataOutput instance to stop.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect. CAMERA_SERVICE_FATAL_ERROR: The camera service is abnormal.

OH_MetadataOutput_Release()

Camera_ErrorCode OH_MetadataOutput_Release(Camera_MetadataOutput* metadataOutput)

Description

Releases a MetadataOutput instance.

Since: 11

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to the MetadataOutput instance to release.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect. CAMERA_SERVICE_FATAL_ERROR: The camera service is abnormal.

OH_MetadataOutput_AddMetadataObjectTypes()

Camera_ErrorCode OH_MetadataOutput_AddMetadataObjectTypes(Camera_MetadataOutput* metadataOutput, Camera_MetadataObjectType* types, uint32_t size)

Description

Adds the metadata object types.

Since: 23

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to a MetadataOutput instance.
Camera_MetadataObjectType* types	Array of metadata object types to be added to the Camera_MetadataOutput instance.
uint32_t size	Length of the metadata object type array.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect. CAMERA_SERVICE_FATAL_ERROR: The camera service is abnormal.

OH_MetadataOutput_RemoveMetadataObjectTypes()

Camera_ErrorCode OH_MetadataOutput_RemoveMetadataObjectTypes(Camera_MetadataOutput* metadataOutput, Camera_MetadataObjectType* types, uint32_t size)

Description

Removes the metadata object types.

Since: 23

Parameters

Name	Description
Camera_MetadataOutput* metadataOutput	Pointer to a MetadataOutput instance.
Camera_MetadataObjectType* types	Array of metadata object types removed from the Camera_MetadataOutput instance.
uint32_t size	Length of the metadata object type array.

Returns

Type	Description
Camera_ErrorCode	CAMERA_OK: The operation is successful. CAMERA_INVALID_ARGUMENT: A parameter is missing or the parameter type is incorrect. CAMERA_SERVICE_FATAL_ERROR: The camera service is abnormal.