Image

概述

提供image接口的访问。

系统能力: SystemCapability.Multimedia.Image

起始版本: 8

汇总

文件

名称 描述
image_mdk.h 声明访问图像剪辑矩形、大小、格式和组件数据的方法。
引用文件:<multimedia/image_framework/image_mdk.h>
:libimage_ndk.z.so
image_mdk_common.h 声明图像常用的枚举值和结构体。
引用文件:<multimedia/image_framework/image_mdk_common.h>
:libimage_ndk.z.so
image_packer_mdk.h 声明用于将图像编码到缓冲区或文件的方法。
引用文件:<multimedia/image_framework/image_packer_mdk.h>
image_pixel_map_mdk.h 声明可以锁定并访问PixelMap数据的方法,声明解锁的方法。
引用文件:<multimedia/image_framework/image_pixel_map_mdk.h>
:libpixelmap_ndk.z.so
image_pixel_map_napi.h (已废弃)声明可以锁定并访问PixelMap数据的方法,声明解锁的方法。
引用文件:<multimedia/image_framework/image_pixel_map_napi.h>
:libpixelmap_ndk.z.so
image_receiver_mdk.h 声明从native层获取图片数据的方法。
引用文件:<multimedia/image_framework/image_receiver_mdk.h>
:libimage_receiver_ndk.z.so
image_source_mdk.h 声明将图片源解码成像素位图的方法。
引用文件:<multimedia/image_framework/image_source_mdk.h>
:libimage_source_ndk.z.so

结构体

名称 描述
OhosImageRect 定义图像矩形信息。
OhosImageComponent 定义图像组成信息。
OhosImageSize 定义图像大小。
ImagePacker_Opts_ 定义图像编码选项信息。
OhosPixelMapInfos 用于定义PixelMap的相关信息。
OhosPixelMapCreateOps 用于定义创建PixelMap设置选项的相关信息。
OHOS::Media::OhosPixelMapInfo 用于定义PixelMap的相关信息。
OhosImageReceiverInfo 定义ImageReceiver的相关信息。
OhosImageRegion 定义图像源解码的范围选项。
OhosImageSourceOps 定义图像源选项信息。
OhosImageDecodingOps 定义图像源解码选项。
OhosImageSourceInfo 定义图像源信息。
OhosImageSource 定义图像源输入资源,每次仅接收一种类型。
OhosImageSourceDelayTimeList 定义图像源延迟时间列表。
OhosImageSourceSupportedFormat 定义图像源支持的格式字符串。
OhosImageSourceSupportedFormatList 定义图像源支持的格式字符串列表。
OhosImageSourceProperty 定义图像源属性键值字符串。
OhosImageSourceUpdateData 定义图像源更新数据选项。

类型定义

名称 描述
ImageNative 为图像接口定义native层图像对象。
IRNdkErrCode 可能被使用的接口返回值的枚举。
ImagePacker_Native 为编码器方法定义native层编码器对象。
ImagePacker_Opts 定义图像编码选项的别名。
NativePixelMap 定义native层PixelMap数据类型名称。
OhosPixelMapInfos 用于定义PixelMap的相关信息。
ImageReceiverNative 用于定义ImageReceiverNative数据类型名称。
(*OH_Image_Receiver_On_Callback) () 定义native层图片的回调方法。
ImageSourceNative 为图像源方法定义native层图像源对象。

宏定义

名称 描述
IMAGE_RESULT_BASE 62980096 接口返回值的基础值

枚举

名称 描述
{ OHOS_IMAGE_FORMAT_YCBCR_422_SP = 1000,
OHOS_IMAGE_FORMAT_JPEG = 2000 }
图像格式枚举值。
{ OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y = 1,
OHOS_IMAGE_COMPONENT_FORMAT_YUV_U = 2,
OHOS_IMAGE_COMPONENT_FORMAT_YUV_V = 3,
OHOS_IMAGE_COMPONENT_FORMAT_JPEG = 4 }
图像组成类型枚举值。
IRNdkErrCode {
IMAGE_RESULT_SUCCESS = 0, IMAGE_RESULT_BAD_PARAMETER = -1,
IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,
IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,
IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,
IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3,
IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,
IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,
IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,
IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,
IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,
IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,
IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,
IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,
IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,
IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,
IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,
IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,
IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,
IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,
IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,
IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,
IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,
IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,
IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,
IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,
IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,
IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,
IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,
IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,
IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,
IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,
IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,
IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,
IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,
IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,
IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,
IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,
IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,
IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,
IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,
IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,
IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,
IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,
IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,
IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,
IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,
IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,
IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,
IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,
IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,
IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,
IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,
IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53,
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,
IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,
IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,
IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,
IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,
IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,
IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,
IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,
IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,
IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,
IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,
IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,
IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,
IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,
IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,
IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,
IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,
IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,
IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,
IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,
IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,
IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,
IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,
IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,
IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,
IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,
IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,
IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,
IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,
IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,
IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,
IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,
IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,
IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,
IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,
IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,
IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,
IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,
IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,
IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,
IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,
IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,
IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,
IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,
IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,
IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200
}
可能出现的返回值的枚举。
{ OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0,
OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1,
OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2,
OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 }
PixelMap 透明度类型的枚举。
{ OHOS_PIXEL_MAP_READ_ONLY = 0,
OHOS_PIXEL_MAP_EDITABLE = 1 }
PixelMap 编辑类型的枚举。
{ OHOS::Media::OHOS_IMAGE_RESULT_SUCCESS = 0,
OHOS::Media::OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 }
函数方法返回值的错误码的枚举。
{ OHOS::Media::OHOS_PIXEL_MAP_FORMAT_NONE = 0,
OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3,
OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 }
pixel 格式的枚举。
{ OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0,
OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 }
PixelMap 缩放类型的枚举。

函数

