1# metadata_output.h 2<!--Kit: Camera Kit--> 3<!--Subsystem: Multimedia--> 4<!--Owner: @qano--> 5<!--Designer: @leo_ysl--> 6<!--Tester: @xchaosioda--> 7<!--Adviser: @zengyawen--> 8 9## 概述 10 11声明元数据输出概念。 12 13**引用文件：** <ohcamera/metadata_output.h> 14 15**库：** libohcamera.so 16 17**系统能力：** SystemCapability.Multimedia.Camera.Core 18 19**起始版本：** 11 20 21**相关模块：** [OH_Camera](capi-oh-camera.md) 22 23## 汇总 24 25### 结构体 26 27| 名称 | typedef关键字 | 描述 | 28| -- | -- | -- | 29| [MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md) | MetadataOutput_Callbacks | 元数据输出的回调。 | 30| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md) | Camera_MetadataOutput | 元数据输出对象。<br> 可以使用[OH_CameraManager_CreateMetadataOutput](capi-camera-manager-h.md#oh_cameramanager_createmetadataoutput)方法创建指针。 | 31 32### 函数 33 34| 名称 | typedef关键字 | 描述 | 35| -- | -- | -- | 36| [typedef void (\*OH_MetadataOutput_OnMetadataObjectAvailable)(Camera_MetadataOutput* metadataOutput,Camera_MetadataObject* metadataObject, uint32_t size)](#oh_metadataoutput_onmetadataobjectavailable) | OH_MetadataOutput_OnMetadataObjectAvailable | 在[MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)中被调用的元数据输出元数据对象可用回调。 | 37| [typedef void (\*OH_MetadataOutput_OnError)(Camera_MetadataOutput* metadataOutput, Camera_ErrorCode errorCode)](#oh_metadataoutput_onerror) | OH_MetadataOutput_OnError | 在[MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)中被调用的元数据输出错误回调。 | 38| [Camera_ErrorCode OH_MetadataOutput_RegisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)](#oh_metadataoutput_registercallback) | - | 注册元数据输出更改事件回调。 | 39| [Camera_ErrorCode OH_MetadataOutput_UnregisterCallback(Camera_MetadataOutput* metadataOutput, MetadataOutput_Callbacks* callback)](#oh_metadataoutput_unregistercallback) | - | 注销元数据输出更改事件回调。 | 40| [Camera_ErrorCode OH_MetadataOutput_Start(Camera_MetadataOutput* metadataOutput)](#oh_metadataoutput_start) | - | 启动元数据输出。 | 41| [Camera_ErrorCode OH_MetadataOutput_Stop(Camera_MetadataOutput* metadataOutput)](#oh_metadataoutput_stop) | - | 停止元数据输出。 | 42| [Camera_ErrorCode OH_MetadataOutput_Release(Camera_MetadataOutput* metadataOutput)](#oh_metadataoutput_release) | - | 释放元数据输出实例。 | 43 44## 函数说明 45 46### OH_MetadataOutput_OnMetadataObjectAvailable() 47 48``` 49typedef void (*OH_MetadataOutput_OnMetadataObjectAvailable)(Camera_MetadataOutput* metadataOutput,Camera_MetadataObject* metadataObject, uint32_t size) 50``` 51 52**描述** 53 54在[MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)中被调用的元数据输出元数据对象可用回调。 55 56**起始版本：** 11 57 58 59**参数：** 60 61| 参数项 | 描述 | 62| -- | -- | 63| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 传递回调的元数据输出实例。 | 64| [Camera_MetadataObject](capi-oh-camera-camera-metadataobject.md)* metadataObject | 回调传递的元数据实例信息。 | 65| uint32_t size | 元数据对象的大小。 | 66 67### OH_MetadataOutput_OnError() 68 69``` 70typedef void (*OH_MetadataOutput_OnError)(Camera_MetadataOutput* metadataOutput, Camera_ErrorCode errorCode) 71``` 72 73**描述** 74 75在[MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)中被调用的元数据输出错误回调。 76 77**起始版本：** 11 78 79 80**参数：** 81 82| 参数项 | 描述 | 83| -- | -- | 84| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 传递回调的元数据输出实例。 | 85| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) errorCode | 元数据输出的错误码。 | 86 87**参考：** 88 89[CAMERA_SERVICE_FATAL_ERROR](capi-camera-h.md#camera_errorcode) 90 91### OH_MetadataOutput_RegisterCallback() 92 93``` 94Camera_ErrorCode OH_MetadataOutput_RegisterCallback(Camera_MetadataOutput* metadataOutput,MetadataOutput_Callbacks* callback) 95``` 96 97**描述** 98 99注册元数据输出更改事件回调。 100 101**起始版本：** 11 102 103 104**参数：** 105 106| 参数项 | 描述 | 107| -- | -- | 108| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 元数据输出实例。 | 109| [MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)* callback | 要注册的元数据输出回调。 | 110 111**返回：** 112 113| 类型 | 说明 | 114| -- | -- | 115| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) | CAMERA_OK：方法调用成功。<br> CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 | 116 117### OH_MetadataOutput_UnregisterCallback() 118 119``` 120Camera_ErrorCode OH_MetadataOutput_UnregisterCallback(Camera_MetadataOutput* metadataOutput,MetadataOutput_Callbacks* callback) 121``` 122 123**描述** 124 125注销元数据输出更改事件回调。 126 127**起始版本：** 11 128 129 130**参数：** 131 132| 参数项 | 描述 | 133| -- | -- | 134| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 元数据输出实例。 | 135| [MetadataOutput_Callbacks](capi-oh-camera-metadataoutput-callbacks.md)* callback | 要注销的元数据输出回调。 | 136 137**返回：** 138 139| 类型 | 说明 | 140| -- | -- | 141| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) | CAMERA_OK：方法调用成功。<br> CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。 | 142 143### OH_MetadataOutput_Start() 144 145``` 146Camera_ErrorCode OH_MetadataOutput_Start(Camera_MetadataOutput* metadataOutput) 147``` 148 149**描述** 150 151启动元数据输出。 152 153**起始版本：** 11 154 155 156**参数：** 157 158| 参数项 | 描述 | 159| -- | -- | 160| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 要启动的元数据输出实例。 | 161 162**返回：** 163 164| 类型 | 说明 | 165| -- | -- | 166| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) | CAMERA_OK：方法调用成功。<br> CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。<br> CAMERA_SESSION_NOT_CONFIG：捕获会话未配置。<br> CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。 | 167 168### OH_MetadataOutput_Stop() 169 170``` 171Camera_ErrorCode OH_MetadataOutput_Stop(Camera_MetadataOutput* metadataOutput) 172``` 173 174**描述** 175 176停止元数据输出。 177 178**起始版本：** 11 179 180 181**参数：** 182 183| 参数项 | 描述 | 184| -- | -- | 185| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 要停止的元数据输出实例。 | 186 187**返回：** 188 189| 类型 | 说明 | 190| -- | -- | 191| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) | CAMERA_OK：方法调用成功。<br> CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。<br> CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。 | 192 193### OH_MetadataOutput_Release() 194 195``` 196Camera_ErrorCode OH_MetadataOutput_Release(Camera_MetadataOutput* metadataOutput) 197``` 198 199**描述** 200 201释放元数据输出实例。 202 203**起始版本：** 11 204 205 206**参数：** 207 208| 参数项 | 描述 | 209| -- | -- | 210| [Camera_MetadataOutput](capi-oh-camera-camera-metadataoutput.md)* metadataOutput | 要释放的元数据输出实例。 | 211 212**返回：** 213 214| 类型 | 说明 | 215| -- | -- | 216| [Camera_ErrorCode](capi-camera-h.md#camera_errorcode) | CAMERA_OK：方法调用成功。<br> CAMERA_INVALID_ARGUMENT：参数丢失或参数类型不正确。<br> CAMERA_SERVICE_FATAL_ERROR：相机服务出现致命错误。 | 217 218 219