openharmony 鸿蒙 capi-image-receiver-mdk-h

2025-06-12 浏览 (1)

image_receiver_mdk.h

概述

声明从native层获取图片数据的方法。

库： libimage_receiver_ndk.z.so

引用文件： <multimedia/image_framework/image_receiver_mdk.h>

系统能力： SystemCapability.Multimedia.Image

起始版本： 10

相关模块： Image

汇总

结构体

名称typedef关键字描述
OhosImageReceiverInfo-定义ImageReceiver的相关信息。
ImageReceiverNative_ImageReceiverNative用于定义ImageReceiverNative数据类型名称。

函数

名称typedef关键字描述
typedef void (*OH_Image_Receiver_On_Callback)()OH_Image_Receiver_On_Callback定义native层图片的回调方法。
int32_t OH_Image_Receiver_CreateImageReceiver(napi_env env, struct OhosImageReceiverInfo info, napi_value* res)-创建应用层ImageReceiver对象。
ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative(napi_env env, napi_value source)-通过应用层ImageReceiver对象初始化native层ImageReceiverNative对象。
int32_t OH_Image_Receiver_GetReceivingSurfaceId(const ImageReceiverNative* native, char* id, size_t len)-通过ImageReceiverNative获取receiver的id。
int32_t OH_Image_Receiver_ReadLatestImage(const ImageReceiverNative* native, napi_value* image)-通过ImageReceiverNative获取最新的一张图片。
int32_t OH_Image_Receiver_ReadNextImage(const ImageReceiverNative* native, napi_value* image)-通过ImageReceiverNative获取下一张图片。
int32_t OH_Image_Receiver_On(const ImageReceiverNative* native, OH_Image_Receiver_On_Callback callback)-注册一个OH_Image_Receiver_On_Callback回调事件。每当接收新图片，该回调事件就会响应。
int32_t OH_Image_Receiver_GetSize(const ImageReceiverNative* native, struct OhosImageSize* size)-通过ImageReceiverNative获取ImageReceiver的大小。
int32_t OH_Image_Receiver_GetCapacity(const ImageReceiverNative* native, int32_t* capacity)-通过ImageReceiverNative获取ImageReceiver的容量。
int32_t OH_Image_Receiver_GetFormat(const ImageReceiverNative* native, int32_t* format)-通过ImageReceiverNative获取ImageReceiver的格式。
int32_t OH_Image_Receiver_Release(ImageReceiverNative* native)-释放native层ImageReceiverNative对象。
注意，此方法不能释放应用层ImageReceiver对象。

函数说明

OH_Image_Receiver_On_Callback()

typedef void (*OH_Image_Receiver_On_Callback)()

描述

定义native层图片的回调方法。

起始版本： 10

OH_Image_Receiver_CreateImageReceiver()

int32_t OH_Image_Receiver_CreateImageReceiver(napi_env env, struct OhosImageReceiverInfo info, napi_value* res)

描述

创建应用层ImageReceiver对象。

起始版本： 10

参数：

参数项描述
napi_env envnapi的环境指针。
struct OhosImageReceiverInfo infoImageReceiver数据设置项。
napi_value* res应用层的ImageReceiver对象的指针。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_INVALID_PARAMETER：从surface获取参数失败。
IMAGE_RESULT_CREATE_SURFACE_FAILED：创建surface失败。
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED：surface分配内存失败。
IMAGE_RESULT_GET_SURFACE_FAILED：获取surface失败。
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT：媒体rtsp surface不支持。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT：媒体类型不支持。

OH_Image_Receiver_InitImageReceiverNative()

ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative(napi_env env, napi_value source)

描述

通过应用层ImageReceiver对象初始化native层ImageReceiverNative对象。

起始版本： 10

参数：

参数项描述
napi_env envnapi的环境指针。
napi_value sourcenapi的ImageReceiver对象。

返回：

类型说明
ImageReceiverNative*操作成功则返回ImageReceiverNative指针；如果操作失败，则返回nullptr。

参考：

OH_Image_Receiver_Release

OH_Image_Receiver_GetReceivingSurfaceId()

int32_t OH_Image_Receiver_GetReceivingSurfaceId(const ImageReceiverNative* native, char* id, size_t len)

描述

通过ImageReceiverNative获取receiver的id。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
char* id指向字符缓冲区的指针，用于获取字符串的id。
size_t lenid所对应的字符缓冲区的大小。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_INVALID_PARAMETER：从surface获取参数失败。
IMAGE_RESULT_GET_SURFACE_FAILED：获取surface失败。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT：媒体类型不支持。