名称 描述
OH_Image_InitImageNative (napi_env env, napi_value source) 从输入的JavaScript Native API 图像 对象中解析 native ImageNative 对象。
OH_Image_ClipRect (const ImageNative *native, struct OhosImageRect *rect) 获取native ImageNative 对象 OhosImageRect 信息。
OH_Image_Size (const ImageNative *native, struct OhosImageSize *size) 获取native ImageNative 对象的 OhosImageSize 信息。
OH_Image_Format (const ImageNative *native, int32_t *format) 获取native ImageNative 对象的图像格式。
OH_Image_GetComponent (const ImageNative *native, int32_t componentType, struct OhosImageComponent *componentNative) 从 native ImageNative 对象中获取 OhosImageComponent
OH_Image_Release (ImageNative *native) 释放 ImageNative native对象。
OH_ImagePacker_Create (napi_env env, napi_value *res) 获取JavaScript native层ImagePacker对象。
OH_ImagePacker_InitNative (napi_env env, napi_value packer) 从输入JavaScript native层ImagePacker对象中,转换成ImagePacker_Native值。
OH_ImagePacker_PackToData (ImagePacker_Native *native, napi_value source, ImagePacker_Opts *opts, uint8_t *outData, size_t *size) 通过一个给定的选项ImagePacker_Opts结构体,将输入JavaScript native层PixelMap对象或者ImageSource对象编码并输出到指定的缓存区outData中。
OH_ImagePacker_PackToFile (ImagePacker_Native *native, napi_value source, ImagePacker_Opts *opts, int fd) 通过一个给定的选项ImagePacker_Opts结构体,将输入JavaScript native层PixelMap对象或者ImageSource对象编码并输出到指定的文件中。
OH_ImagePacker_Release (ImagePacker_Native *native) 释放native层编码器对象ImagePacker_Native
OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void *buf, size_t len, napi_value *res) 创建PixelMap对象。
OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value *alpha) 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的PixelMap对象。
OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source) 初始化PixelMap对象数据。
OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap *native, int32_t *num) 获取PixelMap对象每行字节数。
OH_PixelMap_GetIsEditable (const NativePixelMap *native, int32_t *editable) 获取PixelMap对象是否可编辑的状态。
OH_PixelMap_IsSupportAlpha (const NativePixelMap *native, int32_t *alpha) 获取PixelMap对象是否支持Alpha通道。
OH_PixelMap_SetAlphaAble (const NativePixelMap *native, int32_t alpha) 设置PixelMap对象的Alpha通道。
OH_PixelMap_GetDensity (const NativePixelMap *native, int32_t *density) 获取PixelMap对象像素密度。
OH_PixelMap_SetDensity (const NativePixelMap *native, int32_t density) 设置PixelMap对象像素密度。
OH_PixelMap_SetOpacity (const NativePixelMap *native, float opacity) 设置PixelMap对象的透明度。
OH_PixelMap_Scale (const NativePixelMap *native, float x, float y) 设置PixelMap对象的缩放。
OH_PixelMap_Translate (const NativePixelMap *native, float x, float y) 设置PixelMap对象的偏移。
OH_PixelMap_Rotate (const NativePixelMap *native, float angle) 设置PixelMap对象的旋转。
OH_PixelMap_Flip (const NativePixelMap *native, int32_t x, int32_t y) 设置PixelMap对象的翻转。
OH_PixelMap_Crop (const NativePixelMap *native, int32_t x, int32_t y, int32_t width, int32_t height) 设置PixelMap对象的裁剪。
OH_PixelMap_GetImageInfo (const NativePixelMap *native, OhosPixelMapInfos *info) 获取PixelMap对象图像信息。
OH_PixelMap_AccessPixels (const NativePixelMap *native, void **addr) 获取native PixelMap 对象数据的内存地址,并锁定该内存。
OH_PixelMap_UnAccessPixels (const NativePixelMap *native) 释放native PixelMap对象数据的内存锁,用于匹配方法OH_PixelMap_AccessPixels
OHOS::Media::OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo *info) 获取 PixelMap 的信息,并记录信息到OhosPixelMapInfo结构中。
OHOS::Media::OH_AccessPixels (napi_env env, napi_value value, void **addrPtr) 获取PixelMap对象数据的内存地址,并锁定该内存。
OHOS::Media::OH_UnAccessPixels (napi_env env, napi_value value) 释放PixelMap对象数据的内存锁, 用于匹配方法OH_AccessPixels
OH_Image_Receiver_CreateImageReceiver (napi_env env, struct OhosImageReceiverInfo info, napi_value *res) 创建应用层 ImageReceiver 对象。
OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source) 通过应用层ImageReceiver对象初始化native层ImageReceiverNative对象。
OH_Image_Receiver_GetReceivingSurfaceId (const ImageReceiverNative *native, char *id, size_t len) 通过ImageReceiverNative获取receiver的id。
OH_Image_Receiver_ReadLatestImage (const ImageReceiverNative *native, napi_value *image) 通过ImageReceiverNative获取最新的一张图片。
OH_Image_Receiver_ReadNextImage (const ImageReceiverNative *native, napi_value *image) 通过ImageReceiverNative获取下一张图片。
OH_Image_Receiver_On (const ImageReceiverNative *native, OH_Image_Receiver_On_Callback callback) 注册一个OH_Image_Receiver_On_Callback回调事件。每当接收新图片,该回调事件就会响应。
OH_Image_Receiver_GetSize (const ImageReceiverNative *native, struct OhosImageSize *size) 通过ImageReceiverNative获取ImageReceiver的大小。
OH_Image_Receiver_GetCapacity (const ImageReceiverNative *native, int32_t *capacity) 通过ImageReceiverNative获取ImageReceiver的容量。
OH_Image_Receiver_GetFormat (const ImageReceiverNative *native, int32_t *format) 通过ImageReceiverNative获取ImageReceiver的格式。
OH_Image_Receiver_Release (ImageReceiverNative *native) 释放native层 ImageReceiverNative 对象。
OH_ImageSource_Create (napi_env env, struct OhosImageSource *src, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的信息OhosImageSourceOhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。
OH_ImageSource_CreateFromUri (napi_env env, char *uri, size_t size, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的标识符URI和OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。
OH_ImageSource_CreateFromFd (napi_env env, int32_t fd, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的文件描述符fd和OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。
OH_ImageSource_CreateFromData (napi_env env, uint8_t *data, size_t dataSize, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的图像源缓冲区资源data和OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。
OH_ImageSource_CreateFromRawFile (napi_env env, RawFileDescriptor rawFile, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的资源描述符RawFileDescriptorOhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。
OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource *source, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的OhosImageSourceOhosImageSourceOps结构,获取增量类型的avaScript native层ImageSource对象。
OH_ImageSource_CreateIncrementalFromData (napi_env env, uint8_t *data, size_t dataSize, struct OhosImageSourceOps *ops, napi_value *res) 通过给定的图像源缓冲区资源data和OhosImageSourceOps结构体,获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。
OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList *res) 获取所有支持的解码格式元标记。
OH_ImageSource_InitNative (napi_env env, napi_value source) 从输入JavaScript native层ImageSource 对象中,转换成ImageSourceNative值。
OH_ImageSource_CreatePixelMap (const ImageSourceNative *native, struct OhosImageDecodingOps *ops, napi_value *res) 通过一个给定的选项OhosImageDecodingOps结构体,从ImageSource中解码JavaScript native层PixelMap对象
OH_ImageSource_CreatePixelMapList (const ImageSourceNative *native, struct OhosImageDecodingOps *ops, napi_value *res) 通过一个给定的选项OhosImageDecodingOps结构体,从ImageSource中解码所有的JavaScript native层PixelMap对象列表
OH_ImageSource_GetDelayTime (const ImageSourceNative *native, struct OhosImageSourceDelayTimeList *res) 从一些ImageSource(如GIF图像源)获取延迟时间列表。
OH_ImageSource_GetFrameCount (const ImageSourceNative *native, uint32_t *res) ImageSource中获取帧计数。
OH_ImageSource_GetImageInfo (const ImageSourceNative *native, int32_t index, struct OhosImageSourceInfo *info) 通过索引从ImageSource获取图像源信息。
OH_ImageSource_GetImageProperty (const ImageSourceNative *native, struct OhosImageSourceProperty *key, struct OhosImageSourceProperty *value) 通过关键字从ImageSource中获取图像源属性。
OH_ImageSource_ModifyImageProperty (const ImageSourceNative *native, struct OhosImageSourceProperty *key, struct OhosImageSourceProperty *value) 通过关键字为ImageSource修改图像源属性。
OH_ImageSource_UpdateData (const ImageSourceNative *native, struct OhosImageSourceUpdateData *data) 为了增量类型的ImageSource更新源数据。
OH_ImageSource_Release (ImageSourceNative *native) 释放native层图像源ImageSourceNative

变量

名称 描述
OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample" 定义每个样本比特的图像属性关键字。
OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation" 定义方向的图像属性关键字。
OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength" 定义图像长度的图像属性关键字。
OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth" 定义图像宽度的图像属性关键字。
OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude" 定义GPS纬度的图像属性关键字。
OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude" 定义GPS经度的图像属性关键字。
OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef" 定义GPS纬度参考的图像属性关键字。
OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef" 定义GPS经度参考的图像属性关键字。
OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal" 定义初始日期时间的图像属性关键字。
OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime" 定义曝光时间的图像属性关键字。
OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType" 定义场景类型的图像属性关键字。
OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings" 定义ISO速度等级的图像属性关键字。
OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber" 定义FNumber的图像属性关键字。
OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel" 定义每个像素的压缩比特的图像属性关键字。
OhosImageRegion::x 起始x坐标,用pixels表示。
OhosImageRegion::y 起始y坐标,用pixels表示。
OhosImageRegion::width 宽度范围,用pixels表示。
OhosImageRegion::height 高度范围,用pixels表示。
OhosImageSourceOps::density 图像源像素密度。
OhosImageSourceOps::pixelFormat 图像源像素格式,通常用于描述YUV缓冲区。
OhosImageSourceOps::size 图像源像素宽高的大小。
OhosImageDecodingOps::editable 定义输出的像素位图是否可编辑。
OhosImageDecodingOps::pixelFormat 定义输出的像素格式。
OhosImageDecodingOps::fitDensity 定义解码目标的像素密度。
OhosImageDecodingOps::index 定义图像源解码指数。
OhosImageDecodingOps::sampleSize 定义解码样本大小选项。
OhosImageDecodingOps::rotate 定义解码旋转选项。
OhosImageDecodingOps::size 定义解码目标像素宽高的大小。
OhosImageDecodingOps::region 定义图像源解码的像素范围。
OhosImageSourceInfo::pixelFormat 图像源像素格式,由OH_ImageSource_Create设置。
OhosImageSourceInfo::colorSpace 图像源色彩空间。
OhosImageSourceInfo::alphaType 图像源透明度类型。
OhosImageSourceInfo::density 图像源密度,由OH_ImageSource_Create设置。
OhosImageSourceInfo::size 图像源像素宽高的大小。
OhosImageSource::uri = nullptr 图像源资源标识符,接受文件资源或者base64资源。
OhosImageSource::uriSize = 0 图像源资源长度。
OhosImageSource::fd = -1 图像源文件资源描述符。
OhosImageSource::buffer = nullptr 图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区。
OhosImageSource::bufferSize = 0 图像源缓冲区资源大小。
OhosImageSourceDelayTimeList::delayTimeList 图像源延迟时间列表头地址。
OhosImageSourceDelayTimeList::size = 0 图像源延迟时间列表大小。
OhosImageSourceSupportedFormat::format = nullptr 图像源支持的格式字符串头地址。
OhosImageSourceSupportedFormat::size = 0 图像源支持的格式字符串大小
OhosImageSourceSupportedFormatList::supportedFormatList = nullptr 图像源支持的格式字符串列表头地址。
OhosImageSourceSupportedFormatList::size = 0 图像源支持的格式字符串列表大小。
OhosImageSourceProperty::value = nullptr 定义图像源属性键值字符串头地址。
OhosImageSourceProperty::size = 0 定义图像源属性键值字符串大小。
OhosImageSourceUpdateData::buffer = nullptr 图像源更新数据缓冲区。
OhosImageSourceUpdateData::bufferSize = 0 图像源更新数据缓冲区大小。
OhosImageSourceUpdateData::offset = 0 图像源更新数据缓冲区的开端
OhosImageSourceUpdateData::updateLength = 0 图像源更新数据缓冲区的更新数据长度。
OhosImageSourceUpdateData::isCompleted = 0 图像源更新数据在此节中完成。

类型定义说明

ImageNative

typedef struct ImageNative_ ImageNative

描述

为图像接口定义native层图像对象。

起始版本: 10

ImagePacker_Native

typedef struct ImagePacker_Native_ ImagePacker_Native

描述

为编码器方法定义native层编码器对象。

起始版本: 11

ImagePacker_Opts

typedef struct ImagePacker_Opts_ImagePacker_Opts

描述

定义图像编码选项的别名。

起始版本: 11

ImageReceiverNative

typedef struct ImageReceiverNative_ ImageReceiverNative

描述

用于定义ImageReceiverNative数据类型名称。

起始版本: 10

ImageSourceNative

typedef struct ImageSourceNative_ ImageSourceNative

描述

为图像源方法定义native层图像源对象。

起始版本: 10

IRNdkErrCode

typedef enum anonymous3IRNdkErrCode

描述

可能出现的返回值的枚举。

起始版本: 10

NativePixelMap

typedef struct NativePixelMap_ NativePixelMap

描述

定义native层PixelMap数据类型名称。

起始版本: 10

OH_Image_Receiver_On_Callback

typedef void(* OH_Image_Receiver_On_Callback) ()

描述

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

起始版本: 10

OhosPixelMapInfos

typedef struct OhosPixelMapInfos

描述

用于定义PixelMap的相关信息。

起始版本: 10

枚举类型说明

anonymous enum [1/3]

anonymous enum

描述

图像格式枚举值。

起始版本: 10

枚举值 描述
OHOS_IMAGE_FORMAT_YCBCR_422_SP YCBCR422 semi-planar 格式
OHOS_IMAGE_FORMAT_JPEG JPEG 编码格式

anonymous enum [2/3]

anonymous enum

描述

PixelMap透明度类型的枚举。

起始版本: 10

枚举值 描述
OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN 未知的格式
OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE 不透明的格式
OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL 预乘的格式
OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL 预除的格式

anonymous enum [3/3]

anonymous enum

描述

函数方法返回值的错误码的枚举。

起始版本: 8

废弃起始版本: 10

枚举值 描述
OHOS_IMAGE_RESULT_SUCCESS 成功的结果
OHOS_IMAGE_RESULT_BAD_PARAMETER 无效值

anonymous enum [1/3]

anonymous enum

描述

图像组成类型枚举值。

起始版本: 10

枚举值 描述
OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y 亮度信息
OHOS_IMAGE_COMPONENT_FORMAT_YUV_U 色度信息
OHOS_IMAGE_COMPONENT_FORMAT_YUV_V 色差值信息
OHOS_IMAGE_COMPONENT_FORMAT_JPEG Jpeg 格式

anonymous enum [2/3]

anonymous enum

描述

PixelMap 编辑类型的枚举。

起始版本: 10

枚举值 描述
OHOS_PIXEL_MAP_READ_ONLY 只读的格式
OHOS_PIXEL_MAP_EDITABLE 可编辑的格式

anonymous enum [3/3]

anonymous enum

描述

Pixel格式的枚举。

起始版本: 8

废弃起始版本: 10

枚举值 描述
OHOS_PIXEL_MAP_FORMAT_NONE 未知的格式
OHOS_PIXEL_MAP_FORMAT_RGBA_8888 32-bit RGBA. 由 R, G, B组成,包括 A 都需要占用 8 bits。存储顺序是从高位到低位。
OHOS_PIXEL_MAP_FORMAT_RGB_565 16-bit RGB. 仅由 R, G, B 组成。 存储顺序是从高位到低位: 红色占用5 bits,绿色占用6 bits,蓝色占用5 bits。

anonymous enum

anonymous enum

描述:

PixelMap缩放类型的枚举。

起始版本: 10

枚举值 描述
OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE 适应目标图片大小的格式
OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP 以中心进行缩放的格式

IRNdkErrCode

enum IRNdkErrCode

描述

可能被使用的接口返回值的枚举。

起始版本: 10

枚举值 描述
IMAGE_RESULT_SUCCESS 操作成功
IMAGE_RESULT_BAD_PARAMETER 无效参数
IMAGE_RESULT_IMAGE_RESULT_BASE 操作失败
IMAGE_RESULT_ERR_IPC ipc 错误
IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST 共享内存失败
IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL 共享内存数据异常
IMAGE_RESULT_DECODE_ABNORMAL 图像解码失败
IMAGE_RESULT_DATA_ABNORMAL 图像输入数据异常
IMAGE_RESULT_MALLOC_ABNORMAL 图像内存分配异常
IMAGE_RESULT_DATA_UNSUPPORT 图像类型不支持
IMAGE_RESULT_INIT_ABNORMAL 图像初始化失败
IMAGE_RESULT_GET_DATA_ABNORMAL 图像获取数据错误
IMAGE_RESULT_TOO_LARGE 图像数据过大
IMAGE_RESULT_TRANSFORM 图像转换错误
IMAGE_RESULT_COLOR_CONVERT 图像颜色转换错误
IMAGE_RESULT_CROP 裁剪错误
IMAGE_RESULT_SOURCE_DATA 图像源数据错误
IMAGE_RESULT_SOURCE_DATA_INCOMPLETE 图像源数据不完整
IMAGE_RESULT_MISMATCHED_FORMAT 图像格式不匹配
IMAGE_RESULT_UNKNOWN_FORMAT 图像未知格式
IMAGE_RESULT_SOURCE_UNRESOLVED 图像源未解析
IMAGE_RESULT_INVALID_PARAMETER 图像无效参数
IMAGE_RESULT_DECODE_FAILED 解码失败
IMAGE_RESULT_PLUGIN_REGISTER_FAILED 注册插件失败
IMAGE_RESULT_PLUGIN_CREATE_FAILED 创建插件失败
IMAGE_RESULT_ENCODE_FAILED 图像编码失败
IMAGE_RESULT_ADD_PIXEL_MAP_FAILED 图像添加像素位图失败
IMAGE_RESULT_HW_DECODE_UNSUPPORT 图像硬解码不支持
IMAGE_RESULT_DECODE_HEAD_ABNORMAL 图像头解码失败
IMAGE_RESULT_DECODE_EXIF_UNSUPPORT 图像解码EXIF不支持
IMAGE_RESULT_PROPERTY_NOT_EXIST 图像属性不存在
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 媒体类型不支持
IMAGE_RESULT_MEDIA_TOO_LARGE 媒体数据过大
IMAGE_RESULT_MEDIA_MALLOC_FAILED 媒体分配内存失败
IMAGE_RESULT_MEDIA_END_OF_STREAM 媒体数据流结束失败
IMAGE_RESULT_MEDIA_IO_ABNORMAL 媒体输入输出流异常
IMAGE_RESULT_MEDIA_MALFORMED 媒体功能异常
IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL 媒体数据过小错误
IMAGE_RESULT_MEDIA_OUT_OF_RANGE 媒体超出范围错误
IMAGE_RESULT_MEDIA_STATUS_ABNORMAL 媒体状态异常错误
IMAGE_RESULT_MEDIA_VALUE_INVALID 媒体值无效
IMAGE_RESULT_MEDIA_NULL_POINTER 媒体操作失败
IMAGE_RESULT_MEDIA_INVALID_OPERATION 媒体操作无效
IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT 媒体初始化异常
IMAGE_RESULT_MEDIA_EARLY_PREPARE 媒体过早预处理
IMAGE_RESULT_MEDIA_SEEK_ERR 媒体查找失败
IMAGE_RESULT_MEDIA_PERMISSION_DENIED 媒体权限拒绝
IMAGE_RESULT_MEDIA_DEAD_OBJECT 媒体对象注销
IMAGE_RESULT_MEDIA_TIMED_OUT 媒体超时
IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED 媒体能力不支持
IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED 媒体适配器初始化失败
IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL 写入parcel失败
IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL 读取parcel失败
IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER 无效数据
IMAGE_RESULT_MEDIA_INVALID_PARAM 媒体接口发现无效参数
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST 媒体代码适配器不存在
IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED 媒体创建代码适配器失败
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT 媒体代码适配器未初始化
IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED 媒体代码创建失败
IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST 媒体代码不存在
IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST 媒体JNI层类不存在
IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST 媒体JNI层方法不存在
IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED 媒体JNI层创建对象失败
IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR 媒体JNI层异常
IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT 媒体不支持分布
IMAGE_RESULT_MEDIA_SOURCE_NOT_SET 媒体源未设置
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT 媒体rtsp适配器未初始化
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST 媒体rtsp适配器不存在
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT 媒体不支持rtsp surface
IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT 媒体rtsp capture初始化失败
IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID 媒体rtsp源路径无效
IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND 媒体rtsp未发现视频能力
IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX rtsp相机数量达到最大数量
IMAGE_RESULT_MEDIA_SET_VOLUME 媒体设置卷失败
IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW 媒体操作次数溢出
IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED 媒体分布式播放器不支持
IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED 图像解码ICC失败
IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED 图像编码ICC失败
IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED 读取像素位图失败
IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED 写入像素位图失败
IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY 像素位图不允许修改
IMAGE_RESULT_MEDIA_CONFIG_FAILED 配置失败
IMAGE_RESULT_JNI_ENV_ABNORMAL JNI环境异常
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED surface申请内存失败
IMAGE_RESULT_CREATE_SURFACE_FAILED 创建surface失败
IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED 从surface获取参数失败
IMAGE_RESULT_GET_SURFACE_FAILED 获取surface失败
IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED 申请内存失败
IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED 申请内存失败
IMAGE_RESULT_REGISTER_LISTENER_FAILED 注册监听失败
IMAGE_RESULT_REGISTER_BUFFER_FAILED 注册内存失败
IMAGE_RESULT_FREAD_FAILED 读取文件失败
IMAGE_RESULT_PEEK_FAILED 检测文件失败
IMAGE_RESULT_SEEK_FAILED 查找文件失败
IMAGE_RESULT_STREAM_SIZE_ERROR 数据流损坏
IMAGE_RESULT_FILE_FD_ERROR 文件描述符损坏
IMAGE_RESULT_FILE_DAMAGED 文件损坏
IMAGE_RESULT_CREATE_DECODER_FAILED 创建解码失败
IMAGE_RESULT_CREATE_ENCODER_FAILED 创建编码失败
IMAGE_RESULT_CHECK_FORMAT_ERROR 检查格式失败
IMAGE_RESULT_THIRDPART_SKIA_ERROR skia解码失败
IMAGE_RESULT_HW_DECODE_FAILED 硬解码失败
IMAGE_RESULT_ALLOCATER_TYPE_ERROR 内存类型校验失败
IMAGE_RESULT_ALPHA_TYPE_ERROR 透明度类型失败
IMAGE_RESULT_INDEX_INVALID 参数无效
IMAGE_RESULT_MEDIA_UNKNOWN 媒体未知错误

函数说明

OH_AccessPixels()

int32_t OHOS::Media::OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr )

描述

获取PixelMap对象数据的内存地址,并锁定该内存。

函数执行成功后,*addrPtr就是获取的待访问的内存地址。访问操作完成后,必须要使用OH_UnAccessPixels来释放锁,否则的话资源无法被释放。 待解锁后,内存地址就不可以再被访问和操作。

起始版本: 8

废弃起始版本: 10

参数:

名称 描述
env napi的环境指针。
value 应用层的 PixelMap 对象。
addrPtr 用于指向的内存地址的二级指针对象。

参见:

UnAccessPixels

返回:

操作成功则返回OHOS_IMAGE_RESULT_SUCCESS;如果操作失败,则返回错误码。

OH_GetImageInfo()

int32_t OHOS::Media::OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo * info )

描述

获取 PixelMap 的信息,并记录信息到OhosPixelMapInfo结构中。

起始版本: 8

废弃起始版本: 10

参数:

名称 描述
env napi的环境指针。
value 应用层的 PixelMap 对象。
info 用于保存信息的指针对象。 更多细节, 参看 OhosPixelMapInfo

返回:

如果获取并保存信息成功,则返回0; 如果操作失败,则返回错误码。

参见:

OhosPixelMapInfo

OH_Image_ClipRect()

int32_t OH_Image_ClipRect (const ImageNative * native, struct OhosImageRect * rect )

描述

获取native ImageNative 对象 OhosImageRect 信息。

起始版本: 10

参数:

名称 描述
native 表示指向 ImageNative native层对象的指针。
rect 表示作为转换结果的 OhosImageRect 对象指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果JNI环境异常返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果参数错误返回IMAGE_RESULT_BAD_PARAMETER 。

参见:

ImageNative, OhosImageRect

OH_Image_Format()

int32_t OH_Image_Format (const ImageNative * native, int32_t * format )

描述

获取native ImageNative 对象的图像格式。

起始版本: 10

参数:

名称 描述
native 表示 ImageNative native对象的指针。
format 表示作为转换结果的图像格式对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果JNI环境异常返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果参数错误返回IMAGE_RESULT_BAD_PARAMETER 。

参见:

ImageNative

OH_Image_GetComponent()

int32_t OH_Image_GetComponent (const ImageNative * native, int32_t componentType, struct OhosImageComponent * componentNative )

描述

从 native ImageNative 对象中获取 OhosImageComponent

起始版本: 10

参数:

名称 描述
native 表示 ImageNative native对象的指针。
componentType 表示所需组件的组件类型。
componentNative 表示转换结果的 OhosImageComponent 对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果JNI环境异常返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果参数错误返回IMAGE_RESULT_BAD_PARAMETER 。

参见:

ImageNative, OhosImageComponent

OH_Image_InitImageNative()

ImageNative* OH_Image_InitImageNative (napi_env env, napi_value source )

描述

从输入的JavaScript Native API 图像 对象中解析 native ImageNative 对象。

起始版本: 10

参数:

名称 描述
env 表示指向 JNI 环境的指针。
source 表示 JavaScript Native API 图像 对象。

返回:

如果操作成果返回 ImageNative 指针对象,如果操作失败返回空指针。

参见:

ImageNative, OH_Image_Release

OH_Image_Receiver_CreateImageReceiver()

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

描述

创建应用层 ImageReceiver 对象。

起始版本: 10

参数:

名称 描述
env napi的环境指针。
info ImageReceiver 数据设置项。
res 应用层的 ImageReceiver 对象的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

从surface获取参数失败则返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果创建surface失败则返回IMAGE_RESULT_CREATE_SURFACE_FAILED;

如果surface分配内存失败则返回IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED;

如果获取surface失败则返回IMAGE_RESULT_GET_SURFACE_FAILED;

如果媒体rtsp surface不支持则返回IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果媒体类型不支持失败则返回IMAGE_RESULT_MEDIA_DATA_UNSUPPORT。

参见:

OhosImageReceiverInfo

OH_Image_Receiver_GetCapacity()

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

描述

通过ImageReceiverNative获取ImageReceiver的容量。

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
capacity 作为结果的指向容量的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT。

参见:

ImageReceiverNative, OhosImageSize

OH_Image_Receiver_GetFormat()

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

描述

通过ImageReceiverNative获取ImageReceiver的格式。

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
format 作为结果的指向格式的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT。

参见:

ImageReceiverNative

OH_Image_Receiver_GetReceivingSurfaceId()

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

描述

通过ImageReceiverNative获取receiver的id。

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
id 指向字符缓冲区的指针,用于获取字符串的id。
len id所对应的字符缓冲区的大小。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

从surface获取参数失败则返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果获取surface失败则返回IMAGE_RESULT_GET_SURFACE_FAILED;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果媒体类型不支持失败则返回IMAGE_RESULT_MEDIA_DATA_UNSUPPORT。

参见:

ImageReceiverNative

OH_Image_Receiver_GetSize()

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

描述

通过ImageReceiverNative获取ImageReceiver的大小。

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
size 作为结果的OhosImageSize指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT。

参见:

ImageReceiverNative, OH_Image_Receiver_On_Callback

OH_Image_Receiver_InitImageReceiverNative()

ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source )

描述

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

起始版本: 10

参数:

名称 描述
env napi的环境指针。
source napi的 ImageReceiver 对象。

返回:

操作成功则返回 ImageReceiverNative 指针;如果操作失败,则返回nullptr。

参见:

ImageReceiverNative, OH_Image_Receiver_Release

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

参数:

名称 描述
native native层的ImageReceiverNative指针。
callback OH_Image_Receiver_On_Callback事件的回调函数。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效或从surface获取参数失败则返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取surface失败则返回IMAGE_RESULT_GET_SURFACE_FAILED;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果注册监听失败则返回IMAGE_RESULT_REGISTER_LISTENER_FAILED;

如果注册内存失败则返回IMAGE_RESULT_REGISTER_BUFFER_FAILED。

参见:

ImageReceiverNative

OH_Image_Receiver_ReadLatestImage()

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

描述

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

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
image 获取到的应用层的 Image 指针对象。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果创建surface失败则返回IMAGE_RESULT_CREATE_SURFACE_FAILED;

如果surface分配内存失败则返回IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED;

如果获取surface失败则返回IMAGE_RESULT_GET_SURFACE_FAILED;

如果媒体rtsp surface不支持则返回IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果申请内存失败则返回IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED。

参见:

ImageReceiverNative

OH_Image_Receiver_ReadNextImage()

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

描述

通过ImageReceiverNative获取下一张图片。

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。
image 读取到的应用层的 Image 指针对象。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果创建surface失败则返回IMAGE_RESULT_CREATE_SURFACE_FAILED;

如果surface分配内存失败则返回IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED;

如果获取surface失败则返回IMAGE_RESULT_GET_SURFACE_FAILED;

如果媒体rtsp surface不支持则返回IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT;

如果图像类型不支持失败则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果申请内存失败则返回IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED。

参见:

ImageReceiverNative

OH_Image_Receiver_Release()

int32_t OH_Image_Receiver_Release (ImageReceiverNative * native)

描述

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

起始版本: 10

参数:

名称 描述
native native层的ImageReceiverNative指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

ImageReceiverNative

OH_Image_Release()

int32_t OH_Image_Release (ImageNative * native)

描述

释放 ImageNative native对象。 Note: 这个方法无法释放 JavaScript Native API Image 对象, 而是释放被 OH_Image_InitImageNative 解析的 ImageNative native 对象。

起始版本: 10

参数:

名称 描述
native 表示 ImageNative native对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果JNI环境异常返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果参数错误返回IMAGE_RESULT_BAD_PARAMETER。

参见:

ImageNative, OH_Image_InitImageNative

OH_Image_Size()

int32_t OH_Image_Size (const ImageNative * native, struct OhosImageSize * size )

描述

获取native ImageNative 对象的 OhosImageSize 信息。

起始版本: 10

参数:

名称 描述
native 表示 ImageNative native对象的指针。
size 表示作为转换结果的 OhosImageSize 对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果JNI环境异常返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果从surface获取参数失败返回IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;

如果参数错误返回IMAGE_RESULT_BAD_PARAMETER。

参见:

ImageNative, OhosImageSize

OH_ImagePacker_Create()

int32_t OH_ImagePacker_Create (napi_env env, napi_value * res )

描述

获取JavaScript native层ImagePacker对象。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
res 表明JavaScript native层ImagePacker对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER。

OH_ImagePacker_InitNative()

ImagePacker_Native* OH_ImagePacker_InitNative (napi_env env, napi_value packer )

描述

从输入JavaScript native层ImagePacker对象中,转换成ImagePacker_Native值。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
packer 表明JavaScript native层ImagePacker对象。

返回:

如果操作成功则返回ImagePacker_Native指针,否则返回空指针。

参见:

OH_ImagePacker_Release

OH_ImagePacker_PackToData()

int32_t OH_ImagePacker_PackToData (ImagePacker_Native * native, napi_value source, ImagePacker_Opts * opts, uint8_t * outData, size_t * size )

描述

通过一个给定的选项ImagePacker_Opts结构体,将输入JavaScript native层PixelMap对象或者ImageSource对象编码并输出到指定的缓存区outData中。

起始版本: 11

参数:

名称 描述
native 表明指向native层ImagePacker的指针。
source 表明待编码JavaScript native层PixelMap对象或者ImageSource对象。
opts 表明位图编码的选项,查看ImagePacker_Opts
outData 输出的指定缓存区。
size 输出的指定缓存区大小。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果输出缓冲区异常返回ERR_IMAGE_DATA_ABNORMAL;

如果格式不匹配返回ERR_IMAGE_MISMATCHED_FORMAT;

如果malloc内部缓冲区错误返回ERR_IMAGE_MALLOC_ABNORMAL;

如果init编解码器内部错误返回ERR_IMAGE_DECODE_ABNORMAL;

如果编码器在编码过程中出现错误返回ERR_IMAGE_ENCODE_FAILED。

参见:

OH_ImagePacker_PackToFile

OH_ImagePacker_PackToFile()

int32_t OH_ImagePacker_PackToFile (ImagePacker_Native * native, napi_value source, ImagePacker_Opts * opts, int fd )

描述

通过一个给定的选项ImagePacker_Opts结构体,将输入JavaScript native层PixelMap对象或者ImageSource对象编码并输出到指定的文件中。

起始版本: 11

参数:

名称 描述
native 表明指向native层ImagePacker的指针。
source 表明待编码JavaScript native层PixelMap对象或者ImageSource对象。
opts 表明位图编码的选项,查看ImagePacker_Opts
fd 输出的指定文件描述符。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数无效返回IMAGE_RESULT_INVALID_PARAMETER;

如果输出缓冲区异常返回ERR_IMAGE_DATA_ABNORMAL;

如果格式不匹配返回ERR_IMAGE_MISMATCHED_FORMAT;

如果malloc内部缓冲区错误返回ERR_IMAGE_MALLOC_ABNORMAL;

如果init编解码器内部错误返回ERR_IMAGE_DECODE_ABNORMAL;

如果编码器在编码过程中出现错误返回ERR_IMAGE_ENCODE_FAILED。

参见:

OH_ImagePacker_PackToData

OH_ImagePacker_Release()

int32_t OH_ImagePacker_Release (ImagePacker_Native * native)

描述

释放native层编码器对象ImagePacker_Native

此API不用于释放JavaScript原生API ImagePacker对象,它用于释放native层对象ImagePacker_Native

通过调用OH_ImagePacker_InitNative解析。

起始版本: 11

参数:

名称 描述
native 表明native层ImagePacker_Native值的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS。

参见:

OH_ImagePacker_InitNative

OH_ImageSource_Create()

int32_t OH_ImageSource_Create (napi_env env, struct OhosImageSource * src, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的信息OhosImageSourceOhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。

起始版本: 10

废弃起始版本: 11

请使用OH_ImageSource_CreateFromUriOH_ImageSource_CreateFromFdOH_ImageSource_CreateFromData替代。

参数:

名称 描述
env 表明JNI环境的指针。
src 表明创建一个图像源的信息。查看OhosImageSource获取更多细节。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;

如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;

如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;

如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;

如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;

如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;

如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;

如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;

如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;

如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。

参见:

OhosImageSource, OhosImageSourceOps

OH_ImageSource_CreateFromData()

int32_t OH_ImageSource_CreateFromData (napi_env env, uint8_t * data, size_t dataSize, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的图像源缓冲区资源 data 和 OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
data 表明图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区。
dataSize 表明图像源缓冲区资源大小。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

OhosImageSourceOps

OH_ImageSource_CreateFromFd()

int32_t OH_ImageSource_CreateFromFd (napi_env env, int32_t fd, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的文件描述符 fd 和 OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
fd 表明图像源文件资源描述符。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

OhosImageSourceOps

OH_ImageSource_CreateFromRawFile()

int32_t OH_ImageSource_CreateFromRawFile (napi_env env, RawFileDescriptor rawFile, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的资源描述符 RawFileDescriptorOhosImageSourceOps结构体, 获取JavaScript native层ImageSource对象。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
rawFile 表明图像源资源描述符。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

OhosImageSourceOps

OH_ImageSource_CreateFromUri()

int32_t OH_ImageSource_CreateFromUri (napi_env env, char * uri, size_t size, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的标识符URI 和 OhosImageSourceOps结构体,获取JavaScript native层ImageSource对象。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
uri 表明图像源资源标识符,接受文件资源或者base64资源。
size 表明图像源资源URI的长度。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

OhosImageSourceOps

OH_ImageSource_CreateIncremental()

int32_t OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource * source, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的informationsOhosImageSourceOhosImageSourceOps结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。

起始版本: 10

废弃起始版本: 11

请使用OH_ImageSource_CreateIncrementalFromData替代。

参数:

名称 描述
env 表明JNI环境的指针。
src 表明创建一个图像源的信息,只接收缓冲区类型。具体查看OhosImageSource
ops 表明创建一个图像源的选项。具体查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;

如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;

如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;

如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;

如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;

如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;

如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;

如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;

如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;

如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。

参见:

OhosImageSource, OhosImageSourceOps, OH_ImageSource_UpdateData

OH_ImageSource_CreateIncrementalFromData()

int32_t OH_ImageSource_CreateIncrementalFromData (napi_env env, uint8_t * data, size_t dataSize, struct OhosImageSourceOps * ops, napi_value * res )

描述

通过给定的图像源缓冲区资源 data 和 OhosImageSourceOps结构体, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过{OH_ImageSource_UpdateData}更新。

起始版本: 11

参数:

名称 描述
env 表明JNI环境的指针。
data 表明图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区。
dataSize 表明图像源缓冲区资源大小。
ops 表明创建一个图像源的选项。查看OhosImageSourceOps
res 表明JavaScript native层ImageSource对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER。

参见:

OhosImageSourceOps

OH_ImageSource_CreatePixelMap()

int32_t OH_ImageSource_CreatePixelMap (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )

描述

通过一个给定的选项OhosImageDecodingOps结构体,从ImageSource中解码JavaScript native层PixelMap对象

起始版本: 10

参数:

名称 描述
native 表明native层ImageSourceNative值的指针。
ops 表明为了解码图像源的选项,查看OhosImageDecodingOps
res 表明JavaScript native层PixelMap对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果创建编码器失败,返回IMAGE_RESULT_CREATE_ENCODER_FAILED;

如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存错误,返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据异常,返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像内存分配异常,返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败,返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪错误,返回IMAGE_RESULT_CROP;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果图像编码失败,返回IMAGE_RESULT_ENCODE_FAILED;

如果不支持图片硬解码,返回IMAGE_RESULT_HW_DECODE_UNSUPPORT;

如果硬解码失败,返回IMAGE_RESULT_HW_DECODE_FAILED;

如果ipc失败,返回IMAGE_RESULT_ERR_IPC;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误,返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误,返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

ImageSourceNative, OhosImageDecodingOps

OH_ImageSource_CreatePixelMapList()

int32_t OH_ImageSource_CreatePixelMapList (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )

描述

通过一个给定的选项OhosImageDecodingOps结构体,从ImageSource中解码所有的JavaScript native层PixelMap对象列表。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
ops 表明为了解码图像源的选项,查看OhosImageDecodingOps
res 表明JavaScript native层PixelMap 列表对象的指针。

返回:

参考IRNdkErrCode

如果操作成功返回IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果创建编码器失败,返回IMAGE_RESULT_CREATE_ENCODER_FAILED;

如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存错误,返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据异常,返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像内存分配异常,返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败,返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪错误,返回IMAGE_RESULT_CROP;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果图像编码失败,返回IMAGE_RESULT_ENCODE_FAILED;

如果不支持图片硬解码,返回IMAGE_RESULT_HW_DECODE_UNSUPPORT;

如果硬解码失败,返回IMAGE_RESULT_HW_DECODE_FAILED;

如果ipc失败,返回IMAGE_RESULT_ERR_IPC;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误,返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误,返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative, OhosImageDecodingOps

OH_ImageSource_GetDelayTime()

int32_t OH_ImageSource_GetDelayTime (const ImageSourceNative * native, struct OhosImageSourceDelayTimeList * res )

描述

从一些ImageSource(如GIF图像源)获取延迟时间列表。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
res 表明延迟时间列表 OhosImageSourceDelayTimeList 的指针。 当输入的res中delayTimeList是空指针并且size是0时,将通过res的size中返回延迟时间列表大小 为了获取延迟时间,需要比返回的delayTimeList大小值大的足够空间

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative, OhosImageSourceDelayTimeList

OH_ImageSource_GetFrameCount()

int32_t OH_ImageSource_GetFrameCount (const ImageSourceNative * native, uint32_t * res )

描述

ImageSource中获取帧计数。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
res 表明帧计数的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative

OH_ImageSource_GetImageInfo()

int32_t OH_ImageSource_GetImageInfo (const ImageSourceNative * native, int32_t index, struct OhosImageSourceInfo * info )

描述

通过索引从ImageSource获取图像源信息。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
index 表明帧计数的指针。
info 表明图像源信息OhosImageSourceInfo的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative, OhosImageSourceInfo

OH_ImageSource_GetImageProperty()

int32_t OH_ImageSource_GetImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )

描述

通过关键字从ImageSource中获取图像源属性。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
key 表明属性关键字OhosImageSourceProperty的指针。
value 表明作为结果的属性值OhosImageSourceProperty的指针。 当输入的value中value是空指针并且size是0时,将通过value中的size返回属性值的大小。 为了获取属性值,需要比value中的结果大小大的足够的空间。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果图片解码异常, 返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative, OhosImageSourceProperty

OH_ImageSource_GetSupportedFormats()

int32_t OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList * res)

描述

获取所有支持的解码格式元标记。

起始版本: 10

参数:

名称 描述
res 表明指向OhosImageSourceSupportedFormatList结构的列表指针。 当supportedFormatList为nullptr并且size以res为0作为输入时,它将以ressize返回支持的格式大小。
为了获得所有的格式标记,它需要比supportedFormatList中的结果大小大的足够空间, 还需要为OhosImageSourceSupportedFormat项目中的每个格式提供足够的空间。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR。

参见:

OhosImageSourceSupportedFormatList, OhosImageSourceSupportedFormat

OH_ImageSource_InitNative()

ImageSourceNative* OH_ImageSource_InitNative (napi_env env, napi_value source )

描述

从输入JavaScript native层ImageSource对象中,转换成ImageSourceNative值。

起始版本: 10

参数:

名称 描述
env 表明JNI环境的指针。
source 表明JavaScript native层ImageSource对象的指针。

返回:

如果操作成功返回ImageSourceNative指针;如果操作失败,返回空指针。

参见:

ImageSourceNative, OH_ImageSource_Release

OH_ImageSource_ModifyImageProperty()

int32_t OH_ImageSource_ModifyImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )

描述

通过关键字为ImageSource修改图像源属性。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针
key 表明属性关键字OhosImageSourceProperty的指针。
value 为了修改表明属性值OhosImageSourceProperty的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果解码的EXIF不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;

如果图片属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST。

参见:

ImageSourceNative, OhosImageSourceProperty

OH_ImageSource_Release()

int32_t OH_ImageSource_Release (ImageSourceNative * native)

描述

释放native层图像源 ImageSourceNative

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。

返回:

参考IRNdkErrCode

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL。

参见:

ImageSourceNative, OH_ImageSource_Create, OH_ImageSource_CreateIncremental

OH_ImageSource_UpdateData()

int32_t OH_ImageSource_UpdateData (const ImageSourceNative * native, struct OhosImageSourceUpdateData * data )

描述

为了增量类型的ImageSource更新源数据。

起始版本: 10

参数:

名称 描述
native 表明native层 ImageSourceNative 值的指针。
data 表明更新数据信息OhosImageSourceUpdateData的指针。

返回:

如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;

如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;

如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效,返回IMAGE_RESULT_INVALID_PARAMETER;

如果获取图片数据异常,返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;

如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败,返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果创建编码器失败,返回IMAGE_RESULT_CREATE_ENCODER_FAILED;

如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia错误,返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果输入图片数据错误,返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存错误,返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据异常,返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像内存分配异常,返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果图像类型不支持,返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败,返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪错误,返回IMAGE_RESULT_CROP;

如果图片格式未知,返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败,返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败,返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果图像编码失败,返回IMAGE_RESULT_ENCODE_FAILED;

如果不支持图片硬解码,返回IMAGE_RESULT_HW_DECODE_UNSUPPORT;

如果硬解码失败,返回IMAGE_RESULT_HW_DECODE_FAILED;

如果ipc失败,返回IMAGE_RESULT_ERR_IPC;

如果索引无效,返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误,返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误,返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

ImageSourceNative, OhosImageSourceUpdateData

OH_PixelMap_AccessPixels()

int32_t OH_PixelMap_AccessPixels (const NativePixelMap * native, void ** addr )

描述

获取native PixelMap 对象数据的内存地址,并锁定该内存。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
addr 用于指向的内存地址的二级指针对象。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

AccessPixels

OH_PixelMap_CreateAlphaPixelMap()

int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value * alpha )

描述

根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的PixelMap对象。

起始版本: 10

参数:

名称 描述
env napi的环境指针。
source PixelMap数据设置项。
alpha alpha通道的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果图像头解码失败则返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败则返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果创建编码器失败则返回IMAGE_RESULT_CREATE_ENCODER_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像解码失败则返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败则返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果图像编码失败则返回IMAGE_RESULT_ENCODE_FAILED;

如果图像不支持硬件解码则返回IMAGE_RESULT_HW_DECODE_UNSUPPORT;

如果硬件解码失败则返回IMAGE_RESULT_HW_DECODE_FAILED;

如果ipc失败则返回IMAGE_RESULT_ERR_IPC;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

CreateAlphaPixelMap

OH_PixelMap_CreatePixelMap()

int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void * buf, size_t len, napi_value * res )

描述

创建PixelMap对象。当前只支持输入流为BGRA格式的流

起始版本: 10

参数:

名称 描述
env napi的环境指针。
info PixelMap数据设置项。
buf 图片的buffer数据。
len 图片大小信息。
res 应用层的 PixelMap 对象的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果图像头解码失败则返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;

如果创建解码器失败则返回IMAGE_RESULT_CREATE_DECODER_FAILED;

如果创建编码器失败则返回IMAGE_RESULT_CREATE_ENCODER_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像解码失败则返回IMAGE_RESULT_DECODE_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败则返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果图像编码失败则返回IMAGE_RESULT_ENCODE_FAILED;

如果图像不支持硬件解码则返回IMAGE_RESULT_HW_DECODE_UNSUPPORT;

如果硬件解码失败则返回IMAGE_RESULT_HW_DECODE_FAILED;

如果ipc失败则返回IMAGE_RESULT_ERR_IPC;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

CreatePixelMap

OH_PixelMap_Crop()

int32_t OH_PixelMap_Crop (const NativePixelMap * native, int32_t x, int32_t y, int32_t width, int32_t height )

描述

设置PixelMap对象的裁剪。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
x 目标图片左上角的x坐标。
y 目标图片左上角的y坐标。
width 裁剪区域的宽度。
height 裁剪区域的高度。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

Crop

OH_PixelMap_Flip()

int32_t OH_PixelMap_Flip (const NativePixelMap * native, int32_t x, int32_t y )

描述

设置PixelMap对象的翻转。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
x 根据水平方向x轴进行图片翻转。
y 根据垂直方向y轴进行图片翻转。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

Flip

OH_PixelMap_GetBytesNumberPerRow()

int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap * native, int32_t * num )

