1# picture_native.h 2<!--Kit: Image Kit--> 3<!--Subsystem: Multimedia--> 4<!--Owner: @aulight02--> 5<!--Designer: @liyang_bryan--> 6<!--Tester: @xchaosioda--> 7<!--Adviser: @zengyawen--> 8 9## 概述 10 11提供获取picture数据和信息的API。 12 13**引用文件:** <multimedia/image_framework/image/picture_native.h> 14 15**库:** libpicture.so 16 17**系统能力:** SystemCapability.Multimedia.Image.Core 18 19**起始版本:** 13 20 21**相关模块:** [Image_NativeModule](capi-image-nativemodule.md) 22 23## 汇总 24 25### 结构体 26 27| 名称 | typedef关键字 | 描述 | 28| -- | -- | -- | 29| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) | OH_PictureNative | Picture结构体类型,用于执行picture相关操作。 | 30| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) | OH_AuxiliaryPictureNative | AuxiliaryPicture结构体类型,用于执行AuxiliaryPicture相关操作。 | 31| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) | OH_AuxiliaryPictureInfo | AuxiliaryPictureInfo结构体类型,用于执行AuxiliaryPictureInfo相关操作。 | 32 33### 枚举 34 35| 名称 | typedef关键字 | 描述 | 36| -- | -- | -- | 37| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) | Image_AuxiliaryPictureType | 辅助图类型。 | 38 39### 函数 40 41| 名称 | 描述 | 42| -- | -- | 43| [Image_ErrorCode OH_PictureNative_CreatePicture(OH_PixelmapNative *mainPixelmap, OH_PictureNative **picture)](#oh_picturenative_createpicture) | 创建OH_PictureNative指针。 | 44| [Image_ErrorCode OH_PictureNative_GetMainPixelmap(OH_PictureNative *picture, OH_PixelmapNative **mainPixelmap)](#oh_picturenative_getmainpixelmap) | 获取主图的OH_PixelmapNative指针。 | 45| [Image_ErrorCode OH_PictureNative_GetHdrComposedPixelmap(OH_PictureNative *picture, OH_PixelmapNative **hdrPixelmap)](#oh_picturenative_gethdrcomposedpixelmap) | 获取hdr图的OH_PixelmapNative指针。 | 46| [Image_ErrorCode OH_PictureNative_GetGainmapPixelmap(OH_PictureNative *picture, OH_PixelmapNative **gainmapPixelmap)](#oh_picturenative_getgainmappixelmap) | 获取增益图的OH_PixelmapNative指针。 | 47| [Image_ErrorCode OH_PictureNative_SetAuxiliaryPicture(OH_PictureNative *picture, Image_AuxiliaryPictureType type,OH_AuxiliaryPictureNative *auxiliaryPicture)](#oh_picturenative_setauxiliarypicture) | 设置辅助图。 | 48| [Image_ErrorCode OH_PictureNative_GetAuxiliaryPicture(OH_PictureNative *picture, Image_AuxiliaryPictureType type,OH_AuxiliaryPictureNative **auxiliaryPicture)](#oh_picturenative_getauxiliarypicture) | 根据类型获取辅助图。 | 49| [Image_ErrorCode OH_PictureNative_GetMetadata(OH_PictureNative *picture, Image_MetadataType metadataType,OH_PictureMetadata **metadata)](#oh_picturenative_getmetadata) | 获取主图的元数据。 | 50| [Image_ErrorCode OH_PictureNative_SetMetadata(OH_PictureNative *picture, Image_MetadataType metadataType,OH_PictureMetadata *metadata)](#oh_picturenative_setmetadata) | 设置主图的元数据。 | 51| [Image_ErrorCode OH_PictureNative_Release(OH_PictureNative *picture)](#oh_picturenative_release) | 释放OH_PictureNative指针。 | 52| [Image_ErrorCode OH_AuxiliaryPictureNative_Create(uint8_t *data, size_t dataLength, Image_Size *size,Image_AuxiliaryPictureType type, OH_AuxiliaryPictureNative **auxiliaryPicture)](#oh_auxiliarypicturenative_create) | 创建OH_AuxiliaryPictureNative指针。 | 53| [Image_ErrorCode OH_AuxiliaryPictureNative_WritePixels(OH_AuxiliaryPictureNative *auxiliaryPicture, uint8_t *source,size_t bufferSize)](#oh_auxiliarypicturenative_writepixels) | 读取缓冲区的图像像素数据,并将结果写入辅助图中。 | 54| [Image_ErrorCode OH_AuxiliaryPictureNative_ReadPixels(OH_AuxiliaryPictureNative *auxiliaryPicture, uint8_t *destination,size_t *bufferSize)](#oh_auxiliarypicturenative_readpixels) | 读取辅助图的像素数据,结果写入缓冲区。 | 55| [Image_ErrorCode OH_AuxiliaryPictureNative_GetType(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_AuxiliaryPictureType *type)](#oh_auxiliarypicturenative_gettype) | 获取辅助图类型。 | 56| [Image_ErrorCode OH_AuxiliaryPictureNative_GetInfo(OH_AuxiliaryPictureNative *auxiliaryPicture,OH_AuxiliaryPictureInfo **info)](#oh_auxiliarypicturenative_getinfo) | 获取辅助图信息。 | 57| [Image_ErrorCode OH_AuxiliaryPictureNative_SetInfo(OH_AuxiliaryPictureNative *auxiliaryPicture,OH_AuxiliaryPictureInfo *info)](#oh_auxiliarypicturenative_setinfo) | 设置辅助图信息。 | 58| [Image_ErrorCode OH_AuxiliaryPictureNative_GetMetadata(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_MetadataType metadataType, OH_PictureMetadata **metadata)](#oh_auxiliarypicturenative_getmetadata) | 获取辅助图的元数据。 | 59| [Image_ErrorCode OH_AuxiliaryPictureNative_SetMetadata(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_MetadataType metadataType, OH_PictureMetadata *metadata)](#oh_auxiliarypicturenative_setmetadata) | 设置辅助图的元数据。 | 60| [Image_ErrorCode OH_AuxiliaryPictureNative_Release(OH_AuxiliaryPictureNative *picture)](#oh_auxiliarypicturenative_release) | 释放OH_AuxiliaryPictureNative指针。 | 61| [Image_ErrorCode OH_AuxiliaryPictureInfo_Create(OH_AuxiliaryPictureInfo **info)](#oh_auxiliarypictureinfo_create) | 创建一个OH_AuxiliaryPictureInfo对象。 | 62| [Image_ErrorCode OH_AuxiliaryPictureInfo_GetType(OH_AuxiliaryPictureInfo *info, Image_AuxiliaryPictureType *type)](#oh_auxiliarypictureinfo_gettype) | 获取辅助图的图片信息的辅助图类型。 | 63| [Image_ErrorCode OH_AuxiliaryPictureInfo_SetType(OH_AuxiliaryPictureInfo *info, Image_AuxiliaryPictureType type)](#oh_auxiliarypictureinfo_settype) | 设置辅助图的图片信息的辅助图类型。 | 64| [Image_ErrorCode OH_AuxiliaryPictureInfo_GetSize(OH_AuxiliaryPictureInfo *info, Image_Size *size)](#oh_auxiliarypictureinfo_getsize) | 获取辅助图的图片尺寸。 | 65| [Image_ErrorCode OH_AuxiliaryPictureInfo_SetSize(OH_AuxiliaryPictureInfo *info, Image_Size *size)](#oh_auxiliarypictureinfo_setsize) | 设置辅助图的图片尺寸。 | 66| [Image_ErrorCode OH_AuxiliaryPictureInfo_GetRowStride(OH_AuxiliaryPictureInfo *info, uint32_t *rowStride)](#oh_auxiliarypictureinfo_getrowstride) | 获取辅助图的图片信息的行跨距。 | 67| [Image_ErrorCode OH_AuxiliaryPictureInfo_SetRowStride(OH_AuxiliaryPictureInfo *info, uint32_t rowStride)](#oh_auxiliarypictureinfo_setrowstride) | 设置辅助图的图片信息的行跨距。 | 68| [Image_ErrorCode OH_AuxiliaryPictureInfo_GetPixelFormat(OH_AuxiliaryPictureInfo *info, PIXEL_FORMAT *pixelFormat)](#oh_auxiliarypictureinfo_getpixelformat) | 获取辅助图的图片信息的像素格式。 | 69| [Image_ErrorCode OH_AuxiliaryPictureInfo_SetPixelFormat(OH_AuxiliaryPictureInfo *info, PIXEL_FORMAT pixelFormat)](#oh_auxiliarypictureinfo_setpixelformat) | 设置辅助图的图片信息的像素格式。 | 70| [Image_ErrorCode OH_AuxiliaryPictureInfo_Release(OH_AuxiliaryPictureInfo *info)](#oh_auxiliarypictureinfo_release) | 释放OH_AuxiliaryPictureInfo指针。 | 71 72## 枚举类型说明 73 74### Image_AuxiliaryPictureType 75 76``` 77enum Image_AuxiliaryPictureType 78``` 79 80**描述** 81 82辅助图类型 83 84**起始版本:** 13 85 86| 枚举项 | 描述 | 87| -- | -- | 88| AUXILIARY_PICTURE_TYPE_GAINMAP = 1 | 增益图,代表了一种增强SDR图像以产生具有可变显示调整能力的HDR图像的机制。它是一组描述如何应用gainmap元数据的组合。 | 89| AUXILIARY_PICTURE_TYPE_DEPTH_MAP = 2 | 深度图,储存图像的深度数据,通过捕捉每个像素与摄像机之间的距离,提供场景的三维结构信息,通常用于3D重建和场景理解。 | 90| AUXILIARY_PICTURE_TYPE_UNREFOCUS_MAP = 3 | 人像未对焦的原图,提供了一种在人像拍摄中突出背景模糊效果的方式,能够帮助用户在后期处理中选择焦点区域,增加创作自由度。 | 91| AUXILIARY_PICTURE_TYPE_LINEAR_MAP = 4 | 线性图,用于提供额外的数据视角或补充信息,通常用于视觉效果的增强,它可以包含场景中光照、颜色或其他视觉元素的线性表示。 | 92| AUXILIARY_PICTURE_TYPE_FRAGMENT_MAP = 5 | 水印裁剪图,表示在原图中被水印覆盖的区域,该图像用于修复或移除水印影响,恢复图像的完整性和可视性。 | 93 94 95## 函数说明 96 97### OH_PictureNative_CreatePicture() 98 99``` 100Image_ErrorCode OH_PictureNative_CreatePicture(OH_PixelmapNative *mainPixelmap, OH_PictureNative **picture) 101``` 102 103**描述** 104 105创建OH_PictureNative指针。 106 107**起始版本:** 13 108 109 110**参数:** 111 112| 参数项 | 描述 | 113| -- | -- | 114| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *mainPixelmap | 主图的OH_PixelmapNative指针。 | 115| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) **picture | 被创建的OH_PictureNative指针。 | 116 117**返回:** 118 119| 类型 | 说明 | 120| -- | -- | 121| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 122 123### OH_PictureNative_GetMainPixelmap() 124 125``` 126Image_ErrorCode OH_PictureNative_GetMainPixelmap(OH_PictureNative *picture, OH_PixelmapNative **mainPixelmap) 127``` 128 129**描述** 130 131获取主图的OH_PixelmapNative指针。 132 133**起始版本:** 13 134 135 136**参数:** 137 138| 参数项 | 描述 | 139| -- | -- | 140| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 141| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) **mainPixelmap | 获取的OH_PixelmapNative指针。 | 142 143**返回:** 144 145| 类型 | 说明 | 146| -- | -- | 147| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 148 149### OH_PictureNative_GetHdrComposedPixelmap() 150 151``` 152Image_ErrorCode OH_PictureNative_GetHdrComposedPixelmap(OH_PictureNative *picture, OH_PixelmapNative **hdrPixelmap) 153``` 154 155**描述** 156 157获取hdr图的OH_PixelmapNative指针。 158 159**起始版本:** 13 160 161 162**参数:** 163 164| 参数项 | 描述 | 165| -- | -- | 166| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 167| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) **hdrPixelmap | 获取的hdr图OH_PixelmapNative指针。 | 168 169**返回:** 170 171| 类型 | 说明 | 172| -- | -- | 173| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_UNSUPPORTED_OPERATION:操作不支持,例如picture对象中不包含增益图。 | 174 175### OH_PictureNative_GetGainmapPixelmap() 176 177``` 178Image_ErrorCode OH_PictureNative_GetGainmapPixelmap(OH_PictureNative *picture, OH_PixelmapNative **gainmapPixelmap) 179``` 180 181**描述** 182 183获取增益图的OH_PixelmapNative指针。 184 185**起始版本:** 13 186 187 188**参数:** 189 190| 参数项 | 描述 | 191| -- | -- | 192| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 193| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) **gainmapPixelmap | 获取的增益图OH_PixelmapNative指针。 | 194 195**返回:** 196 197| 类型 | 说明 | 198| -- | -- | 199| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 200 201### OH_PictureNative_SetAuxiliaryPicture() 202 203``` 204Image_ErrorCode OH_PictureNative_SetAuxiliaryPicture(OH_PictureNative *picture, Image_AuxiliaryPictureType type,OH_AuxiliaryPictureNative *auxiliaryPicture) 205``` 206 207**描述** 208 209设置辅助图。 210 211**起始版本:** 13 212 213 214**参数:** 215 216| 参数项 | 描述 | 217| -- | -- | 218| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 219| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) type | 辅助图的类型。 | 220| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 设置的OH_AuxiliaryPictureNative指针。 | 221 222**返回:** 223 224| 类型 | 说明 | 225| -- | -- | 226| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 227 228### OH_PictureNative_GetAuxiliaryPicture() 229 230``` 231Image_ErrorCode OH_PictureNative_GetAuxiliaryPicture(OH_PictureNative *picture, Image_AuxiliaryPictureType type,OH_AuxiliaryPictureNative **auxiliaryPicture) 232``` 233 234**描述** 235 236根据类型获取辅助图。 237 238**起始版本:** 13 239 240 241**参数:** 242 243| 参数项 | 描述 | 244| -- | -- | 245| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 246| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) type | 辅助图类型。 | 247| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) **auxiliaryPicture | 获取的OH_AuxiliaryPictureNative指针。 | 248 249**返回:** 250 251| 类型 | 说明 | 252| -- | -- | 253| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 254 255### OH_PictureNative_GetMetadata() 256 257``` 258Image_ErrorCode OH_PictureNative_GetMetadata(OH_PictureNative *picture, Image_MetadataType metadataType,OH_PictureMetadata **metadata) 259``` 260 261**描述** 262 263获取主图的元数据。 264 265**起始版本:** 13 266 267 268**参数:** 269 270| 参数项 | 描述 | 271| -- | -- | 272| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 273| [Image_MetadataType](capi-image-common-h.md#image_metadatatype) metadataType | 元数据类型。 | 274| [OH_PictureMetadata](capi-image-nativemodule-oh-picturemetadata.md) **metadata | 主图的元数据。 | 275 276**返回:** 277 278| 类型 | 说明 | 279| -- | -- | 280| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_UNSUPPORTED_METADATA:不支持的元数据类型。 | 281 282### OH_PictureNative_SetMetadata() 283 284``` 285Image_ErrorCode OH_PictureNative_SetMetadata(OH_PictureNative *picture, Image_MetadataType metadataType,OH_PictureMetadata *metadata) 286``` 287 288**描述** 289 290设置主图的元数据。 291 292**起始版本:** 13 293 294 295**参数:** 296 297| 参数项 | 描述 | 298| -- | -- | 299| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 300| [Image_MetadataType](capi-image-common-h.md#image_metadatatype) metadataType | 元数据类型。 | 301| [OH_PictureMetadata](capi-image-nativemodule-oh-picturemetadata.md) *metadata | 将设置的元数据。 | 302 303**返回:** 304 305| 类型 | 说明 | 306| -- | -- | 307| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_UNSUPPORTED_METADATA:不支持的元数据类型。 | 308 309### OH_PictureNative_Release() 310 311``` 312Image_ErrorCode OH_PictureNative_Release(OH_PictureNative *picture) 313``` 314 315**描述** 316 317释放OH_PictureNative指针。 318 319**起始版本:** 13 320 321 322**参数:** 323 324| 参数项 | 描述 | 325| -- | -- | 326| [OH_PictureNative](capi-image-nativemodule-oh-picturenative.md) *picture | 被操作的OH_PictureNative指针。 | 327 328**返回:** 329 330| 类型 | 说明 | 331| -- | -- | 332| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 333 334### OH_AuxiliaryPictureNative_Create() 335 336``` 337Image_ErrorCode OH_AuxiliaryPictureNative_Create(uint8_t *data, size_t dataLength, Image_Size *size,Image_AuxiliaryPictureType type, OH_AuxiliaryPictureNative **auxiliaryPicture) 338``` 339 340**描述** 341 342创建OH_AuxiliaryPictureNative指针。 343 344**起始版本:** 13 345 346 347**参数:** 348 349| 参数项 | 描述 | 350| -- | -- | 351| uint8_t *data | 图像数据。 | 352| size_t dataLength | 图像数据长度。 | 353| [Image_Size](capi-image-nativemodule-image-size.md) *size | 辅助图尺寸。 | 354| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) type | 辅助图类型。 | 355| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) **auxiliaryPicture | 被创建的OH_AuxiliaryPictureNative指针。 | 356 357**返回:** 358 359| 类型 | 说明 | 360| -- | -- | 361| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 362 363### OH_AuxiliaryPictureNative_WritePixels() 364 365``` 366Image_ErrorCode OH_AuxiliaryPictureNative_WritePixels(OH_AuxiliaryPictureNative *auxiliaryPicture, uint8_t *source,size_t bufferSize) 367``` 368 369**描述** 370 371读取缓冲区的图像像素数据,并将结果写入辅助图中。 372 373**起始版本:** 13 374 375 376**参数:** 377 378| 参数项 | 描述 | 379| -- | -- | 380| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 被操作的OH_AuxiliaryPictureNative指针。 | 381| uint8_t *source | 将被写入的图像像素数据。 | 382| size_t bufferSize | 图像像素数据长度。 | 383 384**返回:** 385 386| 类型 | 说明 | 387| -- | -- | 388| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_ALLOC_FAILED:内存分配失败。<br> IMAGE_COPY_FAILED:内存拷贝失败。 | 389 390### OH_AuxiliaryPictureNative_ReadPixels() 391 392``` 393Image_ErrorCode OH_AuxiliaryPictureNative_ReadPixels(OH_AuxiliaryPictureNative *auxiliaryPicture, uint8_t *destination,size_t *bufferSize) 394``` 395 396**描述** 397 398读取辅助图的像素数据,结果写入缓冲区。 399 400**起始版本:** 13 401 402 403**参数:** 404 405| 参数项 | 描述 | 406| -- | -- | 407| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 被操作的OH_AuxiliaryPictureNative指针。 | 408| uint8_t *destination | 缓冲区,获取的辅助图像素数据写入到该内存区域内。 | 409| size_t *bufferSize | 缓冲区大小。 | 410 411**返回:** 412 413| 类型 | 说明 | 414| -- | -- | 415| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_ALLOC_FAILED:内存分配失败。<br> IMAGE_COPY_FAILED:内存拷贝失败。 | 416 417### OH_AuxiliaryPictureNative_GetType() 418 419``` 420Image_ErrorCode OH_AuxiliaryPictureNative_GetType(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_AuxiliaryPictureType *type) 421``` 422 423**描述** 424 425获取辅助图类型。 426 427**起始版本:** 13 428 429 430**参数:** 431 432| 参数项 | 描述 | 433| -- | -- | 434| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 被操作的OH_AuxiliaryPictureNative指针。 | 435| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) *type | 辅助图类型。 | 436 437**返回:** 438 439| 类型 | 说明 | 440| -- | -- | 441| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 442 443### OH_AuxiliaryPictureNative_GetInfo() 444 445``` 446Image_ErrorCode OH_AuxiliaryPictureNative_GetInfo(OH_AuxiliaryPictureNative *auxiliaryPicture,OH_AuxiliaryPictureInfo **info) 447``` 448 449**描述** 450 451获取辅助图信息。 452 453**起始版本:** 13 454 455 456**参数:** 457 458| 参数项 | 描述 | 459| -- | -- | 460| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 被操作的OH_AuxiliaryPictureNative指针。 | 461| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) **info | 辅助图信息。 | 462 463**返回:** 464 465| 类型 | 说明 | 466| -- | -- | 467| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 468 469### OH_AuxiliaryPictureNative_SetInfo() 470 471``` 472Image_ErrorCode OH_AuxiliaryPictureNative_SetInfo(OH_AuxiliaryPictureNative *auxiliaryPicture,OH_AuxiliaryPictureInfo *info) 473``` 474 475**描述** 476 477设置辅助图信息。 478 479**起始版本:** 13 480 481 482**参数:** 483 484| 参数项 | 描述 | 485| -- | -- | 486| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 将操作的OH_AuxiliaryPictureNative指针。 | 487| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将要设置的辅助图信息。 | 488 489**返回:** 490 491| 类型 | 说明 | 492| -- | -- | 493| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 494 495### OH_AuxiliaryPictureNative_GetMetadata() 496 497``` 498Image_ErrorCode OH_AuxiliaryPictureNative_GetMetadata(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_MetadataType metadataType, OH_PictureMetadata **metadata) 499``` 500 501**描述** 502 503获取辅助图的元数据。 504 505**起始版本:** 13 506 507 508**参数:** 509 510| 参数项 | 描述 | 511| -- | -- | 512| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 将操作的OH_AuxiliaryPictureNative指针。 | 513| [Image_MetadataType](capi-image-common-h.md#image_metadatatype) metadataType | 元数据类型。 | 514| [OH_PictureMetadata](capi-image-nativemodule-oh-picturemetadata.md) **metadata | 获取的元数据。 | 515 516**返回:** 517 518| 类型 | 说明 | 519| -- | -- | 520| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_UNSUPPORTED_METADATA:不支持的元数据类型,或者元数据类型与辅助图片类型不匹配。 | 521 522### OH_AuxiliaryPictureNative_SetMetadata() 523 524``` 525Image_ErrorCode OH_AuxiliaryPictureNative_SetMetadata(OH_AuxiliaryPictureNative *auxiliaryPicture,Image_MetadataType metadataType, OH_PictureMetadata *metadata) 526``` 527 528**描述** 529 530设置辅助图的元数据。 531 532**起始版本:** 13 533 534 535**参数:** 536 537| 参数项 | 描述 | 538| -- | -- | 539| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *auxiliaryPicture | 将操作的OH_AuxiliaryPictureNative指针。 | 540| [Image_MetadataType](capi-image-common-h.md#image_metadatatype) metadataType | 元数据类型。 | 541| [OH_PictureMetadata](capi-image-nativemodule-oh-picturemetadata.md) *metadata | 将要设置的元数据。 | 542 543**返回:** 544 545| 类型 | 说明 | 546| -- | -- | 547| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。<br> IMAGE_UNSUPPORTED_METADATA:不支持的元数据类型,或者元数据类型与辅助图片类型不匹配。 | 548 549### OH_AuxiliaryPictureNative_Release() 550 551``` 552Image_ErrorCode OH_AuxiliaryPictureNative_Release(OH_AuxiliaryPictureNative *picture) 553``` 554 555**描述** 556 557释放OH_AuxiliaryPictureNative指针。 558 559**起始版本:** 13 560 561 562**参数:** 563 564| 参数项 | 描述 | 565| -- | -- | 566| [OH_AuxiliaryPictureNative](capi-image-nativemodule-oh-auxiliarypicturenative.md) *picture | 将操作的OH_AuxiliaryPictureNative指针。 | 567 568**返回:** 569 570| 类型 | 说明 | 571| -- | -- | 572| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 573 574### OH_AuxiliaryPictureInfo_Create() 575 576``` 577Image_ErrorCode OH_AuxiliaryPictureInfo_Create(OH_AuxiliaryPictureInfo **info) 578``` 579 580**描述** 581 582创建一个OH_AuxiliaryPictureInfo对象。 583 584**起始版本:** 13 585 586 587**参数:** 588 589| 参数项 | 描述 | 590| -- | -- | 591| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) **info | 将操作的OH_AuxiliaryPictureInfo指针。 | 592 593**返回:** 594 595| 类型 | 说明 | 596| -- | -- | 597| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 598 599### OH_AuxiliaryPictureInfo_GetType() 600 601``` 602Image_ErrorCode OH_AuxiliaryPictureInfo_GetType(OH_AuxiliaryPictureInfo *info, Image_AuxiliaryPictureType *type) 603``` 604 605**描述** 606 607获取辅助图的图片信息的辅助图类型。 608 609**起始版本:** 13 610 611 612**参数:** 613 614| 参数项 | 描述 | 615| -- | -- | 616| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 617| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) *type | 获取的辅助图类型。 | 618 619**返回:** 620 621| 类型 | 说明 | 622| -- | -- | 623| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 624 625### OH_AuxiliaryPictureInfo_SetType() 626 627``` 628Image_ErrorCode OH_AuxiliaryPictureInfo_SetType(OH_AuxiliaryPictureInfo *info, Image_AuxiliaryPictureType type) 629``` 630 631**描述** 632 633设置辅助图的图片信息的辅助图类型。 634 635**起始版本:** 13 636 637 638**参数:** 639 640| 参数项 | 描述 | 641| -- | -- | 642| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 643| [Image_AuxiliaryPictureType](#image_auxiliarypicturetype) type | 将要设置的辅助图类型。 | 644 645**返回:** 646 647| 类型 | 说明 | 648| -- | -- | 649| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 650 651### OH_AuxiliaryPictureInfo_GetSize() 652 653``` 654Image_ErrorCode OH_AuxiliaryPictureInfo_GetSize(OH_AuxiliaryPictureInfo *info, Image_Size *size) 655``` 656 657**描述** 658 659获取辅助图的图片尺寸。 660 661**起始版本:** 13 662 663 664**参数:** 665 666| 参数项 | 描述 | 667| -- | -- | 668| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 669| [Image_Size](capi-image-nativemodule-image-size.md) *size | 获取的图片尺寸。 | 670 671**返回:** 672 673| 类型 | 说明 | 674| -- | -- | 675| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 676 677### OH_AuxiliaryPictureInfo_SetSize() 678 679``` 680Image_ErrorCode OH_AuxiliaryPictureInfo_SetSize(OH_AuxiliaryPictureInfo *info, Image_Size *size) 681``` 682 683**描述** 684 685设置辅助图的图片尺寸。 686 687**起始版本:** 13 688 689 690**参数:** 691 692| 参数项 | 描述 | 693| -- | -- | 694| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 695| [Image_Size](capi-image-nativemodule-image-size.md) *size | 将要设置的图片尺寸。 | 696 697**返回:** 698 699| 类型 | 说明 | 700| -- | -- | 701| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 702 703### OH_AuxiliaryPictureInfo_GetRowStride() 704 705``` 706Image_ErrorCode OH_AuxiliaryPictureInfo_GetRowStride(OH_AuxiliaryPictureInfo *info, uint32_t *rowStride) 707``` 708 709**描述** 710 711获取辅助图的图片信息的行跨距。 712 713**起始版本:** 13 714 715 716**参数:** 717 718| 参数项 | 描述 | 719| -- | -- | 720| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 721| uint32_t *rowStride | 跨距,内存中每行像素所占的空间。 | 722 723**返回:** 724 725| 类型 | 说明 | 726| -- | -- | 727| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 728 729### OH_AuxiliaryPictureInfo_SetRowStride() 730 731``` 732Image_ErrorCode OH_AuxiliaryPictureInfo_SetRowStride(OH_AuxiliaryPictureInfo *info, uint32_t rowStride) 733``` 734 735**描述** 736 737设置辅助图的图片信息的行跨距。 738 739**起始版本:** 13 740 741 742**参数:** 743 744| 参数项 | 描述 | 745| -- | -- | 746| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 747| uint32_t rowStride | 跨距,内存中每行像素所占的空间。 | 748 749**返回:** 750 751| 类型 | 说明 | 752| -- | -- | 753| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 754 755### OH_AuxiliaryPictureInfo_GetPixelFormat() 756 757``` 758Image_ErrorCode OH_AuxiliaryPictureInfo_GetPixelFormat(OH_AuxiliaryPictureInfo *info, PIXEL_FORMAT *pixelFormat) 759``` 760 761**描述** 762 763获取辅助图的图片信息的像素格式。 764 765**起始版本:** 13 766 767 768**参数:** 769 770| 参数项 | 描述 | 771| -- | -- | 772| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 773| [PIXEL_FORMAT](capi-pixelmap-native-h.md#pixel_format) *pixelFormat | 获取的像素格式。 | 774 775**返回:** 776 777| 类型 | 说明 | 778| -- | -- | 779| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 780 781### OH_AuxiliaryPictureInfo_SetPixelFormat() 782 783``` 784Image_ErrorCode OH_AuxiliaryPictureInfo_SetPixelFormat(OH_AuxiliaryPictureInfo *info, PIXEL_FORMAT pixelFormat) 785``` 786 787**描述** 788 789设置辅助图的图片信息的像素格式。 790 791**起始版本:** 13 792 793 794**参数:** 795 796| 参数项 | 描述 | 797| -- | -- | 798| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 799| [PIXEL_FORMAT](capi-pixelmap-native-h.md#pixel_format) pixelFormat | 将要设置的像素格式。 | 800 801**返回:** 802 803| 类型 | 说明 | 804| -- | -- | 805| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 806 807### OH_AuxiliaryPictureInfo_Release() 808 809``` 810Image_ErrorCode OH_AuxiliaryPictureInfo_Release(OH_AuxiliaryPictureInfo *info) 811``` 812 813**描述** 814 815释放OH_AuxiliaryPictureInfo指针。 816 817**起始版本:** 13 818 819 820**参数:** 821 822| 参数项 | 描述 | 823| -- | -- | 824| [OH_AuxiliaryPictureInfo](capi-image-nativemodule-oh-auxiliarypictureinfo.md) *info | 将操作的OH_AuxiliaryPictureInfo指针。 | 825 826**返回:** 827 828| 类型 | 说明 | 829| -- | -- | 830| [Image_ErrorCode](capi-image-common-h.md#image_errorcode) | IMAGE_SUCCESS:执行成功。<br>IMAGE_BAD_PARAMETER:参数错误。 | 831 832 833