• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Image
2
3
4## 概述
5
6提供访问Image接口的方法,包括如何获取图片数据、获取PixelMap的数据和信息。
7
8\@Syscap SystemCapability.Multimedia.Image
9
10**起始版本:**
11
128
13
14
15## 汇总
16
17
18### 文件
19
20| 名称 | 描述 |
21| -------- | -------- |
22| [image_mdk.h](image__mdk_8h.md) | 声明访问图像剪辑矩形、大小、格式和组件数据的函数。<br/>**引用文件**:&lt;multimedia/image_framework/image_mdk.h&gt;<br/>**库**:libimage_ndk.z.so |
23| [image_mdk_common.h](image__mdk__common_8h.md) | 声明图像常用的枚举值和结构体。<br/>**引用文件**:&lt;multimedia/image_framework/image_mdk_common.h&gt;<br/>**库**:libimage_ndk.z.so |
24| [image_pixel_map_mdk.h](image__pixel__map__mdk_8h.md) | 声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。<br/>**引用文件**:&lt;multimedia/image_framework/image_pixel_map_mdk.h&gt;<br/>**库**:libpixelmap_ndk.z.so |
25| [image_pixel_map_napi.h](image__pixel__map__napi_8h.md) | 声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。<br/>**引用文件**:&lt;multimedia/image_framework/image_pixel_map_napi.h&gt;<br/>**库**:libpixelmap_ndk.z.so |
26| [image_receiver_mdk.h](image__receiver__mdk_8h.md) | 声明从native层获取图片数据的方法。<br/>**引用文件**:&lt;multimedia/image_framework/image_receiver_mdk.h&gt;<br/>**库**:libimage_receiver_ndk.z.so |
27| [image_source_mdk.h](image__source__mdk_8h.md) | 声明将图片源解码成像素位图的方法。<br/>**引用文件**:&lt;multimedia/image_framework/image_source_mdk.h&gt;<br/>**库**:libimage_source_ndk.z.so |
28
29
30### 结构体
31
32| 名称 | 描述 |
33| -------- | -------- |
34| [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) | 定义图像矩形信息。 |
35| [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) | 定义图像组成信息。 |
36| [OhosImageSize](_ohos_image_size.md) | 定义图像大小。 |
37| [OhosPixelMapInfos](_ohos_pixel_map_infos.md) | 用于定义 pixel map 的相关信息。 |
38| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 |
39| [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 |
40| [OhosImageReceiverInfo](_ohos_image_receiver_info.md) | 定义**ImageReceiver**的相关信息。 |
41| [OhosImageRegion](_ohos_image_region.md) | 定义图像源解码的范围选项。 |
42| [OhosImageSourceOps](_ohos_image_source_ops.md) | 定义图像源选项信息。 |
43| [OhosImageDecodingOps](_ohos_image_decoding_ops.md) | 定义图像源解码选项。 |
44| [OhosImageSourceInfo](_ohos_image_source_info.md) | 定义图像源信息。 |
45| [OhosImageSource](_ohos_image_source.md) | 定义图像源输入资源,每次仅接收一种类型。 |
46| [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) | 定义图像源延迟时间列表。 |
47| [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) | 定义图像源支持的格式字符串。 |
48| [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) | 定义图像源支持的格式字符串列表。 |
49| [OhosImageSourceProperty](_ohos_image_source_property.md) | 定义图像源属性键值字符串。 |
50| [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) | 定义图像源更新数据选项。 |
51
52
53### 类型定义
54
55| 名称 | 描述 |
56| -------- | -------- |
57| [ImageNative](#imagenative) | 为图像接口定义native层图像对象。 |
58| [NativePixelMap](#nativepixelmap) | 定义native层pixelmap数据类型名称。 |
59| [OhosPixelMapInfos](#ohospixelmapinfos) | 用于定义 pixel map 的相关信息。 |
60| [ImageReceiverNative](#imagereceivernative) | 用于定义ImageReceiverNative数据类型名称。 |
61| (\*[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)) () | 定义native层图片的回调方法。 |
62| [ImageSourceNative](#imagesourcenative) | 为图像源方法定义native层图像源对象。 |
63
64### 宏定义
65
66| 名称 | 描述 |
67| -------- | -------- |
68| **IMAGE_RESULT_BASE** 62980096 | 接口返回值的基础值  |
69
70### 枚举
71
72| 名称 | 描述 |
73| -------- | -------- |
74| { OHOS_IMAGE_FORMAT_YCBCR_422_SP = 1000,<br/>OHOS_IMAGE_FORMAT_JPEG = 2000, } | 图像格式枚举值。 |
75| { OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y = 1,<br/>OHOS_IMAGE_COMPONENT_FORMAT_YUV_U = 2,<br/>OHOS_IMAGE_COMPONENT_FORMAT_YUV_V = 3,<br/>OHOS_IMAGE_COMPONENT_FORMAT_JPEG = 4, } | 图像组成类型枚举值。 |
76| [IRNdkErrCode](#irndkerrcode) {<br/>IMAGE_RESULT_SUCCESS = 0,<br/>IMAGE_RESULT_BAD_PARAMETER = -1,<br/>IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,<br/>IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,<br/>IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,<br/>IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3,<br/>IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,<br/>IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,<br/>IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,<br/>IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,<br/>IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,<br/>IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,<br/>IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,<br/>IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,<br/>IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,<br/>IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,<br/>IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,<br/>IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,<br/>IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,<br/>IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,<br/>IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,<br/>IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,<br/>IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,<br/>IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,<br/>IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,<br/>IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,<br/>IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,<br/>IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,<br/>IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,<br/>IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,<br/>IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,<br/>IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,<br/>IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,<br/>IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,<br/>IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,<br/>IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,<br/>IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,<br/>IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,<br/>IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,<br/>IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,<br/>IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,<br/>IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,<br/>IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,<br/>IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,<br/>IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,<br/>IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,<br/>IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,<br/>IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,<br/>IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,<br/>IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,<br/>IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,<br/>IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,<br/>IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,<br/>IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,<br/>IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53, IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,<br/>IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,<br/>IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,<br/>IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,<br/>IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,<br/>IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,<br/>IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,<br/>IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,<br/>IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,<br/>IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,<br/>IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,<br/>IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,<br/>IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,<br/>IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,<br/>IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,<br/>IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,<br/>IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,<br/>IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,<br/>IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,<br/>IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,<br/>IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,<br/>IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,<br/>IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,<br/>IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,<br/>IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,<br/>IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,<br/>IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,<br/>IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,<br/>IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,<br/>IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,<br/>IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,<br/>IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,<br/>IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,<br/>IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,<br/>IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,<br/>IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,<br/>IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,<br/>IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,<br/>IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,<br/>IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,<br/>IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,<br/>IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,<br/>IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,<br/>IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,<br/>IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,<br/>IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,<br/>IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,<br/>IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,<br/>IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,<br/>IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,<br/>IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200<br/>} | 可能出现的返回值的枚举。 |
77| { OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0,<br/>OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1,<br/>OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2,<br/>OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 } | PixelMap 透明度类型的枚举。 |
78| { OHOS_PIXEL_MAP_READ_ONLY = 0,<br/>OHOS_PIXEL_MAP_EDITABLE = 1 } | PixelMap 编辑类型的枚举。 |
79| { OHOS::Media::OHOS_IMAGE_RESULT_SUCCESS = 0,<br/>OHOS::Media::OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | 函数方法返回值的错误码的枚举。 |
80| { OHOS::Media::OHOS_PIXEL_MAP_FORMAT_NONE = 0,<br/>OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3,<br/>OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | pixel 格式的枚举。 |
81| { OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0,<br/>OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 } | PixelMap 缩放类型的枚举。 |
82
83
84### 函数
85
86| 名称 | 描述 |
87| -------- | -------- |
88| [OH_Image_InitImageNative](#oh_image_initimagenative) (napi_env env, napi_value source) | 从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。 |
89| [OH_Image_ClipRect](#oh_image_cliprect) (const [ImageNative](#imagenative) \*native, struct [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) \*rect) | 获取native **ImageNative** 对象 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 信息。 |
90| [OH_Image_Size](#oh_image_size) (const [ImageNative](#imagenative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。 |
91| [OH_Image_Format](#oh_image_format) (const [ImageNative](#imagenative) \*native, int32_t \*format) | 获取native **ImageNative** 对象的图像格式。 |
92| [OH_Image_GetComponent](#oh_image_getcomponent) (const [ImageNative](#imagenative) \*native, int32_t componentType, struct [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) \*componentNative) | 从 native **ImageNative** 对象中获取 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)。 |
93| [OH_Image_Release](#oh_image_release) ([ImageNative](#imagenative) \*native) | 释放 **ImageNative** native对象。 |
94| [OH_PixelMap_CreatePixelMap](#oh_pixelmap_createpixelmap) (napi_env env, [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) info, void \*buf, size_t len, napi_value \*res) | 创建**PixelMap**对象。 |
95| [OH_PixelMap_CreateAlphaPixelMap](#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 |
96| [OH_PixelMap_InitNativePixelMap](#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 |
97| [OH_PixelMap_GetBytesNumberPerRow](#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 |
98| [OH_PixelMap_GetIsEditable](#oh_pixelmap_getiseditable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*editable) | 获取**PixelMap**对象是否可编辑的状态。 |
99| [OH_PixelMap_IsSupportAlpha](#oh_pixelmap_issupportalpha) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 |
100| [OH_PixelMap_SetAlphaAble](#oh_pixelmap_setalphaable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 |
101| [OH_PixelMap_GetDensity](#oh_pixelmap_getdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 |
102| [OH_PixelMap_SetDensity](#oh_pixelmap_setdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 |
103| [OH_PixelMap_SetOpacity](#oh_pixelmap_setopacity) (const [NativePixelMap](#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 |
104| [OH_PixelMap_Scale](#oh_pixelmap_scale) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 |
105| [OH_PixelMap_Translate](#oh_pixelmap_translate) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 |
106| [OH_PixelMap_Rotate](#oh_pixelmap_rotate) (const [NativePixelMap](#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 |
107| [OH_PixelMap_Flip](#oh_pixelmap_flip) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 |
108| [OH_PixelMap_Crop](#oh_pixelmap_crop) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y, int32_t width, int32_t height) | 设置**PixelMap**对象的裁剪。 |
109| [OH_PixelMap_GetImageInfo](#oh_pixelmap_getimageinfo) (const [NativePixelMap](#nativepixelmap) \*native, [OhosPixelMapInfos](_ohos_pixel_map_infos.md) \*info) | 获取**PixelMap**对象图像信息。 |
110| [OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels) (const [NativePixelMap](#nativepixelmap) \*native, void \*\*addr) | 获取native **PixelMap** 对象数据的内存地址,并锁定该内存。 |
111| [OH_PixelMap_UnAccessPixels](#oh_pixelmap_unaccesspixels) (const [NativePixelMap](#nativepixelmap) \*native) | 释放native **PixelMap**对象数据的内存锁,用于匹配方法 [OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels)。 |
112| [OHOS::Media::OH_GetImageInfo](#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)结构中。 |
113| [OHOS::Media::OH_AccessPixels](#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 |
114| [OHOS::Media::OH_UnAccessPixels](#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。 |
115| [OH_Image_Receiver_CreateImageReceiver](#oh_image_receiver_createimagereceiver) (napi_env env, struct [OhosImageReceiverInfo](_ohos_image_receiver_info.md) info, napi_value \*res) | 创建应用层 **ImageReceiver** 对象。 |
116| [OH_Image_Receiver_InitImageReceiverNative](#oh_image_receiver_initimagereceivernative) (napi_env env, napi_value source) | 通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](#imagereceivernative)对象。 |
117| [OH_Image_Receiver_GetReceivingSurfaceId](#oh_image_receiver_getreceivingsurfaceid) (const [ImageReceiverNative](#imagereceivernative) \*native, char \*id, size_t len) | 通过[ImageReceiverNative](#imagereceivernative)获取receiver的id。 |
118| [OH_Image_Receiver_ReadLatestImage](#oh_image_receiver_readlatestimage) (const [ImageReceiverNative](#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](#imagereceivernative)获取最新的一张图片。 |
119| [OH_Image_Receiver_ReadNextImage](#oh_image_receiver_readnextimage) (const [ImageReceiverNative](#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](#imagereceivernative)获取下一张图片。 |
120| [OH_Image_Receiver_On](#oh_image_receiver_on) (const [ImageReceiverNative](#imagereceivernative) \*native, [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback) callback) | 注册一个[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。 |
121| [OH_Image_Receiver_GetSize](#oh_image_receiver_getsize) (const [ImageReceiverNative](#imagereceivernative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的大小。 |
122| [OH_Image_Receiver_GetCapacity](#oh_image_receiver_getcapacity) (const [ImageReceiverNative](#imagereceivernative) \*native, int32_t \*capacity) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的容量。 |
123| [OH_Image_Receiver_GetFormat](#oh_image_receiver_getformat) (const [ImageReceiverNative](#imagereceivernative) \*native, int32_t \*format) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的格式。 |
124| [OH_Image_Receiver_Release](#oh_image_receiver_release) ([ImageReceiverNative](#imagereceivernative) \*native) | 释放native层 [ImageReceiverNative](#imagereceivernative) 对象。注意: 此方法不能释放应用层**ImageReceiver**对象。 |
125| [OH_ImageSource_Create](#oh_imagesource_create) (napi_env env, struct [OhosImageSource](_ohos_image_source.md) \*src, struct [OhosImageSourceOps](_ohos_image_source_ops.md) \*ops, napi_value \*res) | 通过给定的信息[OhosImageSource](_ohos_image_source.md) 和[OhosImageSourceOps](_ohos_image_source_ops.md)结构体,获取JavaScript native层API**ImageSource**对象。 |
126| [OH_ImageSource_CreateIncremental](#oh_imagesource_createincremental) (napi_env env, struct [OhosImageSource](_ohos_image_source.md) \*source, struct [OhosImageSourceOps](_ohos_image_source_ops.md) \*ops, napi_value \*res) | 通过给定的informations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。 |
127| [OH_ImageSource_GetSupportedFormats](#oh_imagesource_getsupportedformats) (struct [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) \*res) | 获取所有支持的解码格式元标记。 |
128| [OH_ImageSource_InitNative](#oh_imagesource_initnative) (napi_env env, napi_value source) | 从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](#imagesourcenative)值。 |
129| [OH_ImageSource_CreatePixelMap](#oh_imagesource_createpixelmap) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象 |
130| [OH_ImageSource_CreatePixelMapList](#oh_imagesource_createpixelmaplist) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表 |
131| [OH_ImageSource_GetDelayTime](#oh_imagesource_getdelaytime) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) \*res) | 从一些**ImageSource**(如GIF图像源)获取延迟时间列表。 |
132| [OH_ImageSource_GetFrameCount](#oh_imagesource_getframecount) (const [ImageSourceNative](#imagesourcenative) \*native, uint32_t \*res) | 从**ImageSource**中获取帧计数。 |
133| [OH_ImageSource_GetImageInfo](#oh_imagesource_getimageinfo) (const [ImageSourceNative](#imagesourcenative) \*native, int32_t index, struct [OhosImageSourceInfo](_ohos_image_source_info.md) \*info) | 通过索引从**ImageSource**获取图像源信息。 |
134| [OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字从**ImageSource**中获取图像源属性。 |
135| [OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字为**ImageSource**修改图像源属性。 |
136| [OH_ImageSource_UpdateData](#oh_imagesource_updatedata) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) \*data) | 为了增量类型的**ImageSource**更新源数据。 |
137| [OH_ImageSource_Release](#oh_imagesource_release) ([ImageSourceNative](#imagesourcenative) \*native) | 释放native层图像源 **ImageSourceNative**。 |
138
139
140### 变量
141
142| 名称 | 描述 |
143| -------- | -------- |
144| [OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE](#ohos_image_property_bits_per_sample) = "BitsPerSample" | 定义每个样本比特的图像属性关键字。 |
145| [OHOS_IMAGE_PROPERTY_ORIENTATION](#ohos_image_property_orientation) = "Orientation" | 定义方向的图像属性关键字。 |
146| [OHOS_IMAGE_PROPERTY_IMAGE_LENGTH](#ohos_image_property_image_length) = "ImageLength" | 定义图像长度的图像属性关键字。 |
147| [OHOS_IMAGE_PROPERTY_IMAGE_WIDTH](#ohos_image_property_image_width) = "ImageWidth" | 定义图像宽度的图像属性关键字。 |
148| [OHOS_IMAGE_PROPERTY_GPS_LATITUDE](#ohos_image_property_gps_latitude) = "GPSLatitude" | 定义GPS纬度的图像属性关键字。 |
149| [OHOS_IMAGE_PROPERTY_GPS_LONGITUDE](#ohos_image_property_gps_longitude) = "GPSLongitude" | 定义GPS经度的图像属性关键字。 |
150| [OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF](#ohos_image_property_gps_latitude_ref) = "GPSLatitudeRef" | 定义GPS纬度参考的图像属性关键字。 |
151| [OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF](#ohos_image_property_gps_longitude_ref) = "GPSLongitudeRef" | 定义GPS经度参考的图像属性关键字。 |
152| [OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL](#ohos_image_property_date_time_original) = "DateTimeOriginal" | 定义初始日期时间的图像属性关键字。 |
153| [OHOS_IMAGE_PROPERTY_EXPOSURE_TIME](#ohos_image_property_exposure_time) = "ExposureTime" | 定义曝光时间的图像属性关键字。 |
154| [OHOS_IMAGE_PROPERTY_SCENE_TYPE](#ohos_image_property_scene_type) = "SceneType" | 定义场景类型的图像属性关键字。 |
155| [OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS](#ohos_image_property_iso_speed_ratings) = "ISOSpeedRatings" | 定义ISO速度等级的图像属性关键字。 |
156| [OHOS_IMAGE_PROPERTY_F_NUMBER](#ohos_image_property_f_number) = "FNumber" | 定义FNumber的图像属性关键字。 |
157| [OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL](#ohos_image_property_compressed_bits_per_pixel) = "CompressedBitsPerPixel" | 定义每个像素的压缩比特的图像属性关键字。 |
158| [OhosImageRegion::x](#x) | 起始x坐标,用pixels表示 |
159| [OhosImageRegion::y](#y) | 起始y坐标,用pixels表示 |
160| [OhosImageRegion::width](#width) | 宽度范围,用pixels表示 |
161| [OhosImageRegion::height](#height) | 高度范围,用pixels表示 |
162| [OhosImageSourceOps::density](#density-12) | 图像源像素密度 |
163| [OhosImageSourceOps::pixelFormat](#pixelformat-13) | 图像源像素格式,通常用于描述YUV缓冲区 |
164| [OhosImageSourceOps::size](#size-17) | 图像源像素宽高的大小 |
165| [OhosImageDecodingOps::editable](#editable) | 定义输出的像素位图是否可编辑 |
166| [OhosImageDecodingOps::pixelFormat](#pixelformat-23) | 定义输出的像素格式 |
167| [OhosImageDecodingOps::fitDensity](#fitdensity) | 定义解码目标的像素密度 |
168| [OhosImageDecodingOps::index](#index) | 定义图像源解码指数 |
169| [OhosImageDecodingOps::sampleSize](#samplesize) | 定义解码样本大小选项 |
170| [OhosImageDecodingOps::rotate](#rotate) | 定义解码旋转选项 |
171| [OhosImageDecodingOps::size](#size-27) | 定义解码目标像素宽高的大小 |
172| [OhosImageDecodingOps::region](#region) | 定义图像源解码的像素范围 |
173| [OhosImageSourceInfo::pixelFormat](#pixelformat-33) | 图像源像素格式, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 |
174| [OhosImageSourceInfo::colorSpace](#colorspace) | 图像源色彩空间 |
175| [OhosImageSourceInfo::alphaType](#alphatype) | 图像源透明度类型 |
176| [OhosImageSourceInfo::density](#density-22) | 图像源密度, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 |
177| [OhosImageSourceInfo::size](#size-37) | 图像源像素宽高的大小 |
178| [OhosImageSource::uri](#uri) = nullptr | 图像源资源标识符,接受文件资源或者base64资源 |
179| [OhosImageSource::uriSize](#urisize) = 0 | 图像源资源长度 |
180| [OhosImageSource::fd](#fd) = -1 | 图像源文件资源描述符 |
181| [OhosImageSource::buffer](#buffer-12) = nullptr | 图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区 |
182| [OhosImageSource::bufferSize](#buffersize-12) = 0 | 图像源缓冲区资源大小 |
183| [OhosImageSourceDelayTimeList::delayTimeList](#delaytimelist) | 图像源延迟时间列表头地址 |
184| [OhosImageSourceDelayTimeList::size](#size-47) = 0 | 图像源延迟时间列表大小 |
185| [OhosImageSourceSupportedFormat::format](#format) = nullptr | 图像源支持的格式字符串头地址 |
186| [OhosImageSourceSupportedFormat::size](#size-57) = 0 | 图像源支持的格式字符串大小 |
187| [OhosImageSourceSupportedFormatList::supportedFormatList](#supportedformatlist) = nullptr | 图像源支持的格式字符串列表头地址 |
188| [OhosImageSourceSupportedFormatList::size](#size-67) = 0 | 图像源支持的格式字符串列表大小 |
189| [OhosImageSourceProperty::value](#value) = nullptr | 定义图像源属性键值字符串头地址 |
190| [OhosImageSourceProperty::size](#size-77) = 0 | 定义图像源属性键值字符串大小 |
191| [OhosImageSourceUpdateData::buffer](#buffer-22) = nullptr | 图像源更新数据缓冲区 |
192| [OhosImageSourceUpdateData::bufferSize](#buffersize-22) = 0 | 图像源更新数据缓冲区大小 |
193| [OhosImageSourceUpdateData::offset](#offset) = 0 | 图像源更新数据缓冲区的开端 |
194| [OhosImageSourceUpdateData::updateLength](#updatelength) = 0 | 图像源更新数据缓冲区的更新数据长度 |
195| [OhosImageSourceUpdateData::isCompleted](#iscompleted) = 0 | 图像源更新数据在此节中完成 |
196
197
198## 类型定义说明
199
200
201### ImageNative
202
203
204```
205typedef struct ImageNative_ ImageNative
206```
207
208**描述:**
209
210为图像接口定义native层图像对象。
211
212**起始版本:**
213
21410
215
216
217### ImageReceiverNative
218
219```
220typedef struct ImageReceiverNative_ ImageReceiverNative
221```
222
223**描述:**
224
225用于定义ImageReceiverNative数据类型名称。
226
227**起始版本:**
228
22910
230
231
232### ImageSourceNative
233
234```
235typedef struct ImageSourceNative_ ImageSourceNative
236```
237
238**描述:**
239
240为图像源方法定义native层图像源对象。
241
242\@Syscap SystemCapability.Multimedia.Image
243
244**起始版本:**
245
24610
247
248
249### NativePixelMap
250
251```
252typedef struct NativePixelMap_ NativePixelMap
253```
254
255**描述:**
256
257定义native层pixelmap数据类型名称。
258
259**起始版本:**
260
26110
262
263
264### OH_Image_Receiver_On_Callback
265
266```
267typedef void(* OH_Image_Receiver_On_Callback) ()
268```
269
270**描述:**
271
272定义native层图片的回调方法。
273
274**起始版本:**
275
27610
277
278
279### OhosPixelMapInfos
280
281```
282typedef struct OhosPixelMapInfos
283```
284
285**描述:**
286
287用于定义 pixel map 的相关信息。
288
289**起始版本:**
290
29110
292
293
294## 枚举类型说明
295
296
297### anonymous enum [1/3]
298
299```
300anonymous enum
301```
302
303**描述:**
304
305图像格式枚举值。
306
307**起始版本:**
308
30910
310
311| 枚举值 | 描述 |
312| -------- | -------- |
313| OHOS_IMAGE_FORMAT_YCBCR_422_SP | YCBCR422 semi-planar 格式 |
314| OHOS_IMAGE_FORMAT_JPEG | JPEG 编码格式 |
315
316
317### anonymous enum [2/3]
318
319```
320anonymous enum
321```
322
323**描述:**
324
325PixelMap 透明度类型的枚举。
326
327**起始版本:**
328
32910
330
331| 枚举值 | 描述 |
332| -------- | -------- |
333| OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN | 未知的格式 |
334| OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE | 不透明的格式 |
335| OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL | 预乘的格式 |
336| OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL | 预除的格式 |
337
338
339### anonymous enum [3/3]
340
341```
342anonymous enum
343```
344
345**描述:**
346
347函数方法返回值的错误码的枚举。
348
349**起始版本:**
350
3518
352
353**废弃起始版本:**
354
35510
356
357| 枚举值 | 描述 |
358| -------- | -------- |
359| OHOS_IMAGE_RESULT_SUCCESS | 成功的结果 |
360| OHOS_IMAGE_RESULT_BAD_PARAMETER | 无效值 |
361
362
363### anonymous enum [1/3]
364
365```
366anonymous enum
367```
368
369**描述:**
370
371图像组成类型枚举值。
372
373**起始版本:**
374
37510
376
377| 枚举值 | 描述 |
378| -------- | -------- |
379| OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y | 亮度信息 |
380| OHOS_IMAGE_COMPONENT_FORMAT_YUV_U | 色度信息 |
381| OHOS_IMAGE_COMPONENT_FORMAT_YUV_V | 色差值信息 |
382| OHOS_IMAGE_COMPONENT_FORMAT_JPEG | Jpeg 格式 |
383
384
385### anonymous enum [2/3]
386
387```
388anonymous enum
389```
390
391**描述:**
392
393PixelMap 编辑类型的枚举。
394
395**起始版本:**
396
39710
398
399| 枚举值 | 描述 |
400| -------- | -------- |
401| OHOS_PIXEL_MAP_READ_ONLY | 只读的格式 |
402| OHOS_PIXEL_MAP_EDITABLE | 可编辑的格式 |
403
404
405### anonymous enum [3/3]
406
407```
408anonymous enum
409```
410
411**描述:**
412
413pixel 格式的枚举。
414
415**起始版本:**
416
4178
418
419**废弃起始版本:**
420
42110
422
423| 枚举值 | 描述 |
424| -------- | -------- |
425| OHOS_PIXEL_MAP_FORMAT_NONE | 未知的格式 |
426| OHOS_PIXEL_MAP_FORMAT_RGBA_8888 | 32-bit RGBA. 由 R, G, B组成,包括 A 都需要占用 8 bits。存储顺序是从高位到低位。 |
427| OHOS_PIXEL_MAP_FORMAT_RGB_565 | 16-bit RGB. 仅由 R, G, B 组成。 存储顺序是从高位到低位: 红色占用5 bits,绿色占用6 bits,蓝色占用5 bits。 |
428
429
430### anonymous enum
431
432```
433anonymous enum
434```
435
436**描述:**
437
438PixelMap 缩放类型的枚举。
439
440**起始版本:**
441
44210
443
444| 枚举值 | 描述 |
445| -------- | -------- |
446| OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE | 适应目标图片大小的格式 |
447| OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP | 以中心进行缩放的格式 |
448
449
450### IRNdkErrCode
451
452```
453enum IRNdkErrCode
454```
455
456**描述:**
457
458可能被使用的接口返回值的枚举。
459
460**起始版本:**
461
46210
463
464| 枚举值 | 描述 |
465| -------- | -------- |
466| IMAGE_RESULT_SUCCESS | 操作成功 |
467| IMAGE_RESULT_BAD_PARAMETER | 无效参数 |
468| IMAGE_RESULT_IMAGE_RESULT_BASE | 操作失败 |
469| IMAGE_RESULT_ERR_IPC | ipc 错误 |
470| IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST | 共享内存失败 |
471| IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL | 共享内存数据异常 |
472| IMAGE_RESULT_DECODE_ABNORMAL | 图像解码失败 |
473| IMAGE_RESULT_DATA_ABNORMAL | 图像输入数据异常 |
474| IMAGE_RESULT_MALLOC_ABNORMAL | 图像内存分配异常 |
475| IMAGE_RESULT_DATA_UNSUPPORT | 图像类型不支持 |
476| IMAGE_RESULT_INIT_ABNORMAL | 图像初始化失败 |
477| IMAGE_RESULT_GET_DATA_ABNORMAL | 图像获取数据错误 |
478| IMAGE_RESULT_TOO_LARGE | 图像数据过大 |
479| IMAGE_RESULT_TRANSFORM | 图像转换错误 |
480| IMAGE_RESULT_COLOR_CONVERT | 图像颜色转换错误 |
481| IMAGE_RESULT_CROP | 裁剪错误 |
482| IMAGE_RESULT_SOURCE_DATA | 图像源数据错误 |
483| IMAGE_RESULT_SOURCE_DATA_INCOMPLETE | 图像源数据不完整 |
484| IMAGE_RESULT_MISMATCHED_FORMAT | 图像格式不匹配 |
485| IMAGE_RESULT_UNKNOWN_FORMAT | 图像未知格式 |
486| IMAGE_RESULT_SOURCE_UNRESOLVED | 图像源未解析 |
487| IMAGE_RESULT_INVALID_PARAMETER | 图像无效参数 |
488| IMAGE_RESULT_DECODE_FAILED | 解码失败 |
489| IMAGE_RESULT_PLUGIN_REGISTER_FAILED | 注册插件失败 |
490| IMAGE_RESULT_PLUGIN_CREATE_FAILED | 创建插件失败 |
491| IMAGE_RESULT_ENCODE_FAILED | 图像编码失败 |
492| IMAGE_RESULT_ADD_PIXEL_MAP_FAILED | 图像添加像素位图失败 |
493| IMAGE_RESULT_HW_DECODE_UNSUPPORT | 图像硬解码不支持 |
494| IMAGE_RESULT_DECODE_HEAD_ABNORMAL | 图像头解码失败 |
495| IMAGE_RESULT_DECODE_EXIF_UNSUPPORT | 图像解码EXIF不支持 |
496| IMAGE_RESULT_PROPERTY_NOT_EXIST | 图像属性不存在 |
497| IMAGE_RESULT_MEDIA_DATA_UNSUPPORT | 媒体类型不支持 |
498| IMAGE_RESULT_MEDIA_TOO_LARGE | 媒体数据过大 |
499| IMAGE_RESULT_MEDIA_MALLOC_FAILED | 媒体分配内存失败 |
500| IMAGE_RESULT_MEDIA_END_OF_STREAM | 媒体数据流结束失败 |
501| IMAGE_RESULT_MEDIA_IO_ABNORMAL | 媒体输入输出流异常 |
502| IMAGE_RESULT_MEDIA_MALFORMED | 媒体功能异常 |
503| IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL | 媒体数据过小错误 |
504| IMAGE_RESULT_MEDIA_OUT_OF_RANGE | 媒体超出范围错误 |
505| IMAGE_RESULT_MEDIA_STATUS_ABNORMAL | 媒体状态异常错误 |
506| IMAGE_RESULT_MEDIA_VALUE_INVALID | 媒体值无效 |
507| IMAGE_RESULT_MEDIA_NULL_POINTER | 媒体操作失败 |
508| IMAGE_RESULT_MEDIA_INVALID_OPERATION | 媒体操作无效 |
509| IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT | 媒体初始化异常 |
510| IMAGE_RESULT_MEDIA_EARLY_PREPARE | 媒体过早预处理 |
511| IMAGE_RESULT_MEDIA_SEEK_ERR | 媒体查找失败 |
512| IMAGE_RESULT_MEDIA_PERMISSION_DENIED | 媒体权限拒绝 |
513| IMAGE_RESULT_MEDIA_DEAD_OBJECT | 媒体对象注销 |
514| IMAGE_RESULT_MEDIA_TIMED_OUT | 媒体超时 |
515| IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED | 媒体能力不支持 |
516| IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED | 媒体适配器初始化失败 |
517| IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL | 写入parcel失败 |
518| IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL | 读取parcel失败 |
519| IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER | 无效数据 |
520| IMAGE_RESULT_MEDIA_INVALID_PARAM | 媒体接口发现无效参数 |
521| IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST | 媒体代码适配器不存在 |
522| IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED | 媒体创建代码适配器失败 |
523| IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT | 媒体代码适配器未初始化 |
524| IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED | 媒体代码创建失败 |
525| IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST | 媒体代码不存在 |
526| IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST | 媒体JNI层类不存在 |
527| IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST | 媒体JNI层方法不存在 |
528| IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED | 媒体JNI层创建对象失败 |
529| IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR | 媒体JNI层异常 |
530| IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT | 媒体不支持分布 |
531| IMAGE_RESULT_MEDIA_SOURCE_NOT_SET | 媒体源未设置 |
532| IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT | 媒体rtsp适配器未初始化 |
533| IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST | 媒体rtsp适配器不存在 |
534| IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT | 媒体不支持rtsp surface |
535| IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT | 媒体rtsp capture初始化失败 |
536| IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID | 媒体rtsp源路径无效 |
537| IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND | 媒体rtsp未发现视频能力 |
538| IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX | rtsp相机数量达到最大数量 |
539| IMAGE_RESULT_MEDIA_SET_VOLUME | 媒体设置卷失败 |
540| IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW | 媒体操作次数溢出 |
541| IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED | 媒体分布式播放器不支持 |
542| IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED | 图像解码ICC失败 |
543| IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED | 图像编码ICC失败 |
544| IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED | 读取像素位图失败 |
545| IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED | 写入像素位图失败 |
546| IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY | 像素位图不允许修改 |
547| IMAGE_RESULT_MEDIA_CONFIG_FAILED | 配置失败 |
548| IMAGE_RESULT_JNI_ENV_ABNORMAL | JNI环境异常 |
549| IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED | surface申请内存失败 |
550| IMAGE_RESULT_CREATE_SURFACE_FAILED | 创建surface失败 |
551| IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED | 从surface获取参数失败 |
552| IMAGE_RESULT_GET_SURFACE_FAILED | 获取surface失败 |
553| IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED | 申请内存失败 |
554| IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED | 申请内存失败 |
555| IMAGE_RESULT_REGISTER_LISTENER_FAILED | 注册监听失败 |
556| IMAGE_RESULT_REGISTER_BUFFER_FAILED | 注册内存失败 |
557| IMAGE_RESULT_FREAD_FAILED | 读取文件失败 |
558| IMAGE_RESULT_PEEK_FAILED | 检测文件失败 |
559| IMAGE_RESULT_SEEK_FAILED | 查找文件失败 |
560| IMAGE_RESULT_STREAM_SIZE_ERROR | 数据流损坏 |
561| IMAGE_RESULT_FILE_FD_ERROR | 文件描述符损坏 |
562| IMAGE_RESULT_FILE_DAMAGED | 文件损坏 |
563| IMAGE_RESULT_CREATE_DECODER_FAILED | 创建解码失败 |
564| IMAGE_RESULT_CREATE_ENCODER_FAILED | 创建编码失败 |
565| IMAGE_RESULT_CHECK_FORMAT_ERROR | 检查格式失败 |
566| IMAGE_RESULT_THIRDPART_SKIA_ERROR | skia解码失败 |
567| IMAGE_RESULT_HW_DECODE_FAILED | 硬解码失败 |
568| IMAGE_RESULT_ALLOCATER_TYPE_ERROR | 内存类型校验失败 |
569| IMAGE_RESULT_ALPHA_TYPE_ERROR | 透明度类型失败 |
570| IMAGE_RESULT_INDEX_INVALID | 参数无效 |
571| IMAGE_RESULT_MEDIA_UNKNOWN | 媒体未知错误 |
572
573
574## 函数说明
575
576
577### OH_AccessPixels()
578
579```
580int32_t OHOS::Media::OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr )
581```
582
583**描述:**
584
585获取**PixelMap**对象数据的内存地址,并锁定该内存。
586
587函数执行成功后,**\*addrPtr**就是获取的待访问的内存地址。访问操作完成后,必须要使用**OH_UnAccessPixels**来释放锁,否则的话资源无法被释放。 待解锁后,内存地址就不可以再被访问和操作。
588
589**参数:**
590
591| 名称 | 描述 |
592| -------- | -------- |
593| env | napi的环境指针。 |
594| value | 应用层的 **PixelMap** 对象。 |
595| addrPtr | 用于指向的内存地址的二级指针对象。 |
596
597**返回:**
598
599操作成功则返回 **OHOS_IMAGE_RESULT_SUCCESS**;如果操作失败,则返回错误码。
600
601**起始版本:**
602
6038
604
605**废弃起始版本:**
606
60710
608
609**参见:**
610
611[UnAccessPixels](image.md#oh_unaccesspixels)
612
613
614### OH_GetImageInfo()
615
616```
617int32_t OHOS::Media::OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo * info )
618```
619
620**描述:**
621
622获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)结构中。
623
624**参数:**
625
626| 名称 | 描述 |
627| -------- | -------- |
628| env | napi的环境指针。 |
629| value | 应用层的 **PixelMap** 对象。 |
630| info | 用于保存信息的指针对象。 更多细节, 参看 [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)。 |
631
632**返回:**
633
634如果获取并保存信息成功,则返回**0**; 如果操作失败,则返回错误码。
635
636**起始版本:**
637
6388
639
640**废弃起始版本:**
641
64210
643
644**参见:**
645
646[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)
647
648
649### OH_Image_ClipRect()
650
651```
652int32_t OH_Image_ClipRect (const ImageNative * native, struct OhosImageRect * rect )
653```
654
655**描述:**
656
657获取native **ImageNative** 对象 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 信息。
658
659**参数:**
660
661| 名称 | 描述 |
662| -------- | -------- |
663| native | 表示指向 **ImageNative** native层对象的指针。 |
664| rect | 表示作为转换结果的 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 对象指针。 |
665
666**返回:**
667
668参考[IRNdkErrCode](#irndkerrcode)。
669
670如果操作成功返回 IMAGE_RESULT_SUCCESS ;
671
672如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
673
674如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
675
676如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;
677
678如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
679
680**起始版本:**
681
68210
683
684**参见:**
685
686[ImageNative](image.md#imagenative), [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md)
687
688
689### OH_Image_Format()
690
691```
692int32_t OH_Image_Format (const ImageNative * native, int32_t * format )
693```
694
695**描述:**
696
697获取native **ImageNative** 对象的图像格式。
698
699**参数:**
700
701| 名称 | 描述 |
702| -------- | -------- |
703| native | 表示 **ImageNative** native对象的指针。 |
704| format | 表示作为转换结果的图像格式对象的指针。 |
705
706**返回:**
707
708参考[IRNdkErrCode](#irndkerrcode)。
709
710如果操作成功返回 IMAGE_RESULT_SUCCESS ;
711
712如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
713
714如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
715
716如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;
717
718如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
719
720**起始版本:**
721
72210
723
724**参见:**
725
726[ImageNative](image.md#imagenative)
727
728
729### OH_Image_GetComponent()
730
731```
732int32_t OH_Image_GetComponent (const ImageNative * native, int32_t componentType, struct OhosImageComponent * componentNative )
733```
734
735**描述:**
736
737从 native **ImageNative** 对象中获取 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)。
738
739**参数:**
740
741| 名称 | 描述 |
742| -------- | -------- |
743| native | 表示 **ImageNative** native对象的指针。 |
744| componentType | 表示所需组件的组件类型。 |
745| componentNative | 表示转换结果的 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) 对象的指针。 |
746
747**返回:**
748
749参考[IRNdkErrCode](#irndkerrcode)。
750
751如果操作成功返回 IMAGE_RESULT_SUCCESS ;
752
753如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
754
755如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
756
757如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;
758
759如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
760
761**起始版本:**
762
76310
764
765**参见:**
766
767[ImageNative](image.md#imagenative), [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)
768
769
770### OH_Image_InitImageNative()
771
772```
773ImageNative* OH_Image_InitImageNative (napi_env env, napi_value source )
774```
775
776**描述:**
777
778从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。
779
780**参数:**
781
782| 名称 | 描述 |
783| -------- | -------- |
784| env | 表示指向 JNI 环境的指针。 |
785| source | 表示 JavaScript Native API **图像** 对象。 |
786
787**返回:**
788
789如果操作成果返回 **ImageNative** 指针对象,如果操作失败返回空指针。
790
791**起始版本:**
792
79310
794
795**参见:**
796
797[ImageNative](image.md#imagenative), [OH_Image_Release](image.md#oh_image_release)
798
799
800### OH_Image_Receiver_CreateImageReceiver()
801
802```
803int32_t OH_Image_Receiver_CreateImageReceiver (napi_env env, struct OhosImageReceiverInfo info, napi_value * res )
804```
805
806**描述:**
807
808创建应用层 **ImageReceiver** 对象。
809
810**参数:**
811
812| 名称 | 描述 |
813| -------- | -------- |
814| env | napi的环境指针。 |
815| info | **ImageReceiver** 数据设置项。 |
816| res | 应用层的 **ImageReceiver** 对象的指针。 |
817
818**返回:**
819
820参考[IRNdkErrCode](#irndkerrcode)。
821
822如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
823
824如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
825
826如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
827
828如果参数无效或从surface获取参数失败则返回 IMAGE_RESULT_INVALID_PARAMETER ;
829
830如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
831
832如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
833
834如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
835
836如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
837
838如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
839
840如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
841
842**起始版本:**
843
84410
845
846**参见:**
847
848[OhosImageReceiverInfo](_ohos_image_receiver_info.md)
849
850
851### OH_Image_Receiver_GetCapacity()
852
853```
854int32_t OH_Image_Receiver_GetCapacity (const ImageReceiverNative * native, int32_t * capacity )
855```
856
857**描述:**
858
859通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的容量。
860
861**参数:**
862
863| 名称 | 描述 |
864| -------- | -------- |
865| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
866| capacity | 作为结果的指向容量的指针。 |
867
868**返回:**
869
870参考[IRNdkErrCode](#irndkerrcode)。
871
872如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
873
874如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
875
876如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
877
878如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
879
880如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
881
882**起始版本:**
883
88410
885
886**参见:**
887
888[ImageReceiverNative](#imagereceivernative), [OhosImageSize](_ohos_image_size.md)
889
890
891### OH_Image_Receiver_GetFormat()
892
893```
894int32_t OH_Image_Receiver_GetFormat (const ImageReceiverNative * native, int32_t * format )
895```
896
897**描述:**
898
899通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的格式。
900
901**参数:**
902
903| 名称 | 描述 |
904| -------- | -------- |
905| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
906| format | 作为结果的指向格式的指针。 |
907
908**返回:**
909
910参考[IRNdkErrCode](#irndkerrcode)。
911
912如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
913
914如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
915
916如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
917
918如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
919
920如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
921
922**起始版本:**
923
92410
925
926**参见:**
927
928[ImageReceiverNative](#imagereceivernative)
929
930
931### OH_Image_Receiver_GetReceivingSurfaceId()
932
933```
934int32_t OH_Image_Receiver_GetReceivingSurfaceId (const ImageReceiverNative * native, char * id, size_t len )
935```
936
937**描述:**
938
939通过[ImageReceiverNative](#imagereceivernative)获取receiver的id。
940
941**参数:**
942
943| 名称 | 描述 |
944| -------- | -------- |
945| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
946| id | 指向字符缓冲区的指针,用于获取字符串的id。 |
947| len | **id**所对应的字符缓冲区的大小。 |
948
949**返回:**
950
951参考[IRNdkErrCode](#irndkerrcode)。
952
953如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
954
955如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
956
957如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
958
959如果参数无效或从surface获取参数失败则返回 IMAGE_RESULT_INVALID_PARAMETER ;
960
961如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
962
963如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
964
965如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
966
967**起始版本:**
968
96910
970
971**参见:**
972
973[ImageReceiverNative](#imagereceivernative)
974
975
976### OH_Image_Receiver_GetSize()
977
978```
979int32_t OH_Image_Receiver_GetSize (const ImageReceiverNative * native, struct OhosImageSize * size )
980```
981
982**描述:**
983
984通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的大小。
985
986**参数:**
987
988| 名称 | 描述 |
989| -------- | -------- |
990| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
991| size | 作为结果的[OhosImageSize](_ohos_image_size.md)指针。 |
992
993**返回:**
994
995参考[IRNdkErrCode](#irndkerrcode)。
996
997如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
998
999如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1000
1001如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1002
1003如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1004
1005如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
1006
1007**起始版本:**
1008
100910
1010
1011**参见:**
1012
1013[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)
1014
1015
1016### OH_Image_Receiver_InitImageReceiverNative()
1017
1018```
1019ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source )
1020```
1021
1022**描述:**
1023
1024通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](#imagereceivernative)对象。
1025
1026**参数:**
1027
1028| 名称 | 描述 |
1029| -------- | -------- |
1030| env | napi的环境指针。 |
1031| source | napi的 **ImageReceiver** 对象。 |
1032
1033**返回:**
1034
1035操作成功则返回 [ImageReceiverNative](#imagereceivernative) 指针;如果操作失败,则返回nullptr。
1036
1037**起始版本:**
1038
103910
1040
1041**参见:**
1042
1043[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_Release](#oh_image_receiver_release)
1044
1045
1046### OH_Image_Receiver_On()
1047
1048```
1049int32_t OH_Image_Receiver_On (const ImageReceiverNative * native, OH_Image_Receiver_On_Callback callback )
1050```
1051
1052**描述:**
1053
1054注册一个[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。
1055
1056**参数:**
1057
1058| 名称 | 描述 |
1059| -------- | -------- |
1060| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1061| callback | [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)事件的回调函数。 |
1062
1063**返回:**
1064
1065参考[IRNdkErrCode](#irndkerrcode)。
1066
1067如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1068
1069如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1070
1071如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1072
1073如果参数无效或从surface获取参数失败则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1074
1075如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1076
1077如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1078
1079如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1080
1081**起始版本:**
1082
108310
1084
1085**参见:**
1086
1087[ImageReceiverNative](#imagereceivernative)
1088
1089
1090### OH_Image_Receiver_ReadLatestImage()
1091
1092```
1093int32_t OH_Image_Receiver_ReadLatestImage (const ImageReceiverNative * native, napi_value * image )
1094```
1095
1096**描述:**
1097
1098通过[ImageReceiverNative](#imagereceivernative)获取最新的一张图片。
1099
1100**参数:**
1101
1102| 名称 | 描述 |
1103| -------- | -------- |
1104| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1105| image | 获取到的应用层的 **Image** 指针对象。 |
1106
1107**返回:**
1108
1109参考[IRNdkErrCode](#irndkerrcode)。
1110
1111如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1112
1113如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1114
1115如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1116
1117如果参数无效或从surface获取参数失败则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1118
1119如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
1120
1121如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
1122
1123如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1124
1125如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
1126
1127如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1128
1129如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1130
1131**起始版本:**
1132
113310
1134
1135**参见:**
1136
1137[ImageReceiverNative](#imagereceivernative)
1138
1139
1140### OH_Image_Receiver_ReadNextImage()
1141
1142```
1143int32_t OH_Image_Receiver_ReadNextImage (const ImageReceiverNative * native, napi_value * image )
1144```
1145
1146**描述:**
1147
1148通过[ImageReceiverNative](#imagereceivernative)获取下一张图片。
1149
1150**参数:**
1151
1152| 名称 | 描述 |
1153| -------- | -------- |
1154| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1155| image | 读取到的应用层的 **Image** 指针对象。 |
1156
1157**返回:**
1158
1159参考[IRNdkErrCode](#irndkerrcode)。
1160
1161如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1162
1163如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1164
1165如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1166
1167如果参数无效或从surface获取参数失败则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1168
1169如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
1170
1171如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
1172
1173如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1174
1175如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
1176
1177如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1178
1179如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1180
1181**起始版本:**
1182
118310
1184
1185**参见:**
1186
1187[ImageReceiverNative](#imagereceivernative)
1188
1189
1190### OH_Image_Receiver_Release()
1191
1192```
1193int32_t OH_Image_Receiver_Release (ImageReceiverNative * native)
1194```
1195
1196**描述:**
1197
1198释放native层 [ImageReceiverNative](#imagereceivernative) 对象。注意: 此方法不能释放应用层**ImageReceiver**对象。
1199
1200**参数:**
1201
1202| 名称 | 描述 |
1203| -------- | -------- |
1204| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1205
1206**返回:**
1207
1208参考[IRNdkErrCode](#irndkerrcode)。
1209
1210如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1211
1212如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1213
1214如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1215
1216如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
1217
1218**起始版本:**
1219
122010
1221
1222**参见:**
1223
1224[ImageReceiverNative](#imagereceivernative)
1225
1226
1227### OH_Image_Release()
1228
1229```
1230int32_t OH_Image_Release (ImageNative * native)
1231```
1232
1233**描述:**
1234
1235释放 **ImageNative** native对象。 Note: 这个方法无法释放 JavaScript Native API **Image** 对象, 而是释放被 **OH_Image_InitImageNative** 解析的 **ImageNative** native 对象。
1236
1237**参数:**
1238
1239| 名称 | 描述 |
1240| -------- | -------- |
1241| native | 表示 **ImageNative** native对象的指针。 |
1242
1243**返回:**
1244
1245参考[IRNdkErrCode](#irndkerrcode)。
1246
1247如果操作成功返回 IMAGE_RESULT_SUCCESS ;
1248
1249如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1250
1251如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
1252
1253如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
1254
1255**起始版本:**
1256
125710
1258
1259**参见:**
1260
1261[ImageNative](image.md#imagenative),  [OH_Image_InitImageNative](image.md#oh_image_initimagenative)
1262
1263
1264### OH_Image_Size()
1265
1266```
1267int32_t OH_Image_Size (const ImageNative * native, struct OhosImageSize * size )
1268```
1269
1270**描述:**
1271
1272获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。
1273
1274**参数:**
1275
1276| 名称 | 描述 |
1277| -------- | -------- |
1278| native | 表示 **ImageNative** native对象的指针。 |
1279| size | 表示作为转换结果的 [OhosImageSize](_ohos_image_size.md) 对象的指针。 |
1280
1281**返回:**
1282
1283参考[IRNdkErrCode](#irndkerrcode)。
1284
1285如果操作成功返回 IMAGE_RESULT_SUCCESS ;
1286
1287如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1288
1289如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
1290
1291如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;
1292
1293如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
1294
1295**起始版本:**
1296
129710
1298
1299**参见:**
1300
1301[ImageNative](image.md#imagenative), [OhosImageSize](_ohos_image_size.md)
1302
1303
1304### OH_ImageSource_Create()
1305
1306```
1307int32_t OH_ImageSource_Create (napi_env env, struct OhosImageSource * src, struct OhosImageSourceOps * ops, napi_value * res )
1308```
1309
1310**描述:**
1311
1312通过给定的信息[OhosImageSource](_ohos_image_source.md) 和 [OhosImageSourceOps](_ohos_image_source_ops.md)结构体,获取JavaScript native层API** ImageSource**对象。
1313
1314\@Syscap SystemCapability.Multimedia.Image
1315
1316**参数:**
1317
1318| 名称 | 描述 |
1319| -------- | -------- |
1320| env | 表明JNI环境的指针。 |
1321| src | 表明创建一个图像源的信息。查看[OhosImageSource](_ohos_image_source.md)获取更多细节。 |
1322| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 |
1323| res | 表明JavaScript native层API**ImageSource**对象的指针。 |
1324
1325**返回:**
1326
1327参考[IRNdkErrCode](#irndkerrcode)。
1328
1329如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1330
1331如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1332
1333如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1334
1335如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1336
1337如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;
1338
1339如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;
1340
1341如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;
1342
1343如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;
1344
1345如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1346
1347如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1348
1349如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1350
1351如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;
1352
1353如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;
1354
1355如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;
1356
1357如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;
1358
1359如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;
1360
1361如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;
1362
1363如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。
1364
1365**起始版本:**
1366
136710
1368
1369**参见:**
1370
1371[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md)
1372
1373
1374### OH_ImageSource_CreateIncremental()
1375
1376```
1377int32_t OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource * source, struct OhosImageSourceOps * ops, napi_value * res )
1378```
1379
1380**描述:**
1381
1382通过给定的informations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过**OH_ImageSource_UpdateData**更新。
1383
1384\@Syscap SystemCapability.Multimedia.Image
1385
1386**参数:**
1387
1388| 名称 | 描述 |
1389| -------- | -------- |
1390| env | 表明JNI环境的指针。 |
1391| src | 表明创建一个图像源的信息。这里只接收缓冲区类型。查看[OhosImageSource](_ohos_image_source.md)获取更多细节 |
1392| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 |
1393| res | 表明JavaScript native层API**ImageSource**对象的指针。 |
1394
1395**返回:**
1396
1397参考[IRNdkErrCode](#irndkerrcode)。
1398
1399如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1400
1401如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1402
1403如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1404
1405如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1406
1407如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;
1408
1409如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;
1410
1411如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;
1412
1413如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;
1414
1415如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1416
1417如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1418
1419如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1420
1421如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;
1422
1423如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;
1424
1425如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;
1426
1427如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;
1428
1429如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;
1430
1431如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;
1432
1433如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。
1434
1435**起始版本:**
1436
143710
1438
1439**参见:**
1440
1441[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md), [OH_ImageSource_UpdateData](#oh_imagesource_updatedata)
1442
1443
1444### OH_ImageSource_CreatePixelMap()
1445
1446```
1447int32_t OH_ImageSource_CreatePixelMap (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )
1448```
1449
1450**描述:**
1451
1452通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象
1453
1454\@Syscap SystemCapability.Multimedia.Image
1455
1456**参数:**
1457
1458| 名称 | 描述 |
1459| -------- | -------- |
1460| native | 表明native层[ImageSourceNative](#imagesourcenative)值的指针。 |
1461| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 |
1462| res | 表明JavaScript native层API**PixelMap**对象的指针。 |
1463
1464**返回:**
1465
1466参考[IRNdkErrCode](#irndkerrcode)。
1467
1468如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1469
1470如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1471
1472如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1473
1474如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1475
1476如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1477
1478如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1479
1480如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1481
1482如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1483
1484如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
1485
1486如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
1487
1488如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1489
1490如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。
1491
1492如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
1493
1494如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
1495
1496如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL;
1497
1498如果图像内存分配异常,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
1499
1500如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1501
1502如果图像初始化失败,返回 IMAGE_RESULT_INIT_ABNORMAL;
1503
1504如果裁剪错误,返回 IMAGE_RESULT_CROP;
1505
1506如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1507
1508如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1509
1510如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1511
1512如果图像编码失败,返回 IMAGE_RESULT_ENCODE_FAILED;
1513
1514如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
1515
1516如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
1517
1518如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
1519
1520如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1521
1522如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
1523
1524如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。
1525
1526**起始版本:**
1527
152810
1529
1530**参见:**
1531
1532[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md)
1533
1534
1535### OH_ImageSource_CreatePixelMapList()
1536
1537```
1538int32_t OH_ImageSource_CreatePixelMapList (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )
1539```
1540
1541**描述:**
1542
1543通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表
1544
1545\@Syscap SystemCapability.Multimedia.Image
1546
1547**参数:**
1548
1549| 名称 | 描述 |
1550| -------- | -------- |
1551| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1552| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 |
1553| res | 表明JavaScript native层API**PixelMap** 列表对象的指针。 |
1554
1555**返回:**
1556
1557参考[IRNdkErrCode](#irndkerrcode)。
1558
1559如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1560
1561如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1562
1563如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1564
1565如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1566
1567如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1568
1569如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1570
1571如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1572
1573如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1574
1575如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
1576
1577如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
1578
1579如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1580
1581如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1582
1583如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
1584
1585如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
1586
1587如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL;
1588
1589如果图像内存分配异常,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
1590
1591如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1592
1593如果图像初始化失败,返回 IMAGE_RESULT_INIT_ABNORMAL;
1594
1595如果裁剪错误,返回 IMAGE_RESULT_CROP;
1596
1597如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1598
1599如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1600
1601如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1602
1603如果图像编码失败,返回 IMAGE_RESULT_ENCODE_FAILED;
1604
1605如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
1606
1607如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
1608
1609如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
1610
1611如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1612
1613如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
1614
1615如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR;
1616
1617如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1618
1619如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1620
1621**起始版本:**
1622
162310
1624
1625**参见:**
1626
1627[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md)
1628
1629
1630### OH_ImageSource_GetDelayTime()
1631
1632```
1633int32_t OH_ImageSource_GetDelayTime (const ImageSourceNative * native, struct OhosImageSourceDelayTimeList * res )
1634```
1635
1636**描述:**
1637
1638从一些**ImageSource**(如GIF图像源)获取延迟时间列表。
1639
1640\@Syscap SystemCapability.Multimedia.Image
1641
1642**参数:**
1643
1644| 名称 | 描述 |
1645| -------- | -------- |
1646| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1647| res | 表明延迟时间列表 [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) 的指针。 当输入的res中**delayTimeList**是空指针并且**size**是0时,将通过res的**size**中返回延迟时间列表大小 为了获取延迟时间,需要比返回的**delayTimeList**大小值大的足够空间 |
1648
1649**返回:**
1650
1651参考[IRNdkErrCode](#irndkerrcode)。
1652
1653如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1654
1655如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1656
1657如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1658
1659如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1660
1661如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1662
1663如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1664
1665如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1666
1667如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1668
1669如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1670
1671如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1672
1673如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1674
1675如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1676
1677如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1678
1679如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1680
1681如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1682
1683如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1684
1685如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1686
1687如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1688
1689**起始版本:**
1690
169110
1692
1693**参见:**
1694
1695[ImageSourceNative](#imagesourcenative), [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md)
1696
1697
1698### OH_ImageSource_GetFrameCount()
1699
1700```
1701int32_t OH_ImageSource_GetFrameCount (const ImageSourceNative * native, uint32_t * res )
1702```
1703
1704**描述:**
1705
1706从**ImageSource**中获取帧计数。
1707
1708\@Syscap SystemCapability.Multimedia.Image
1709
1710**参数:**
1711
1712| 名称 | 描述 |
1713| -------- | -------- |
1714| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1715| res | 表明帧计数的指针。 |
1716
1717**返回:**
1718
1719参考[IRNdkErrCode](#irndkerrcode)。
1720
1721如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1722
1723如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1724
1725如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1726
1727如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1728
1729如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1730
1731如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1732
1733如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1734
1735如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1736
1737如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1738
1739如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1740
1741如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1742
1743如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1744
1745如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1746
1747如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1748
1749如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1750
1751如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1752
1753如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1754
1755如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1756
1757**起始版本:**
1758
175910
1760
1761**参见:**
1762
1763[ImageSourceNative](#imagesourcenative)
1764
1765
1766### OH_ImageSource_GetImageInfo()
1767
1768```
1769int32_t OH_ImageSource_GetImageInfo (const ImageSourceNative * native, int32_t index, struct OhosImageSourceInfo * info )
1770```
1771
1772**描述:**
1773
1774通过索引从**ImageSource**获取图像源信息。
1775
1776\@Syscap SystemCapability.Multimedia.Image
1777
1778**参数:**
1779
1780| 名称 | 描述 |
1781| -------- | -------- |
1782| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1783| index | 表明帧计数的指针。 |
1784| info | 表明图像源信息[OhosImageSourceInfo](_ohos_image_source_info.md)的指针。 |
1785
1786**返回:**
1787
1788参考[IRNdkErrCode](#irndkerrcode)。
1789
1790如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1791
1792如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1793
1794如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1795
1796如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1797
1798如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1799
1800如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1801
1802如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1803
1804如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1805
1806如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1807
1808如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1809
1810如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1811
1812如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1813
1814如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1815
1816如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1817
1818如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1819
1820如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1821
1822如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1823
1824如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1825
1826**起始版本:**
1827
182810
1829
1830**参见:**
1831
1832[ImageSourceNative](#imagesourcenative), [OhosImageSourceInfo](_ohos_image_source_info.md)
1833
1834
1835### OH_ImageSource_GetImageProperty()
1836
1837```
1838int32_t OH_ImageSource_GetImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )
1839```
1840
1841**描述:**
1842
1843通过关键字从**ImageSource**中获取图像源属性。
1844
1845\@Syscap SystemCapability.Multimedia.Image
1846
1847**参数:**
1848
1849| 名称 | 描述 |
1850| -------- | -------- |
1851| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1852| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
1853| value | 表明作为结果的属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 当输入的value中**value**是空指针并且**size**是0时,将通过value中的**size**返回属性值的大小。 为了获取属性值,需要比**value**中的结果大小大的足够的空间。 |
1854
1855**返回:**
1856
1857参考[IRNdkErrCode](#irndkerrcode)。
1858
1859如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1860
1861如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1862
1863如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1864
1865如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1866
1867如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1868
1869如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1870
1871如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1872
1873如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1874
1875如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1876
1877如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1878
1879如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1880
1881如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1882
1883如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1884
1885如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1886
1887如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1888
1889如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1890
1891如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1892
1893如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1894
1895**起始版本:**
1896
189710
1898
1899**参见:**
1900
1901[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md)
1902
1903
1904### OH_ImageSource_GetSupportedFormats()
1905
1906```
1907int32_t OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList * res)
1908```
1909
1910**描述:**
1911
1912获取所有支持的解码格式元标记。
1913
1914\@Syscap SystemCapability.Multimedia.Image
1915
1916**参数:**
1917
1918| 名称 | 描述 |
1919| -------- | -------- |
1920| res | 表明指向**[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md)**结构的列表指针。 当**supportedFormatList**为nullptr并且**size**以res为0作为输入时,它将以res** size**返回支持的格式大小。<br/>为了获得所有的格式标记,它需要比**supportedFormatList**中的结果大小大的足够空间, 还需要为[OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md)项目中的每个格式提供足够的空间。 |
1921
1922**返回:**
1923
1924参考[IRNdkErrCode](#irndkerrcode)。
1925
1926如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1927
1928如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1929
1930如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1931
1932如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1933
1934如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1935
1936如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR。
1937
1938**起始版本:**
1939
194010
1941
1942**参见:**
1943
1944[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md), [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md)
1945
1946
1947### OH_ImageSource_InitNative()
1948
1949```
1950ImageSourceNative* OH_ImageSource_InitNative (napi_env env, napi_value source )
1951```
1952
1953**描述:**
1954
1955从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](#imagesourcenative)值。
1956
1957\@Syscap SystemCapability.Multimedia.Image
1958
1959**参数:**
1960
1961| 名称 | 描述 |
1962| -------- | -------- |
1963| env | 表明JNI环境的指针。 |
1964| source | 表明JavaScript native层API** ImageSource**对象的指针。 |
1965
1966**返回:**
1967
1968如果操作成功返回[ImageSourceNative](#imagesourcenative)指针;如果操作失败,返回空指针。
1969
1970**起始版本:**
1971
197210
1973
1974**参见:**
1975
1976[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Release](#oh_imagesource_release)
1977
1978
1979### OH_ImageSource_ModifyImageProperty()
1980
1981```
1982int32_t OH_ImageSource_ModifyImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )
1983```
1984
1985**描述:**
1986
1987通过关键字为**ImageSource**修改图像源属性。
1988
1989\@Syscap SystemCapability.Multimedia.Image
1990
1991**参数:**
1992
1993| 名称 | 描述 |
1994| -------- | -------- |
1995| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针 |
1996| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
1997| value | 为了修改表明属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
1998
1999**返回:**
2000
2001参考[IRNdkErrCode](#irndkerrcode)。
2002
2003如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2004
2005如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2006
2007如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2008
2009如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2010
2011如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2012
2013如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
2014
2015如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
2016
2017如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
2018
2019如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
2020
2021如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
2022
2023如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
2024
2025如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
2026
2027如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
2028
2029如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
2030
2031如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
2032
2033如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
2034
2035如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
2036
2037如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
2038
2039**起始版本:**
2040
204110
2042
2043**参见:**
2044
2045[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md)
2046
2047
2048### OH_ImageSource_Release()
2049
2050```
2051int32_t OH_ImageSource_Release (ImageSourceNative * native)
2052```
2053
2054**描述:**
2055
2056释放native层图像源 **ImageSourceNative**。
2057
2058\@Syscap SystemCapability.Multimedia.Image
2059
2060**参数:**
2061
2062| 名称 | 描述 |
2063| -------- | -------- |
2064| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
2065
2066**返回:**
2067
2068参考[IRNdkErrCode](#irndkerrcode)。
2069
2070如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2071
2072如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2073
2074如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2075
2076如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2077
2078如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2079
2080如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。
2081
2082**起始版本:**
2083
208410
2085
2086**参见:**
2087
2088[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Create](#oh_imagesource_create), [OH_ImageSource_CreateIncremental](#oh_imagesource_createincremental)
2089
2090
2091### OH_ImageSource_UpdateData()
2092
2093```
2094int32_t OH_ImageSource_UpdateData (const ImageSourceNative * native, struct OhosImageSourceUpdateData * data )
2095```
2096
2097**描述:**
2098
2099为了增量类型的**ImageSource**更新源数据。
2100
2101\@Syscap SystemCapability.Multimedia.Image
2102
2103**参数:**
2104
2105| 名称 | 描述 |
2106| -------- | -------- |
2107| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
2108| data | 表明更新数据信息[OhosImageSourceUpdateData](_ohos_image_source_update_data.md)的指针。 |
2109
2110**返回:**
2111
2112参考[IRNdkErrCode](#irndkerrcode)。
2113
2114如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2115
2116如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2117
2118如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2119
2120如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2121
2122如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2123
2124如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
2125
2126如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
2127
2128如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
2129
2130如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
2131
2132如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2133
2134如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
2135
2136如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
2137
2138如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
2139
2140如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
2141
2142如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;
2143
2144如果图像内存分配异常,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
2145
2146如果图像类型不支持,返回 IMAGE_RESULT_DATA_UNSUPPORT;
2147
2148如果图像初始化失败,返回 IMAGE_RESULT_INIT_ABNORMAL;
2149
2150如果裁剪错误,返回 IMAGE_RESULT_CROP;
2151
2152如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
2153
2154如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
2155
2156如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
2157
2158如果图像编码失败,返回 IMAGE_RESULT_ENCODE_FAILED;
2159
2160如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
2161
2162如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
2163
2164如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
2165
2166如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
2167
2168如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
2169
2170如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。
2171
2172**起始版本:**
2173
217410
2175
2176**参见:**
2177
2178[ImageSourceNative](#imagesourcenative), [OhosImageSourceUpdateData](_ohos_image_source_update_data.md)
2179
2180
2181### OH_PixelMap_AccessPixels()
2182
2183```
2184int32_t OH_PixelMap_AccessPixels (const NativePixelMap * native, void ** addr )
2185```
2186
2187**描述:**
2188
2189获取native **PixelMap** 对象数据的内存地址,并锁定该内存。
2190
2191**参数:**
2192
2193| 名称 | 描述 |
2194| -------- | -------- |
2195| native | NativePixelMap的指针。 |
2196| addr | 用于指向的内存地址的二级指针对象。 |
2197
2198**返回:**
2199
2200参考[IRNdkErrCode](#irndkerrcode)。
2201
2202如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2203
2204如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2205
2206如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2207
2208如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2209
2210如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2211
2212如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2213
2214如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2215
2216如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2217
2218如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2219
2220如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2221
2222如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2223
2224如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2225
2226如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2227
2228如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2229
2230如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2231
2232如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2233
2234如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2235
2236如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2237
2238如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2239
2240如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2241
2242**起始版本:**
2243
224410
2245
2246**参见:**
2247
2248[AccessPixels](image.md#oh_pixelmap_accesspixels)
2249
2250
2251### OH_PixelMap_CreateAlphaPixelMap()
2252
2253```
2254int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value * alpha )
2255```
2256
2257**描述:**
2258
2259根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。
2260
2261**参数:**
2262
2263| 名称 | 描述 |
2264| -------- | -------- |
2265| env | napi的环境指针。 |
2266| source | **PixelMap**数据设置项。 |
2267| alpha | alpha通道的指针。 |
2268
2269**返回:**
2270
2271参考[IRNdkErrCode](#irndkerrcode)。
2272
2273如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2274
2275如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2276
2277如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2278
2279如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2280
2281如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2282
2283如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2284
2285如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ;
2286
2287如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ;
2288
2289如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ;
2290
2291如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2292
2293如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2294
2295如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2296
2297如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2298
2299如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2300
2301如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ;
2302
2303如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2304
2305如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2306
2307如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2308
2309如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2310
2311如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2312
2313如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2314
2315如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2316
2317如果图像编码失败则返回 IMAGE_RESULT_ENCODE_FAILED ;
2318
2319如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ;
2320
2321如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ;
2322
2323如果ipc失败则返回IMAGE_RESULT_ERR_IPC ;
2324
2325如果参数无效则返回 IMAGE_RESULT_INDEX_INVALID ;
2326
2327如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2328
2329如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2330
2331**起始版本:**
2332
233310
2334
2335**参见:**
2336
2337[CreateAlphaPixelMap](image.md#oh_pixelmap_createalphapixelmap)
2338
2339
2340### OH_PixelMap_CreatePixelMap()
2341
2342```
2343int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void * buf, size_t len, napi_value * res )
2344```
2345
2346**描述:**
2347
2348Creates a **PixelMap** object.
2349
2350**参数:**
2351
2352| 名称 | 描述 |
2353| -------- | -------- |
2354| env | napi的环境指针。 |
2355| info | pixel map 数据设置项。 |
2356| buf | 图片的buffer数据。 |
2357| len | 图片大小信息。 |
2358| res | 应用层的 **PixelMap** 对象的指针。 |
2359
2360**返回:**
2361
2362参考[IRNdkErrCode](#irndkerrcode)。
2363
2364如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2365
2366如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2367
2368如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2369
2370如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2371
2372如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2373
2374如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2375
2376如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ;
2377
2378如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ;
2379
2380如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ;
2381
2382如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2383
2384如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2385
2386如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2387
2388如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2389
2390如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2391
2392如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ;
2393
2394如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2395
2396如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2397
2398如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2399
2400如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2401
2402如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2403
2404如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2405
2406如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2407
2408如果图像编码失败则返回 IMAGE_RESULT_ENCODE_FAILED ;
2409
2410如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ;
2411
2412如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ;
2413
2414如果ipc失败则返回IMAGE_RESULT_ERR_IPC ;
2415
2416如果参数无效则返回 IMAGE_RESULT_INDEX_INVALID ;
2417
2418如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2419
2420如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2421
2422**起始版本:**
2423
242410
2425
2426**参见:**
2427
2428[CreatePixelMap](image.md#oh_pixelmap_createpixelmap)
2429
2430
2431### OH_PixelMap_Crop()
2432
2433```
2434int32_t OH_PixelMap_Crop (const NativePixelMap * native, int32_t x, int32_t y, int32_t width, int32_t height )
2435```
2436
2437**描述:**
2438
2439设置**PixelMap**对象的裁剪。
2440
2441**参数:**
2442
2443| 名称 | 描述 |
2444| -------- | -------- |
2445| native | NativePixelMap的指针。 |
2446| x | 目标图片左上角的x坐标。 |
2447| y | 目标图片左上角的y坐标。 |
2448| width | 裁剪区域的宽度。 |
2449| height | 裁剪区域的高度。 |
2450
2451**返回:**
2452
2453参考[IRNdkErrCode](#irndkerrcode)。
2454
2455如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2456
2457如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2458
2459如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2460
2461如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2462
2463如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2464
2465如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2466
2467如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2468
2469如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2470
2471如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2472
2473如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2474
2475如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2476
2477如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2478
2479如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2480
2481如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2482
2483如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2484
2485如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2486
2487如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2488
2489如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2490
2491如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2492
2493如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2494
2495**起始版本:**
2496
249710
2498
2499**参见:**
2500
2501[Crop](image.md#oh_pixelmap_crop)
2502
2503
2504### OH_PixelMap_Flip()
2505
2506```
2507int32_t OH_PixelMap_Flip (const NativePixelMap * native, int32_t x, int32_t y )
2508```
2509
2510**描述:**
2511
2512设置**PixelMap**对象的翻转。
2513
2514**参数:**
2515
2516| 名称 | 描述 |
2517| -------- | -------- |
2518| native | NativePixelMap的指针。 |
2519| x | 根据水平方向x轴进行图片翻转。 |
2520| y | 根据垂直方向y轴进行图片翻转。 |
2521
2522**返回:**
2523
2524参考[IRNdkErrCode](#irndkerrcode)。
2525
2526如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2527
2528如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2529
2530如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2531
2532如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2533
2534如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2535
2536如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2537
2538如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2539
2540如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2541
2542如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2543
2544如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2545
2546如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2547
2548如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2549
2550如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2551
2552如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2553
2554如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2555
2556如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2557
2558如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2559
2560如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2561
2562如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2563
2564如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2565
2566**起始版本:**
2567
256810
2569
2570**参见:**
2571
2572[Flip](image.md#oh_pixelmap_flip)
2573
2574
2575### OH_PixelMap_GetBytesNumberPerRow()
2576
2577```
2578int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap * native, int32_t * num )
2579```
2580
2581**描述:**
2582
2583获取**PixelMap**对象每行字节数。
2584
2585**参数:**
2586
2587| 名称 | 描述 |
2588| -------- | -------- |
2589| native | NativePixelMap的指针。 |
2590| num | **PixelMap**对象的每行字节数指针。 |
2591
2592**返回:**
2593
2594参考[IRNdkErrCode](#irndkerrcode)。
2595
2596如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2597
2598如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2599
2600如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2601
2602如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2603
2604如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2605
2606如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
2607
2608**起始版本:**
2609
261010
2611
2612**参见:**
2613
2614[GetBytesNumberPerRow](image.md#oh_pixelmap_getbytesnumberperrow)
2615
2616
2617### OH_PixelMap_GetDensity()
2618
2619```
2620int32_t OH_PixelMap_GetDensity (const NativePixelMap * native, int32_t * density )
2621```
2622
2623**描述:**
2624
2625获取**PixelMap**对象像素密度。
2626
2627**参数:**
2628
2629| 名称 | 描述 |
2630| -------- | -------- |
2631| native | NativePixelMap的指针。 |
2632| density | 像素密度指针。 |
2633
2634**返回:**
2635
2636参考[IRNdkErrCode](#irndkerrcode)。
2637
2638如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2639
2640如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2641
2642如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2643
2644如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2645
2646如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2647
2648如果参数无效则返回IMAGE_RESULT_INDEX_INVALI 。
2649
2650**起始版本:**
2651
265210
2653
2654**参见:**
2655
2656[GetDensity](image.md#oh_pixelmap_getdensity)
2657
2658
2659### OH_PixelMap_GetImageInfo()
2660
2661```
2662int32_t OH_PixelMap_GetImageInfo (const NativePixelMap * native, OhosPixelMapInfos * info )
2663```
2664
2665**描述:**
2666
2667获取**PixelMap**对象图像信息。
2668
2669**参数:**
2670
2671| 名称 | 描述 |
2672| -------- | -------- |
2673| native | NativePixelMap的指针。 |
2674| info | 图像信息指针。 |
2675
2676**返回:**
2677
2678参考[IRNdkErrCode](#irndkerrcode)。
2679
2680如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2681
2682如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2683
2684如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2685
2686如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2687
2688如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2689
2690如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2691
2692如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2693
2694如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2695
2696如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2697
2698如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2699
2700如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2701
2702如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2703
2704如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2705
2706如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2707
2708如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2709
2710如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2711
2712如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2713
2714如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2715
2716如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2717
2718如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2719
2720**起始版本:**
2721
272210
2723
2724**参见:**
2725
2726[OhosPixelMapInfos](_ohos_pixel_map_infos.md)
2727
2728
2729### OH_PixelMap_GetIsEditable()
2730
2731```
2732int32_t OH_PixelMap_GetIsEditable (const NativePixelMap * native, int32_t * editable )
2733```
2734
2735**描述:**
2736
2737获取**PixelMap**对象是否可编辑的状态。
2738
2739**参数:**
2740
2741| 名称 | 描述 |
2742| -------- | -------- |
2743| native | NativePixelMap的指针。 |
2744| editable | **PixelMap** 对象是否可编辑的指针。 |
2745
2746**返回:**
2747
2748参考[IRNdkErrCode](#irndkerrcode)。
2749
2750如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2751
2752如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2753
2754如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2755
2756如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2757
2758如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2759
2760如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
2761
2762**起始版本:**
2763
276410
2765
2766**参见:**
2767
2768[GetIsEditable](image.md#oh_pixelmap_getiseditable)
2769
2770
2771### OH_PixelMap_InitNativePixelMap()
2772
2773```
2774NativePixelMap* OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source )
2775```
2776
2777**描述:**
2778
2779初始化**PixelMap**对象数据。
2780
2781**参数:**
2782
2783| 名称 | 描述 |
2784| -------- | -------- |
2785| env | napi的环境指针。 |
2786| source | **PixelMap** 数据设置项。 |
2787
2788**返回:**
2789
2790操作成功则返回NativePixelMap的指针;如果操作失败,则返回错误码。
2791
2792**起始版本:**
2793
279410
2795
2796**参见:**
2797
2798[InitNativePixelMap](image.md#oh_pixelmap_initnativepixelmap)
2799
2800
2801### OH_PixelMap_IsSupportAlpha()
2802
2803```
2804int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap * native, int32_t * alpha )
2805```
2806
2807**描述:**
2808
2809获取**PixelMap**对象是否支持Alpha通道。
2810
2811**参数:**
2812
2813| 名称 | 描述 |
2814| -------- | -------- |
2815| native | NativePixelMap的指针。 |
2816| alpha | 是否支持Alpha的指针。 |
2817
2818**返回:**
2819
2820参考[IRNdkErrCode](#irndkerrcode)。
2821
2822如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2823
2824如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2825
2826如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2827
2828如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2829
2830如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2831
2832如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
2833
2834**起始版本:**
2835
283610
2837
2838**参见:**
2839
2840[IsSupportAlpha](image.md#oh_pixelmap_issupportalpha)
2841
2842
2843### OH_PixelMap_Rotate()
2844
2845```
2846int32_t OH_PixelMap_Rotate (const NativePixelMap * native, float angle )
2847```
2848
2849**描述:**
2850
2851设置**PixelMap**对象的旋转。
2852
2853**参数:**
2854
2855| 名称 | 描述 |
2856| -------- | -------- |
2857| native | NativePixelMap的指针。 |
2858| angle | 旋转角度。 |
2859
2860**返回:**
2861
2862参考[IRNdkErrCode](#irndkerrcode)。
2863
2864如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2865
2866如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2867
2868如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2869
2870如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2871
2872如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2873
2874如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2875
2876如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2877
2878如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2879
2880如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2881
2882如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2883
2884如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2885
2886如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2887
2888如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2889
2890如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2891
2892如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2893
2894如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2895
2896如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2897
2898如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2899
2900如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2901
2902如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2903
2904**起始版本:**
2905
290610
2907
2908**参见:**
2909
2910[Rotate](image.md#oh_pixelmap_rotate)
2911
2912
2913### OH_PixelMap_Scale()
2914
2915```
2916int32_t OH_PixelMap_Scale (const NativePixelMap * native, float x, float y )
2917```
2918
2919**描述:**
2920
2921设置**PixelMap**对象的缩放。
2922
2923**参数:**
2924
2925| 名称 | 描述 |
2926| -------- | -------- |
2927| native | NativePixelMap的指针。 |
2928| x | 缩放宽度。 |
2929| y | 缩放高度。 |
2930
2931**返回:**
2932
2933参考[IRNdkErrCode](#irndkerrcode)。
2934
2935如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2936
2937如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2938
2939如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2940
2941如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2942
2943如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2944
2945如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2946
2947如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2948
2949如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2950
2951如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2952
2953如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2954
2955如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2956
2957如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2958
2959如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2960
2961如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2962
2963如果裁剪失败则返回 IMAGE_RESULT_CROP ;
2964
2965如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2966
2967如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2968
2969如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2970
2971如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
2972
2973如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2974
2975如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2976
2977**起始版本:**
2978
297910
2980
2981**参见:**
2982
2983[Scale](image.md#oh_pixelmap_scale)
2984
2985
2986### OH_PixelMap_SetAlphaAble()
2987
2988```
2989int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap * native, int32_t alpha )
2990```
2991
2992**描述:**
2993
2994设置**PixelMap**对象的Alpha通道。
2995
2996**参数:**
2997
2998| 名称 | 描述 |
2999| -------- | -------- |
3000| native | NativePixelMap的指针。 |
3001| alpha | Alpha通道。 |
3002
3003**返回:**
3004
3005参考[IRNdkErrCode](#irndkerrcode)。
3006
3007如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3008
3009如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3010
3011如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3012
3013如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3014
3015如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3016
3017如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
3018
3019**起始版本:**
3020
302110
3022
3023**参见:**
3024
3025[SetAlphaAble](image.md#oh_pixelmap_setalphaable)
3026
3027
3028### OH_PixelMap_SetDensity()
3029
3030
3031```
3032int32_t OH_PixelMap_SetDensity (const NativePixelMap * native, int32_t density )
3033```
3034
3035**描述:**
3036
3037设置**PixelMap**对象像素密度。
3038
3039**参数:**
3040
3041| 名称 | 描述 |
3042| -------- | -------- |
3043| native | NativePixelMap的指针。 |
3044| density | 像素密度。 |
3045
3046**返回:**
3047
3048参考[IRNdkErrCode](#irndkerrcode)。
3049
3050如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3051
3052如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3053
3054如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3055
3056如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3057
3058如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3059
3060如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
3061
3062**起始版本:**
3063
306410
3065
3066**参见:**
3067
3068[GetDensity](oh_pixelmap_getdensity)
3069
3070
3071### OH_PixelMap_SetOpacity()
3072
3073```
3074int32_t OH_PixelMap_SetOpacity (const NativePixelMap * native, float opacity )
3075```
3076
3077**描述:**
3078
3079设置**PixelMap**对象的透明度。
3080
3081**参数:**
3082
3083| 名称 | 描述 |
3084| -------- | -------- |
3085| native | NativePixelMap的指针。 |
3086| opacity | 透明度。 |
3087
3088**返回:**
3089
3090参考[IRNdkErrCode](#irndkerrcode)。
3091
3092如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3093
3094如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3095
3096如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3097
3098如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3099
3100如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3101
3102如果参数无效则返回IMAGE_RESULT_INDEX_INVALID 。
3103
3104**起始版本:**
3105
310610
3107
3108**参见:**
3109
3110[SetOpacity](image.md#oh_pixelmap_setopacity)
3111
3112
3113### OH_PixelMap_Translate()
3114
3115```
3116int32_t OH_PixelMap_Translate (const NativePixelMap * native, float x, float y )
3117```
3118
3119**描述:**
3120
3121设置**PixelMap**对象的偏移。
3122
3123**参数:**
3124
3125| 名称 | 描述 |
3126| -------- | -------- |
3127| native | NativePixelMap的指针。 |
3128| x | 水平偏移量。 |
3129| y | 垂直偏移量。 |
3130
3131**返回:**
3132
3133参考[IRNdkErrCode](#irndkerrcode)。
3134
3135如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
3136
3137如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3138
3139如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3140
3141如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3142
3143如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
3144
3145如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
3146
3147如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
3148
3149如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
3150
3151如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3152
3153如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
3154
3155如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
3156
3157如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
3158
3159如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3160
3161如果裁剪失败则返回 IMAGE_RESULT_CROP ;
3162
3163如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
3164
3165如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
3166
3167如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
3168
3169如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
3170
3171如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
3172
3173如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
3174
3175**起始版本:**
3176
317710
3178
3179**参见:**
3180
3181[Translate](image.md#oh_pixelmap_translate)
3182
3183
3184### OH_PixelMap_UnAccessPixels()
3185
3186```
3187int32_t OH_PixelMap_UnAccessPixels (const NativePixelMap * native)
3188```
3189
3190**描述:**
3191
3192释放native **PixelMap**对象数据的内存锁,用于匹配方法[OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels)。
3193
3194**参数:**
3195
3196| 名称 | 描述 |
3197| -------- | -------- |
3198| native | NativePixelMap的指针。 |
3199
3200**返回:**
3201
3202参考[IRNdkErrCode](#irndkerrcode)。
3203
3204如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
3205
3206如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3207
3208如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3209
3210如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3211
3212如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
3213
3214如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
3215
3216如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
3217
3218如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
3219
3220如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3221
3222如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
3223
3224如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
3225
3226如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
3227
3228如果属性无效或图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3229
3230如果裁剪失败则返回 IMAGE_RESULT_CROP ;
3231
3232如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
3233
3234如果注册插件失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
3235
3236如果创建插件失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
3237
3238如果参数无效则返回IMAGE_RESULT_INDEX_INVALID ;
3239
3240如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
3241
3242如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
3243
3244**起始版本:**
3245
324610
3247
3248**参见:**
3249
3250[UnAccessPixels](image.md#oh_pixelmap_unaccesspixels)
3251
3252
3253### OH_UnAccessPixels()
3254
3255```
3256int32_t OHOS::Media::OH_UnAccessPixels (napi_env env, napi_value value )
3257```
3258
3259**描述:**
3260
3261释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。
3262
3263**参数:**
3264
3265| 名称 | 描述 |
3266| -------- | -------- |
3267| env | napi的环境指针。 |
3268| value | 应用层的 **PixelMap** 对象。 |
3269
3270**返回:**
3271
3272操作成功则返回 **OHOS_IMAGE_RESULT_SUCCESS**;如果操作失败,则返回错误码。
3273
3274**起始版本:**
3275
32768
3277
3278**废弃起始版本:**
3279
328010
3281
3282**参见:**
3283
3284[AccessPixels](image.md#oh_accesspixels)
3285
3286
3287## 变量说明
3288
3289
3290### alphaType
3291
3292```
3293int32_t OhosImageSourceInfo::alphaType
3294```
3295
3296**描述:**
3297
3298图像源透明度类型
3299
3300**起始版本:**
3301
330210
3303
3304
3305### buffer [1/2]
3306
3307```
3308uint8_t* OhosImageSource::buffer = nullptr
3309```
3310
3311**描述:**
3312
3313图像源缓冲区资源,接受格式化包缓冲区或者base64缓冲区
3314
3315**起始版本:**
3316
331710
3318
3319
3320### buffer [2/2]
3321
3322```
3323uint8_t* OhosImageSourceUpdateData::buffer = nullptr
3324```
3325
3326**描述:**
3327
3328图像源更新数据缓冲区
3329
3330**起始版本:**
3331
333210
3333
3334
3335### bufferSize [1/2]
3336
3337```
3338size_t OhosImageSource::bufferSize = 0
3339```
3340
3341**描述:**
3342
3343图像源缓冲区资源大小
3344
3345**起始版本:**
3346
334710
3348
3349
3350### bufferSize [2/2]
3351
3352```
3353size_t OhosImageSourceUpdateData::bufferSize = 0
3354```
3355
3356**描述:**
3357
3358图像源更新数据缓冲区大小
3359
3360**起始版本:**
3361
336210
3363
3364
3365### colorSpace
3366
3367```
3368int32_t OhosImageSourceInfo::colorSpace
3369```
3370
3371**描述:**
3372
3373图像源色彩空间
3374
3375**起始版本:**
3376
337710
3378
3379
3380### delayTimeList
3381
3382```
3383int32_t* OhosImageSourceDelayTimeList::delayTimeList
3384```
3385
3386**描述:**
3387
3388图像源延迟时间列表头地址
3389
3390**起始版本:**
3391
339210
3393
3394
3395### density [1/2]
3396
3397```
3398int32_t OhosImageSourceOps::density
3399```
3400
3401**描述:**
3402
3403图像源像素密度
3404
3405**起始版本:**
3406
340710
3408
3409
3410### density [2/2]
3411
3412```
3413int32_t OhosImageSourceInfo::density
3414```
3415
3416**描述:**
3417
3418图像源密度, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置
3419
3420**起始版本:**
3421
342210
3423
3424
3425### editable
3426
3427```
3428int8_t OhosImageDecodingOps::editable
3429```
3430
3431**描述:**
3432
3433定义输出的像素位图是否可编辑
3434
3435**起始版本:**
3436
343710
3438
3439
3440### fd
3441
3442```
3443int32_t OhosImageSource::fd = -1
3444```
3445
3446**描述:**
3447
3448图像源文件资源描述符
3449
3450**起始版本:**
3451
345210
3453
3454
3455### fitDensity
3456
3457```
3458int32_t OhosImageDecodingOps::fitDensity
3459```
3460
3461**描述:**
3462
3463定义解码目标的像素密度
3464
3465**起始版本:**
3466
346710
3468
3469
3470### format
3471
3472```
3473char* OhosImageSourceSupportedFormat::format = nullptr
3474```
3475
3476**描述:**
3477
3478图像源支持的格式字符串头地址
3479
3480**起始版本:**
3481
348210
3483
3484
3485### height
3486
3487```
3488int32_t OhosImageRegion::height
3489```
3490
3491**描述:**
3492
3493高度范围,用pixels表示
3494
3495**起始版本:**
3496
349710
3498
3499
3500### index
3501
3502```
3503uint32_t OhosImageDecodingOps::index
3504```
3505
3506**描述:**
3507
3508定义图像源解码指数
3509
3510**起始版本:**
3511
351210
3513
3514
3515### isCompleted
3516
3517```
3518int8_t OhosImageSourceUpdateData::isCompleted = 0
3519```
3520
3521**描述:**
3522
3523图像源更新数据在此节中完成
3524
3525**起始版本:**
3526
352710
3528
3529
3530### offset
3531
3532```
3533uint32_t OhosImageSourceUpdateData::offset = 0
3534```
3535
3536**描述:**
3537
3538图像源更新数据缓冲区的开端
3539
3540**起始版本:**
3541
354210
3543
3544
3545### OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE
3546
3547```
3548const char* OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample"
3549```
3550
3551**描述:**
3552
3553定义每个样本比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3554
3555\@Syscap SystemCapability.Multimedia.Image
3556
3557**起始版本:**
3558
355910
3560
3561
3562### OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL
3563
3564```
3565const char* OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel"
3566```
3567
3568**描述:**
3569
3570定义每个像素的压缩比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3571
3572\@Syscap SystemCapability.Multimedia.Image
3573
3574**起始版本:**
3575
357610
3577
3578
3579### OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL
3580
3581```
3582const char* OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal"
3583```
3584
3585**描述:**
3586
3587定义初始日期时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3588
3589\@Syscap SystemCapability.Multimedia.Image
3590
3591**起始版本:**
3592
359310
3594
3595
3596### OHOS_IMAGE_PROPERTY_EXPOSURE_TIME
3597
3598```
3599const char* OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime"
3600```
3601
3602**描述:**
3603
3604定义曝光时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3605
3606\@Syscap SystemCapability.Multimedia.Image
3607
3608**起始版本:**
3609
361010
3611
3612
3613### OHOS_IMAGE_PROPERTY_F_NUMBER
3614
3615```
3616const char* OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber"
3617```
3618
3619**描述:**
3620
3621定义FNumber的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3622
3623\@Syscap SystemCapability.Multimedia.Image
3624
3625**起始版本:**
3626
362710
3628
3629
3630### OHOS_IMAGE_PROPERTY_GPS_LATITUDE
3631
3632```
3633const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude"
3634```
3635
3636**描述:**
3637
3638定义GPS纬度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3639
3640\@Syscap SystemCapability.Multimedia.Image
3641
3642**起始版本:**
3643
364410
3645
3646
3647### OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF
3648
3649```
3650const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef"
3651```
3652
3653**描述:**
3654
3655定义GPS纬度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3656
3657\@Syscap SystemCapability.Multimedia.Image
3658
3659**起始版本:**
3660
366110
3662
3663
3664### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE
3665
3666```
3667const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude"
3668```
3669
3670**描述:**
3671
3672定义GPS经度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3673
3674\@Syscap SystemCapability.Multimedia.Image
3675
3676**起始版本:**
3677
367810
3679
3680
3681### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF
3682
3683```
3684const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef"
3685```
3686
3687**描述:**
3688
3689定义GPS经度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3690
3691\@Syscap SystemCapability.Multimedia.Image
3692
3693**起始版本:**
3694
369510
3696
3697
3698### OHOS_IMAGE_PROPERTY_IMAGE_LENGTH
3699
3700```
3701const char* OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength"
3702```
3703
3704**描述:**
3705
3706定义图像长度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3707
3708\@Syscap SystemCapability.Multimedia.Image
3709
3710**起始版本:**
3711
371210
3713
3714
3715### OHOS_IMAGE_PROPERTY_IMAGE_WIDTH
3716
3717```
3718const char* OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth"
3719```
3720
3721**描述:**
3722
3723定义图像宽度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3724
3725\@Syscap SystemCapability.Multimedia.Image
3726
3727**起始版本:**
3728
372910
3730
3731
3732### OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS
3733
3734```
3735const char* OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings"
3736```
3737
3738**描述:**
3739
3740定义ISO速度等级的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3741
3742\@Syscap SystemCapability.Multimedia.Image
3743
3744**起始版本:**
3745
374610
3747
3748
3749### OHOS_IMAGE_PROPERTY_ORIENTATION
3750
3751```
3752const char* OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation"
3753```
3754
3755**描述:**
3756
3757定义方向的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3758
3759\@Syscap SystemCapability.Multimedia.Image
3760
3761**起始版本:**
3762
376310
3764
3765
3766### OHOS_IMAGE_PROPERTY_SCENE_TYPE
3767
3768```
3769const char* OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType"
3770```
3771
3772**描述:**
3773
3774定义场景类型的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3775
3776\@Syscap SystemCapability.Multimedia.Image
3777
3778**起始版本:**
3779
378010
3781
3782
3783### pixelFormat [1/3]
3784
3785```
3786int32_t OhosImageSourceOps::pixelFormat
3787```
3788
3789**描述:**
3790
3791图像源像素格式,通常用于描述YUV缓冲区
3792
3793**起始版本:**
3794
379510
3796
3797
3798### pixelFormat [2/3]
3799
3800```
3801int32_t OhosImageDecodingOps::pixelFormat
3802```
3803
3804**描述:**
3805
3806定义输出的像素格式
3807
3808**起始版本:**
3809
381010
3811
3812
3813### pixelFormat [3/3]
3814
3815```
3816int32_t OhosImageSourceInfo::pixelFormat
3817```
3818
3819**描述:**
3820
3821图像源像素格式, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置
3822
3823**起始版本:**
3824
382510
3826
3827
3828### region
3829
3830```
3831struct OhosImageRegion OhosImageDecodingOps::region
3832```
3833
3834**描述:**
3835
3836定义图像源解码的像素范围
3837
3838**起始版本:**
3839
384010
3841
3842
3843### rotate
3844
3845```
3846uint32_t OhosImageDecodingOps::rotate
3847```
3848
3849**描述:**
3850
3851定义解码旋转选项
3852
3853**起始版本:**
3854
385510
3856
3857
3858### sampleSize
3859
3860```
3861uint32_t OhosImageDecodingOps::sampleSize
3862```
3863
3864**描述:**
3865
3866定义解码样本大小选项
3867
3868**起始版本:**
3869
387010
3871
3872
3873### size [1/7]
3874
3875```
3876struct OhosImageSize OhosImageSourceOps::size
3877```
3878
3879**描述:**
3880
3881图像源像素宽高的大小
3882
3883**起始版本:**
3884
388510
3886
3887
3888### size [2/7]
3889
3890```
3891struct OhosImageSize OhosImageDecodingOps::size
3892```
3893
3894**描述:**
3895
3896定义解码目标像素宽高的大小
3897
3898**起始版本:**
3899
390010
3901
3902
3903### size [3/7]
3904
3905```
3906struct OhosImageSize OhosImageSourceInfo::size
3907```
3908
3909**描述:**
3910
3911图像源像素宽高的大小
3912
3913**起始版本:**
3914
391510
3916
3917
3918### size [4/7]
3919
3920```
3921size_t OhosImageSourceDelayTimeList::size = 0
3922```
3923
3924**描述:**
3925
3926图像源延迟时间列表大小
3927
3928**起始版本:**
3929
393010
3931
3932
3933### size [5/7]
3934
3935```
3936size_t OhosImageSourceSupportedFormat::size = 0
3937```
3938
3939**描述:**
3940
3941图像源支持的格式字符串大小
3942
3943**起始版本:**
3944
394510
3946
3947
3948### size [6/7]
3949
3950```
3951size_t OhosImageSourceSupportedFormatList::size = 0
3952```
3953
3954**描述:**
3955
3956图像源支持的格式字符串列表大小
3957
3958**起始版本:**
3959
396010
3961
3962
3963### size [7/7]
3964
3965```
3966size_t OhosImageSourceProperty::size = 0
3967```
3968
3969**描述:**
3970
3971定义图像源属性键值字符串大小
3972
3973**起始版本:**
3974
397510
3976
3977
3978### supportedFormatList
3979
3980```
3981struct OhosImageSourceSupportedFormat** OhosImageSourceSupportedFormatList::supportedFormatList = nullptr
3982```
3983
3984**描述:**
3985
3986图像源支持的格式字符串列表头地址
3987
3988**起始版本:**
3989
399010
3991
3992
3993### updateLength
3994
3995```
3996uint32_t OhosImageSourceUpdateData::updateLength = 0
3997```
3998
3999**描述:**
4000
4001图像源更新数据缓冲区的更新数据长度
4002
4003**起始版本:**
4004
400510
4006
4007
4008### uri
4009
4010```
4011char* OhosImageSource::uri = nullptr
4012```
4013
4014**描述:**
4015
4016图像源资源标识符,接受文件资源或者base64资源
4017
4018**起始版本:**
4019
402010
4021
4022
4023### uriSize
4024
4025```
4026size_t OhosImageSource::uriSize = 0
4027```
4028
4029**描述:**
4030
4031图像源资源长度
4032
4033**起始版本:**
4034
403510
4036
4037
4038### value
4039
4040```
4041char* OhosImageSourceProperty::value = nullptr
4042```
4043
4044**描述:**
4045
4046定义图像源属性键值字符串头地址
4047
4048**起始版本:**
4049
405010
4051
4052
4053### width
4054
4055```
4056int32_t OhosImageRegion::width
4057```
4058
4059**描述:**
4060
4061宽度范围,用pixels表示
4062
4063**起始版本:**
4064
406510
4066
4067
4068### x
4069
4070```
4071int32_t OhosImageRegion::x
4072```
4073
4074**描述:**
4075
4076起始x坐标,用pixels表示
4077
4078**起始版本:**
4079
408010
4081
4082
4083### y
4084
4085```
4086int32_t OhosImageRegion::y
4087```
4088
4089**描述:**
4090
4091起始y坐标,用pixels表示
4092
4093**起始版本:**
4094
409510
4096
4097