描述

获取PixelMap对象每行字节数。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
num PixelMap对象的每行字节数指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

GetBytesNumberPerRow

OH_PixelMap_GetDensity()

int32_t OH_PixelMap_GetDensity (const NativePixelMap * native, int32_t * density )

描述

获取PixelMap对象像素密度。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
density 像素密度指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

GetDensity

OH_PixelMap_GetImageInfo()

int32_t OH_PixelMap_GetImageInfo (const NativePixelMap * native, OhosPixelMapInfos * info )

描述

获取PixelMap对象图像信息。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
info 图像信息指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

OhosPixelMapInfos

OH_PixelMap_GetIsEditable()

int32_t OH_PixelMap_GetIsEditable (const NativePixelMap * native, int32_t * editable )

描述

获取PixelMap对象是否可编辑的状态。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
editable PixelMap 对象是否可编辑的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

GetIsEditable

OH_PixelMap_InitNativePixelMap()

NativePixelMap* OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source )

描述

初始化PixelMap对象数据。

起始版本: 10

参数:

名称 描述
env napi的环境指针。
source PixelMap 数据设置项。

返回:

操作成功则返回NativePixelMap的指针;如果操作失败,则返回错误码。

参见:

InitNativePixelMap

OH_PixelMap_IsSupportAlpha()