OH_Image_Receiver_ReadLatestImage()

int32_t OH_Image_Receiver_ReadLatestImage(const ImageReceiverNative* native, napi_value* image)

描述

通过ImageReceiverNative获取最新的一张图片。

注意，此接口需要在OH_Image_Receiver_On_Callback回调后调用，才能正常的接收到数据。并且使用此接口返回Image对象创建的ImageNative使用完毕后需要调用OH_Image_Release方法释放，释放后才可以继续接收新的数据。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
napi_value* image获取到的应用层的Image指针对象。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_INVALID_PARAMETER：从surface获取参数失败。
IMAGE_RESULT_CREATE_SURFACE_FAILED：创建surface失败。
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED：surface分配内存失败。
IMAGE_RESULT_GET_SURFACE_FAILED：获取surface失败。
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT：媒体rtsp surface不支持。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT：媒体类型不支持。

OH_Image_Receiver_ReadNextImage()

int32_t OH_Image_Receiver_ReadNextImage(const ImageReceiverNative* native, napi_value* image)

描述

通过ImageReceiverNative获取下一张图片。

注意，此接口需要在OH_Image_Receiver_On_Callback回调后调用，才能正常的接收到数据。并且使用此接口返回Image对象创建的ImageNative使用完毕后需要调用OH_Image_Release方法释放，释放后才可以继续接收新的数据。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
napi_value* image读取到的应用层的Image指针对象。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_INVALID_PARAMETER：从surface获取参数失败。
IMAGE_RESULT_CREATE_SURFACE_FAILED：创建surface失败。
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED：surface分配内存失败。
IMAGE_RESULT_GET_SURFACE_FAILED：获取surface失败。
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT：媒体rtsp surface不支持。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT：媒体类型不支持。

OH_Image_Receiver_On()

int32_t OH_Image_Receiver_On(const ImageReceiverNative* native, OH_Image_Receiver_On_Callback callback)

描述

注册一个OH_Image_Receiver_On_Callback回调事件。每当接收新图片，该回调事件就会响应。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
OH_Image_Receiver_On_Callback callbackOH_Image_Receiver_On_Callback事件的回调函数。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_INVALID_PARAMETER：从surface获取参数失败。
IMAGE_RESULT_GET_SURFACE_FAILED：获取surface失败。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT：媒体类型不支持。

OH_Image_Receiver_GetSize()

int32_t OH_Image_Receiver_GetSize(const ImageReceiverNative* native, struct OhosImageSize* size)

描述

通过ImageReceiverNative获取ImageReceiver的大小。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
struct OhosImageSize* size作为结果的OhosImageSize指针。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。

OH_Image_Receiver_GetCapacity()

int32_t OH_Image_Receiver_GetCapacity(const ImageReceiverNative* native, int32_t* capacity)

描述

通过ImageReceiverNative获取ImageReceiver的容量。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
int32_t* capacity作为结果的指向容量的指针。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。

OH_Image_Receiver_GetFormat()

int32_t OH_Image_Receiver_GetFormat(const ImageReceiverNative* native, int32_t* format)

描述

通过ImageReceiverNative获取ImageReceiver的格式。

起始版本： 10

参数：

参数项描述
const ImageReceiverNative* nativenative层的ImageReceiverNative指针。
int32_t* format作为结果的指向格式的指针。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_JNI_ENV_ABNORMAL：JNI环境异常。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。

OH_Image_Receiver_Release()

int32_t OH_Image_Receiver_Release(ImageReceiverNative* native)

描述

释放native层ImageReceiverNative对象。

注意，此方法不能释放应用层ImageReceiver对象。

起始版本： 10

参数：

参数项描述
ImageReceiverNative* nativenative层的ImageReceiverNative指针。

返回：

类型说明
int32_tIRNdkErrCode：
IMAGE_RESULT_SUCCESS：操作成功。
IMAGE_RESULT_BAD_PARAMETER：参数错误。
IMAGE_RESULT_INVALID_PARAMETER：参数无效。
IMAGE_RESULT_DATA_UNSUPPORT：图像类型不支持。

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Image Kit（图片处理服务）

harmony 鸿蒙Interface (AuxiliaryPicture)

harmony 鸿蒙Interface (Image)

harmony 鸿蒙Interface (ImageCreator)

harmony 鸿蒙Interface (ImagePacker)

harmony 鸿蒙Interface (ImageReceiver)

harmony 鸿蒙Interface (ImageSource)

harmony 鸿蒙Interface (Metadata)

harmony 鸿蒙Interface (Picture)

harmony 鸿蒙Interface (PixelMap)

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/ZjcIQJ