harmony 鸿蒙image_receiver_mdk.h

2025-06-12
浏览 (1)

image_receiver_mdk.h

概述

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

库： libimage_receiver_ndk.z.so

引用文件：

系统能力： SystemCapability.Multimedia.Image

起始版本： 10

相关模块： Image

汇总

结构体

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

函数

函数说明

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

参数：

返回：

|类型|说明| |–|–| |int32_t|IRNdkErrCode：
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 env|napi的环境指针。| |napi_value source|napi的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

参数：

返回：

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* native|native层的ImageReceiverNative指针。| |napi_value* image|获取到的应用层的Image指针对象。|

返回：

OH_Image_Receiver_ReadNextImage()

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

描述

通过ImageReceiverNative获取下一张图片。

起始版本： 10

参数：

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

返回：

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* native|native层的ImageReceiverNative指针。| |OH_Image_Receiver_On_Callback callback|OH_Image_Receiver_On_Callback事件的回调函数。|

返回：

OH_Image_Receiver_GetSize()

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

描述

通过ImageReceiverNative获取ImageReceiver的大小。

起始版本： 10

参数：

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

返回：

OH_Image_Receiver_GetCapacity()

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

描述

通过ImageReceiverNative获取ImageReceiver的容量。

起始版本： 10

参数：

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

返回：

OH_Image_Receiver_GetFormat()

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

描述

通过ImageReceiverNative获取ImageReceiver的格式。

起始版本： 10

参数：

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

返回：

OH_Image_Receiver_Release()

int32_t OH_Image_Receiver_Release(ImageReceiverNative* native)

描述

释放native层ImageReceiverNative对象。

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

起始版本： 10

参数：

|参数项|描述| |–|–| |ImageReceiverNative* native|native层的ImageReceiverNative指针。|

返回：

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