int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap * native, int32_t * alpha )

描述

获取PixelMap对象是否支持Alpha通道。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
alpha 是否支持Alpha的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

IsSupportAlpha

OH_PixelMap_Rotate()

int32_t OH_PixelMap_Rotate (const NativePixelMap * native, float angle )

描述

设置PixelMap对象的旋转。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
angle 旋转角度。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

Rotate

OH_PixelMap_Scale()

int32_t OH_PixelMap_Scale (const NativePixelMap * native, float x, float y )

描述

设置PixelMap对象的缩放。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
x 缩放宽度。
y 缩放高度。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果图像初始化失败则返回IMAGE_RESULT_INIT_ABNORMAL;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

Scale

OH_PixelMap_SetAlphaAble()

int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap * native, int32_t alpha )

描述

设置PixelMap对象的Alpha通道。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
alpha Alpha通道。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

SetAlphaAble

OH_PixelMap_SetDensity()

int32_t OH_PixelMap_SetDensity (const NativePixelMap * native, int32_t density )

描述

设置PixelMap对象像素密度。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
density 像素密度。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

GetDensity

OH_PixelMap_SetOpacity()

int32_t OH_PixelMap_SetOpacity (const NativePixelMap * native, float opacity )

描述

设置PixelMap对象的透明度。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
opacity 透明度。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID。

参见:

SetOpacity

OH_PixelMap_Translate()

int32_t OH_PixelMap_Translate (const NativePixelMap * native, float x, float y )

描述

设置PixelMap对象的偏移。

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。
x 水平偏移量。
y 垂直偏移量。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

Translate

OH_PixelMap_UnAccessPixels()

int32_t OH_PixelMap_UnAccessPixels (const NativePixelMap * native)

描述

释放native PixelMap对象数据的内存锁,用于匹配方法OH_PixelMap_AccessPixels

起始版本: 10

参数:

名称 描述
native NativePixelMap的指针。

返回:

参考IRNdkErrCode

如果操作成功则返回IMAGE_RESULT_SUCCESS;

如果参数错误则返回IMAGE_RESULT_BAD_PARAMETER;

如果JNI环境异常则返回IMAGE_RESULT_JNI_ENV_ABNORMAL;

如果参数无效则返回IMAGE_RESULT_INVALID_PARAMETER;

如果图像获取数据失败则返回IMAGE_RESULT_GET_DATA_ABNORMAL;

如果解码失败则返回IMAGE_RESULT_DECODE_FAILED;

如果检查格式失败则返回IMAGE_RESULT_CHECK_FORMAT_ERROR;

如果skia能力失败则返回IMAGE_RESULT_THIRDPART_SKIA_ERROR;

如果图像输入数据失败则返回IMAGE_RESULT_DATA_ABNORMAL;

如果共享内存失败则返回IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;

如果共享内存数据错误则返回IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;

如果图像分配内存失败则返回IMAGE_RESULT_MALLOC_ABNORMAL;

如果属性无效或图像数据不支持则返回IMAGE_RESULT_DATA_UNSUPPORT;

如果裁剪失败则返回IMAGE_RESULT_CROP;

如果图像格式未知则返回IMAGE_RESULT_UNKNOWN_FORMAT;

如果注册插件失败则返回IMAGE_RESULT_PLUGIN_REGISTER_FAILED;

如果创建插件失败则返回IMAGE_RESULT_PLUGIN_CREATE_FAILED;

如果参数无效则返回IMAGE_RESULT_INDEX_INVALID;

如果透明度类型错误则返回IMAGE_RESULT_ALPHA_TYPE_ERROR;

如果内存分配类型错误则返回IMAGE_RESULT_ALLOCATER_TYPE_ERROR。

参见:

UnAccessPixels

OH_UnAccessPixels()

int32_t OHOS::Media::OH_UnAccessPixels (napi_env env, napi_value value )

描述

释放PixelMap对象数据的内存锁, 用于匹配方法OH_AccessPixels

起始版本: 8

废弃起始版本: 10

参数:

名称 描述
env napi的环境指针。
value 应用层的 PixelMap 对象。

返回:

操作成功则返回 OHOS_IMAGE_RESULT_SUCCESS;如果操作失败,则返回错误码。

参见:

AccessPixels

变量说明

alphaType

int32_t OhosImageSourceInfo::alphaType

描述

图像源透明度类型

起始版本: 10

buffer [1/2]

uint8_t* OhosImageSource::buffer = nullptr

描述

图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区

起始版本: 10

buffer [2/2]

uint8_t* OhosImageSourceUpdateData::buffer = nullptr

描述

图像源更新数据缓冲区

起始版本: 10

bufferSize [1/2]

size_t OhosImageSource::bufferSize = 0

描述

图像源缓冲区资源大小

bufferSize [2/2]

size_t OhosImageSourceUpdateData::bufferSize = 0

描述

图像源更新数据缓冲区大小

起始版本: 10

colorSpace

int32_t OhosImageSourceInfo::colorSpace

描述

图像源色彩空间

起始版本: 10

delayTimeList

int32_t* OhosImageSourceDelayTimeList::delayTimeList

描述

图像源延迟时间列表头地址

起始版本: 10

density [1/2]

int32_t OhosImageSourceOps::density

描述

图像源像素密度

起始版本: 10

density [2/2]

int32_t OhosImageSourceInfo::density

描述

图像源密度, 由 OH_ImageSource_Create 设置

起始版本: 10

editable

int8_t OhosImageDecodingOps::editable

描述

定义输出的像素位图是否可编辑

起始版本: 10

fd

int32_t OhosImageSource::fd = -1

描述

图像源文件资源描述符

起始版本: 10

fitDensity

int32_t OhosImageDecodingOps::fitDensity

描述

定义解码目标的像素密度

起始版本: 10

format

char* OhosImageSourceSupportedFormat::format = nullptr

描述

图像源支持的格式字符串头地址

起始版本: 10

height

int32_t OhosImageRegion::height

描述

高度范围,用pixels表示

起始版本: 10

index

uint32_t OhosImageDecodingOps::index

描述

定义图像源解码指数

起始版本: 10

isCompleted

int8_t OhosImageSourceUpdateData::isCompleted = 0

描述

图像源更新数据在此节中完成

起始版本: 10

offset

uint32_t OhosImageSourceUpdateData::offset = 0

描述

图像源更新数据缓冲区的开端

起始版本: 10

OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE

const char* OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample"

描述

定义每个样本比特的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL

const char* OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel"

描述

定义每个像素的压缩比特的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL

const char* OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal"

描述

定义初始日期时间的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_EXPOSURE_TIME

const char* OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime"

描述

定义曝光时间的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_F_NUMBER

const char* OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber"

描述

定义FNumber的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_GPS_LATITUDE

const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude"

描述

定义GPS纬度的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF

const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef"

描述

定义GPS纬度参考的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_GPS_LONGITUDE

const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude"

描述

定义GPS经度的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF

const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef"

描述

定义GPS经度参考的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

系统能力: SystemCapability.Multimedia.Image

起始版本: 10

OHOS_IMAGE_PROPERTY_IMAGE_LENGTH

const char* OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength"

描述

定义图像长度的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_IMAGE_WIDTH

const char* OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth"

描述

定义图像宽度的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

系统能力: SystemCapability.Multimedia.Image

起始版本: 10

OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS

const char* OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings"

描述

定义ISO速度等级的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_ORIENTATION

const char* OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation"

描述

定义方向的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

OHOS_IMAGE_PROPERTY_SCENE_TYPE

const char* OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType"

描述

定义场景类型的图像属性关键字。 此标签给OH_ImageSource_GetImagePropertyOH_ImageSource_ModifyImageProperty这两个接口使用。

起始版本: 10

pixelFormat [1/3]

int32_t OhosImageSourceOps::pixelFormat

描述

图像源像素格式,通常用于描述YUV缓冲区

起始版本: 10

pixelFormat [2/3]

int32_t OhosImageDecodingOps::pixelFormat

描述

定义输出的像素格式

起始版本: 10

pixelFormat [3/3]

int32_t OhosImageSourceInfo::pixelFormat

描述

图像源像素格式, 由 OH_ImageSource_Create 设置

起始版本: 10

region

struct OhosImageRegion OhosImageDecodingOps::region

描述

定义图像源解码的像素范围

起始版本: 10

rotate

uint32_t OhosImageDecodingOps::rotate

描述

定义解码旋转选项

起始版本: 10

sampleSize

uint32_t OhosImageDecodingOps::sampleSize

描述

定义解码样本大小选项

起始版本: 10

size [1/7]

struct OhosImageSize OhosImageSourceOps::size

描述

图像源像素宽高的大小

起始版本: 10

size [2/7]

struct OhosImageSize OhosImageDecodingOps::size

描述

定义解码目标像素宽高的大小

起始版本: 10

size [3/7]

struct OhosImageSize OhosImageSourceInfo::size

描述

图像源像素宽高的大小

起始版本: 10

size [4/7]

size_t OhosImageSourceDelayTimeList::size = 0

描述

图像源延迟时间列表大小

起始版本: 10

size [5/7]

size_t OhosImageSourceSupportedFormat::size = 0

描述

图像源支持的格式字符串大小

起始版本: 10

size [6/7]

size_t OhosImageSourceSupportedFormatList::size = 0

描述

图像源支持的格式字符串列表大小

起始版本: 10

size [7/7]

size_t OhosImageSourceProperty::size = 0

描述

定义图像源属性键值字符串大小

起始版本: 10

supportedFormatList

struct OhosImageSourceSupportedFormat** OhosImageSourceSupportedFormatList::supportedFormatList = nullptr

描述

图像源支持的格式字符串列表头地址

起始版本: 10

updateLength

uint32_t OhosImageSourceUpdateData::updateLength = 0

描述

图像源更新数据缓冲区的更新数据长度

起始版本: 10

uri

char* OhosImageSource::uri = nullptr

描述

图像源资源标识符,接受文件资源或者base64资源

起始版本: 10

uriSize

size_t OhosImageSource::uriSize = 0

描述

图像源资源长度

起始版本: 10

value

char* OhosImageSourceProperty::value = nullptr

描述

定义图像源属性键值字符串头地址

起始版本: 10

width

int32_t OhosImageRegion::width

描述

宽度范围,用pixels表示

起始版本: 10

x

int32_t OhosImageRegion::x

描述

起始x坐标,用pixels表示

起始版本: 10

y

int32_t OhosImageRegion::y

描述

起始y坐标,用pixels表示

起始版本: 10