• 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 OhosPixelMapInfosOhosPixelMapInfos
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
611UnAccessPixels
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
686ImageNative, [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
726ImageNative
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
767ImageNative, [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
797ImageNative, 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如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
829
830如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ;
831
832如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
833
834如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
835
836如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
837
838如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
839
840如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
841
842如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
843
844**起始版本:**
845
84610
847
848**参见:**
849
850[OhosImageReceiverInfo](_ohos_image_receiver_info.md)
851
852
853### OH_Image_Receiver_GetCapacity()
854
855```
856int32_t OH_Image_Receiver_GetCapacity (const ImageReceiverNative * native, int32_t * capacity )
857```
858
859**描述:**
860
861通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的容量。
862
863**参数:**
864
865| 名称 | 描述 |
866| -------- | -------- |
867| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
868| capacity | 作为结果的指向容量的指针。 |
869
870**返回:**
871
872参考[IRNdkErrCode](#irndkerrcode)。
873
874如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
875
876如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
877
878如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
879
880如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
881
882如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
883
884**起始版本:**
885
88610
887
888**参见:**
889
890[ImageReceiverNative](#imagereceivernative), [OhosImageSize](_ohos_image_size.md)
891
892
893### OH_Image_Receiver_GetFormat()
894
895```
896int32_t OH_Image_Receiver_GetFormat (const ImageReceiverNative * native, int32_t * format )
897```
898
899**描述:**
900
901通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的格式。
902
903**参数:**
904
905| 名称 | 描述 |
906| -------- | -------- |
907| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
908| format | 作为结果的指向格式的指针。 |
909
910**返回:**
911
912参考[IRNdkErrCode](#irndkerrcode)。
913
914如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
915
916如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
917
918如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
919
920如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
921
922如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
923
924**起始版本:**
925
92610
927
928**参见:**
929
930[ImageReceiverNative](#imagereceivernative)
931
932
933### OH_Image_Receiver_GetReceivingSurfaceId()
934
935```
936int32_t OH_Image_Receiver_GetReceivingSurfaceId (const ImageReceiverNative * native, char * id, size_t len )
937```
938
939**描述:**
940
941通过[ImageReceiverNative](#imagereceivernative)获取receiver的id。
942
943**参数:**
944
945| 名称 | 描述 |
946| -------- | -------- |
947| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
948| id | 指向字符缓冲区的指针,用于获取字符串的id。 |
949| len | **id**所对应的字符缓冲区的大小。 |
950
951**返回:**
952
953参考[IRNdkErrCode](#irndkerrcode)。
954
955如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
956
957如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
958
959如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
960
961如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
962
963如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ;
964
965如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
966
967如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
968
969如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
970
971**起始版本:**
972
97310
974
975**参见:**
976
977[ImageReceiverNative](#imagereceivernative)
978
979
980### OH_Image_Receiver_GetSize()
981
982```
983int32_t OH_Image_Receiver_GetSize (const ImageReceiverNative * native, struct OhosImageSize * size )
984```
985
986**描述:**
987
988通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的大小。
989
990**参数:**
991
992| 名称 | 描述 |
993| -------- | -------- |
994| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
995| size | 作为结果的[OhosImageSize](_ohos_image_size.md)指针。 |
996
997**返回:**
998
999参考[IRNdkErrCode](#irndkerrcode)。
1000
1001如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1002
1003如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1004
1005如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1006
1007如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1008
1009如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
1010
1011**起始版本:**
1012
101310
1014
1015**参见:**
1016
1017[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)
1018
1019
1020### OH_Image_Receiver_InitImageReceiverNative()
1021
1022```
1023ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source )
1024```
1025
1026**描述:**
1027
1028通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](#imagereceivernative)对象。
1029
1030**参数:**
1031
1032| 名称 | 描述 |
1033| -------- | -------- |
1034| env | napi的环境指针。 |
1035| source | napi的 **ImageReceiver** 对象。 |
1036
1037**返回:**
1038
1039操作成功则返回 [ImageReceiverNative](#imagereceivernative) 指针;如果操作失败,则返回nullptr。
1040
1041**起始版本:**
1042
104310
1044
1045**参见:**
1046
1047[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_Release](#oh_image_receiver_release)
1048
1049
1050### OH_Image_Receiver_On()
1051
1052```
1053int32_t OH_Image_Receiver_On (const ImageReceiverNative * native, OH_Image_Receiver_On_Callback callback )
1054```
1055
1056**描述:**
1057
1058注册一个[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。
1059
1060**参数:**
1061
1062| 名称 | 描述 |
1063| -------- | -------- |
1064| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1065| callback | [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)事件的回调函数。 |
1066
1067**返回:**
1068
1069参考[IRNdkErrCode](#irndkerrcode)。
1070
1071如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1072
1073如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1074
1075如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1076
1077如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1078
1079如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ;
1080
1081如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1082
1083如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1084
1085如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1086
1087**起始版本:**
1088
108910
1090
1091**参见:**
1092
1093[ImageReceiverNative](#imagereceivernative)
1094
1095
1096### OH_Image_Receiver_ReadLatestImage()
1097
1098```
1099int32_t OH_Image_Receiver_ReadLatestImage (const ImageReceiverNative * native, napi_value * image )
1100```
1101
1102**描述:**
1103
1104通过[ImageReceiverNative](#imagereceivernative)获取最新的一张图片。
1105
1106**参数:**
1107
1108| 名称 | 描述 |
1109| -------- | -------- |
1110| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1111| image | 获取到的应用层的 **Image** 指针对象。 |
1112
1113**返回:**
1114
1115参考[IRNdkErrCode](#irndkerrcode)。
1116
1117如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1118
1119如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1120
1121如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1122
1123如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1124
1125如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ;
1126
1127如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
1128
1129如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
1130
1131如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1132
1133如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
1134
1135如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1136
1137如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1138
1139**起始版本:**
1140
114110
1142
1143**参见:**
1144
1145[ImageReceiverNative](#imagereceivernative)
1146
1147
1148### OH_Image_Receiver_ReadNextImage()
1149
1150```
1151int32_t OH_Image_Receiver_ReadNextImage (const ImageReceiverNative * native, napi_value * image )
1152```
1153
1154**描述:**
1155
1156通过[ImageReceiverNative](#imagereceivernative)获取下一张图片。
1157
1158**参数:**
1159
1160| 名称 | 描述 |
1161| -------- | -------- |
1162| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1163| image | 读取到的应用层的 **Image** 指针对象。 |
1164
1165**返回:**
1166
1167参考[IRNdkErrCode](#irndkerrcode)。
1168
1169如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1170
1171如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1172
1173如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1174
1175如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1176
1177如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ;
1178
1179如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ;
1180
1181如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ;
1182
1183如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ;
1184
1185如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ;
1186
1187如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
1188
1189如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。
1190
1191**起始版本:**
1192
119310
1194
1195**参见:**
1196
1197[ImageReceiverNative](#imagereceivernative)
1198
1199
1200### OH_Image_Receiver_Release()
1201
1202```
1203int32_t OH_Image_Receiver_Release (ImageReceiverNative * native)
1204```
1205
1206**描述:**
1207
1208释放native层 [ImageReceiverNative](#imagereceivernative) 对象。注意: 此方法不能释放应用层**ImageReceiver**对象。
1209
1210**参数:**
1211
1212| 名称 | 描述 |
1213| -------- | -------- |
1214| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 |
1215
1216**返回:**
1217
1218参考[IRNdkErrCode](#irndkerrcode)。
1219
1220如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
1221
1222如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
1223
1224如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
1225
1226如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
1227
1228**起始版本:**
1229
123010
1231
1232**参见:**
1233
1234[ImageReceiverNative](#imagereceivernative)
1235
1236
1237### OH_Image_Release()
1238
1239```
1240int32_t OH_Image_Release (ImageNative * native)
1241```
1242
1243**描述:**
1244
1245释放 **ImageNative** native对象。 Note: 这个方法无法释放 JavaScript Native API **Image** 对象, 而是释放被 **OH_Image_InitImageNative** 解析的 **ImageNative** native 对象。
1246
1247**参数:**
1248
1249| 名称 | 描述 |
1250| -------- | -------- |
1251| native | 表示 **ImageNative** native对象的指针。 |
1252
1253**返回:**
1254
1255参考[IRNdkErrCode](#irndkerrcode)。
1256
1257如果操作成功返回 IMAGE_RESULT_SUCCESS ;
1258
1259如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1260
1261如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
1262
1263如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
1264
1265**起始版本:**
1266
126710
1268
1269**参见:**
1270
1271ImageNative, OH_Image_InitImageNative
1272
1273
1274### OH_Image_Size()
1275
1276```
1277int32_t OH_Image_Size (const ImageNative * native, struct OhosImageSize * size )
1278```
1279
1280**描述:**
1281
1282获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。
1283
1284**参数:**
1285
1286| 名称 | 描述 |
1287| -------- | -------- |
1288| native | 表示 **ImageNative** native对象的指针。 |
1289| size | 表示作为转换结果的 [OhosImageSize](_ohos_image_size.md) 对象的指针。 |
1290
1291**返回:**
1292
1293参考[IRNdkErrCode](#irndkerrcode)。
1294
1295如果操作成功返回 IMAGE_RESULT_SUCCESS ;
1296
1297如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
1298
1299如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ;
1300
1301如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED;
1302
1303如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。
1304
1305**起始版本:**
1306
130710
1308
1309**参见:**
1310
1311ImageNative, [OhosImageSize](_ohos_image_size.md)
1312
1313
1314### OH_ImageSource_Create()
1315
1316```
1317int32_t OH_ImageSource_Create (napi_env env, struct OhosImageSource * src, struct OhosImageSourceOps * ops, napi_value * res )
1318```
1319
1320**描述:**
1321
1322通过给定的信息[OhosImageSource](_ohos_image_source.md) 和 [OhosImageSourceOps](_ohos_image_source_ops.md)结构体,获取JavaScript native层API** ImageSource**对象。
1323
1324\@Syscap SystemCapability.Multimedia.Image
1325
1326**参数:**
1327
1328| 名称 | 描述 |
1329| -------- | -------- |
1330| env | 表明JNI环境的指针。 |
1331| src | 表明创建一个图像源的信息。查看[OhosImageSource](_ohos_image_source.md)获取更多细节。 |
1332| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 |
1333| res | 表明JavaScript native层API**ImageSource**对象的指针。 |
1334
1335**返回:**
1336
1337参考[IRNdkErrCode](#irndkerrcode)。
1338
1339如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1340
1341如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1342
1343如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1344
1345如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1346
1347如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;
1348
1349如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;
1350
1351如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;
1352
1353如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;
1354
1355如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1356
1357如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1358
1359如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1360
1361如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;
1362
1363如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;
1364
1365如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;
1366
1367如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;
1368
1369如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;
1370
1371如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;
1372
1373如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。
1374
1375**起始版本:**
1376
137710
1378
1379**参见:**
1380
1381[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md)
1382
1383
1384### OH_ImageSource_CreateIncremental()
1385
1386```
1387int32_t OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource * source, struct OhosImageSourceOps * ops, napi_value * res )
1388```
1389
1390**描述:**
1391
1392通过给定的informations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过**OH_ImageSource_UpdateData**更新。
1393
1394\@Syscap SystemCapability.Multimedia.Image
1395
1396**参数:**
1397
1398| 名称 | 描述 |
1399| -------- | -------- |
1400| env | 表明JNI环境的指针。 |
1401| src | 表明创建一个图像源的信息。这里只接收缓冲区类型。查看[OhosImageSource](_ohos_image_source.md)获取更多细节 |
1402| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 |
1403| res | 表明JavaScript native层API**ImageSource**对象的指针。 |
1404
1405**返回:**
1406
1407参考[IRNdkErrCode](#irndkerrcode)。
1408
1409如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1410
1411如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1412
1413如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1414
1415如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1416
1417如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE;
1418
1419如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA;
1420
1421如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL;
1422
1423如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE;
1424
1425如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1426
1427如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1428
1429如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1430
1431如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST;
1432
1433如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED;
1434
1435如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR;
1436
1437如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR;
1438
1439如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED;
1440
1441如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED;
1442
1443如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。
1444
1445**起始版本:**
1446
144710
1448
1449**参见:**
1450
1451[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md), [OH_ImageSource_UpdateData](#oh_imagesource_updatedata)
1452
1453
1454### OH_ImageSource_CreatePixelMap()
1455
1456```
1457int32_t OH_ImageSource_CreatePixelMap (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )
1458```
1459
1460**描述:**
1461
1462通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象
1463
1464\@Syscap SystemCapability.Multimedia.Image
1465
1466**参数:**
1467
1468| 名称 | 描述 |
1469| -------- | -------- |
1470| native | 表明native层[ImageSourceNative](#imagesourcenative)值的指针。 |
1471| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 |
1472| res | 表明JavaScript native层API**PixelMap**对象的指针。 |
1473
1474**返回:**
1475
1476参考[IRNdkErrCode](#irndkerrcode)。
1477
1478如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1479
1480如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1481
1482如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1483
1484如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1485
1486如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1487
1488如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1489
1490如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1491
1492如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1493
1494如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
1495
1496如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
1497
1498如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1499
1500如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。
1501
1502如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
1503
1504如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
1505
1506如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL;
1507
1508如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
1509
1510如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1511
1512如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL;
1513
1514如果裁剪错误,返回 IMAGE_RESULT_CROP;
1515
1516如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1517
1518如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1519
1520如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1521
1522如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED;
1523
1524如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
1525
1526如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
1527
1528如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
1529
1530如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1531
1532如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
1533
1534如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。
1535
1536**起始版本:**
1537
153810
1539
1540**参见:**
1541
1542[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md)
1543
1544
1545### OH_ImageSource_CreatePixelMapList()
1546
1547```
1548int32_t OH_ImageSource_CreatePixelMapList (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res )
1549```
1550
1551**描述:**
1552
1553通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表
1554
1555\@Syscap SystemCapability.Multimedia.Image
1556
1557**参数:**
1558
1559| 名称 | 描述 |
1560| -------- | -------- |
1561| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1562| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 |
1563| res | 表明JavaScript native层API**PixelMap** 列表对象的指针。 |
1564
1565**返回:**
1566
1567参考[IRNdkErrCode](#irndkerrcode)。
1568
1569如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1570
1571如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1572
1573如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1574
1575如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1576
1577如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1578
1579如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1580
1581如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1582
1583如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1584
1585如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
1586
1587如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
1588
1589如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1590
1591如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1592
1593如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
1594
1595如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
1596
1597如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL;
1598
1599如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
1600
1601如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1602
1603如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL;
1604
1605如果裁剪错误,返回 IMAGE_RESULT_CROP;
1606
1607如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1608
1609如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1610
1611如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1612
1613如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED;
1614
1615如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
1616
1617如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
1618
1619如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
1620
1621如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1622
1623如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
1624
1625如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR;
1626
1627如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1628
1629如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1630
1631**起始版本:**
1632
163310
1634
1635**参见:**
1636
1637[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md)
1638
1639
1640### OH_ImageSource_GetDelayTime()
1641
1642```
1643int32_t OH_ImageSource_GetDelayTime (const ImageSourceNative * native, struct OhosImageSourceDelayTimeList * res )
1644```
1645
1646**描述:**
1647
1648从一些**ImageSource**(如GIF图像源)获取延迟时间列表。
1649
1650\@Syscap SystemCapability.Multimedia.Image
1651
1652**参数:**
1653
1654| 名称 | 描述 |
1655| -------- | -------- |
1656| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1657| res | 表明延迟时间列表 [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) 的指针。 当输入的res中**delayTimeList**是空指针并且**size**是0时,将通过res的**size**中返回延迟时间列表大小 为了获取延迟时间,需要比返回的**delayTimeList**大小值大的足够空间 |
1658
1659**返回:**
1660
1661参考[IRNdkErrCode](#irndkerrcode)。
1662
1663如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1664
1665如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1666
1667如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1668
1669如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1670
1671如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1672
1673如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1674
1675如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1676
1677如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1678
1679如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1680
1681如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1682
1683如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1684
1685如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1686
1687如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1688
1689如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1690
1691如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1692
1693如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1694
1695如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1696
1697如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1698
1699**起始版本:**
1700
170110
1702
1703**参见:**
1704
1705[ImageSourceNative](#imagesourcenative), [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md)
1706
1707
1708### OH_ImageSource_GetFrameCount()
1709
1710```
1711int32_t OH_ImageSource_GetFrameCount (const ImageSourceNative * native, uint32_t * res )
1712```
1713
1714**描述:**
1715
1716从**ImageSource**中获取帧计数。
1717
1718\@Syscap SystemCapability.Multimedia.Image
1719
1720**参数:**
1721
1722| 名称 | 描述 |
1723| -------- | -------- |
1724| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1725| res | 表明帧计数的指针。 |
1726
1727**返回:**
1728
1729参考[IRNdkErrCode](#irndkerrcode)。
1730
1731如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1732
1733如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1734
1735如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1736
1737如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1738
1739如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1740
1741如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1742
1743如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1744
1745如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1746
1747如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1748
1749如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1750
1751如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1752
1753如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1754
1755如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1756
1757如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1758
1759如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1760
1761如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1762
1763如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1764
1765如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1766
1767**起始版本:**
1768
176910
1770
1771**参见:**
1772
1773[ImageSourceNative](#imagesourcenative)
1774
1775
1776### OH_ImageSource_GetImageInfo()
1777
1778```
1779int32_t OH_ImageSource_GetImageInfo (const ImageSourceNative * native, int32_t index, struct OhosImageSourceInfo * info )
1780```
1781
1782**描述:**
1783
1784通过索引从**ImageSource**获取图像源信息。
1785
1786\@Syscap SystemCapability.Multimedia.Image
1787
1788**参数:**
1789
1790| 名称 | 描述 |
1791| -------- | -------- |
1792| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1793| index | 表明帧计数的指针。 |
1794| info | 表明图像源信息[OhosImageSourceInfo](_ohos_image_source_info.md)的指针。 |
1795
1796**返回:**
1797
1798参考[IRNdkErrCode](#irndkerrcode)。
1799
1800如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1801
1802如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1803
1804如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1805
1806如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1807
1808如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1809
1810如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1811
1812如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1813
1814如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1815
1816如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1817
1818如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1819
1820如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1821
1822如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1823
1824如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1825
1826如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1827
1828如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1829
1830如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1831
1832如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1833
1834如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1835
1836**起始版本:**
1837
183810
1839
1840**参见:**
1841
1842[ImageSourceNative](#imagesourcenative), [OhosImageSourceInfo](_ohos_image_source_info.md)
1843
1844
1845### OH_ImageSource_GetImageProperty()
1846
1847```
1848int32_t OH_ImageSource_GetImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )
1849```
1850
1851**描述:**
1852
1853通过关键字从**ImageSource**中获取图像源属性。
1854
1855\@Syscap SystemCapability.Multimedia.Image
1856
1857**参数:**
1858
1859| 名称 | 描述 |
1860| -------- | -------- |
1861| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
1862| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
1863| value | 表明作为结果的属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 当输入的value中**value**是空指针并且**size**是0时,将通过value中的**size**返回属性值的大小。 为了获取属性值,需要比**value**中的结果大小大的足够的空间。 |
1864
1865**返回:**
1866
1867参考[IRNdkErrCode](#irndkerrcode)。
1868
1869如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1870
1871如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1872
1873如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1874
1875如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1876
1877如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
1878
1879如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1880
1881如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
1882
1883如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
1884
1885如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
1886
1887如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
1888
1889如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
1890
1891如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
1892
1893如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
1894
1895如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
1896
1897如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
1898
1899如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
1900
1901如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
1902
1903如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
1904
1905**起始版本:**
1906
190710
1908
1909**参见:**
1910
1911[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md)
1912
1913
1914### OH_ImageSource_GetSupportedFormats()
1915
1916```
1917int32_t OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList * res)
1918```
1919
1920**描述:**
1921
1922获取所有支持的解码格式元标记。
1923
1924\@Syscap SystemCapability.Multimedia.Image
1925
1926**参数:**
1927
1928| 名称 | 描述 |
1929| -------- | -------- |
1930| 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)项目中的每个格式提供足够的空间。 |
1931
1932**返回:**
1933
1934参考[IRNdkErrCode](#irndkerrcode)。
1935
1936如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
1937
1938如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
1939
1940如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
1941
1942如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
1943
1944如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
1945
1946如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR。
1947
1948**起始版本:**
1949
195010
1951
1952**参见:**
1953
1954[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md), [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md)
1955
1956
1957### OH_ImageSource_InitNative()
1958
1959```
1960ImageSourceNative* OH_ImageSource_InitNative (napi_env env, napi_value source )
1961```
1962
1963**描述:**
1964
1965从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](#imagesourcenative)值。
1966
1967\@Syscap SystemCapability.Multimedia.Image
1968
1969**参数:**
1970
1971| 名称 | 描述 |
1972| -------- | -------- |
1973| env | 表明JNI环境的指针。 |
1974| source | 表明JavaScript native层API** ImageSource**对象的指针。 |
1975
1976**返回:**
1977
1978如果操作成功返回[ImageSourceNative](#imagesourcenative)指针;如果操作失败,返回空指针。
1979
1980**起始版本:**
1981
198210
1983
1984**参见:**
1985
1986[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Release](#oh_imagesource_release)
1987
1988
1989### OH_ImageSource_ModifyImageProperty()
1990
1991```
1992int32_t OH_ImageSource_ModifyImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value )
1993```
1994
1995**描述:**
1996
1997通过关键字为**ImageSource**修改图像源属性。
1998
1999\@Syscap SystemCapability.Multimedia.Image
2000
2001**参数:**
2002
2003| 名称 | 描述 |
2004| -------- | -------- |
2005| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针 |
2006| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
2007| value | 为了修改表明属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 |
2008
2009**返回:**
2010
2011参考[IRNdkErrCode](#irndkerrcode)。
2012
2013如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2014
2015如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2016
2017如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2018
2019如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2020
2021如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2022
2023如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
2024
2025如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
2026
2027如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
2028
2029如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
2030
2031如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
2032
2033如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL;
2034
2035如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
2036
2037如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
2038
2039如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
2040
2041如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
2042
2043如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
2044
2045如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT;
2046
2047如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。
2048
2049**起始版本:**
2050
205110
2052
2053**参见:**
2054
2055[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md)
2056
2057
2058### OH_ImageSource_Release()
2059
2060```
2061int32_t OH_ImageSource_Release (ImageSourceNative * native)
2062```
2063
2064**描述:**
2065
2066释放native层图像源 **ImageSourceNative**。
2067
2068\@Syscap SystemCapability.Multimedia.Image
2069
2070**参数:**
2071
2072| 名称 | 描述 |
2073| -------- | -------- |
2074| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
2075
2076**返回:**
2077
2078参考[IRNdkErrCode](#irndkerrcode)。
2079
2080如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2081
2082如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2083
2084如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2085
2086如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2087
2088如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2089
2090如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。
2091
2092**起始版本:**
2093
209410
2095
2096**参见:**
2097
2098[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Create](#oh_imagesource_create), [OH_ImageSource_CreateIncremental](#oh_imagesource_createincremental)
2099
2100
2101### OH_ImageSource_UpdateData()
2102
2103```
2104int32_t OH_ImageSource_UpdateData (const ImageSourceNative * native, struct OhosImageSourceUpdateData * data )
2105```
2106
2107**描述:**
2108
2109为了增量类型的**ImageSource**更新源数据。
2110
2111\@Syscap SystemCapability.Multimedia.Image
2112
2113**参数:**
2114
2115| 名称 | 描述 |
2116| -------- | -------- |
2117| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 |
2118| data | 表明更新数据信息[OhosImageSourceUpdateData](_ohos_image_source_update_data.md)的指针。 |
2119
2120**返回:**
2121
2122参考[IRNdkErrCode](#irndkerrcode)。
2123
2124如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS;
2125
2126如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER;
2127
2128如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL;
2129
2130如果参数无效,IMAGE_RESULT_INVALID_PARAMETER;
2131
2132如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL;
2133
2134如果解码失败,返回IMAGE_RESULT_DECODE_FAILED;
2135
2136如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL;
2137
2138如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED;
2139
2140如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED;
2141
2142如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2143
2144如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR;
2145
2146如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL;
2147
2148如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST;
2149
2150如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL;
2151
2152如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL;
2153
2154如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL;
2155
2156如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT;
2157
2158如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL;
2159
2160如果裁剪错误,返回 IMAGE_RESULT_CROP;
2161
2162如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT;
2163
2164如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED;
2165
2166如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED;
2167
2168如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED;
2169
2170如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT;
2171
2172如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED;
2173
2174如果ipc失败,返回 IMAGE_RESULT_ERR_IPC;
2175
2176如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID;
2177
2178如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR;
2179
2180如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。
2181
2182**起始版本:**
2183
218410
2185
2186**参见:**
2187
2188[ImageSourceNative](#imagesourcenative), [OhosImageSourceUpdateData](_ohos_image_source_update_data.md)
2189
2190
2191### OH_PixelMap_AccessPixels()
2192
2193```
2194int32_t OH_PixelMap_AccessPixels (const NativePixelMap * native, void ** addr )
2195```
2196
2197**描述:**
2198
2199获取native **PixelMap** 对象数据的内存地址,并锁定该内存。
2200
2201**参数:**
2202
2203| 名称 | 描述 |
2204| -------- | -------- |
2205| native | NativePixelMap的指针。 |
2206| addr | 用于指向的内存地址的双指针对象。 |
2207
2208**返回:**
2209
2210参考[IRNdkErrCode](#irndkerrcode)。
2211
2212如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2213
2214如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2215
2216如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2217
2218如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2219
2220如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2221
2222如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2223
2224如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2225
2226如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2227
2228如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2229
2230如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2231
2232如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2233
2234如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2235
2236如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2237
2238如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2239
2240如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2241
2242如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2243
2244如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2245
2246如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2247
2248如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2249
2250如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2251
2252**起始版本:**
2253
225410
2255
2256**参见:**
2257
2258AccessPixels
2259
2260
2261### OH_PixelMap_CreateAlphaPixelMap()
2262
2263```
2264int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value * alpha )
2265```
2266
2267**描述:**
2268
2269根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。
2270
2271**参数:**
2272
2273| 名称 | 描述 |
2274| -------- | -------- |
2275| env | napi的环境指针。 |
2276| source | **PixelMap**数据设置项。 |
2277| alpha | alpha通道的指针。 |
2278
2279**返回:**
2280
2281参考[IRNdkErrCode](#irndkerrcode)。
2282
2283如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2284
2285如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2286
2287如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2288
2289如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2290
2291如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2292
2293如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2294
2295如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ;
2296
2297如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ;
2298
2299如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ;
2300
2301如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2302
2303如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2304
2305如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2306
2307如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2308
2309如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2310
2311如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ;
2312
2313如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2314
2315如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2316
2317如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2318
2319如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2320
2321如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2322
2323如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2324
2325如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2326
2327如果图像添加像素位图失败则返回 IMAGE_RESULT_ENCODE_FAILED ;
2328
2329如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ;
2330
2331如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ;
2332
2333如果ipc失败则返回 IMAGE_RESULT_INDEX_INVALID ;
2334
2335如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2336
2337如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2338
2339如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2340
2341**起始版本:**
2342
234310
2344
2345**参见:**
2346
2347CreateAlphaPixelMap
2348
2349
2350### OH_PixelMap_CreatePixelMap()
2351
2352```
2353int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void * buf, size_t len, napi_value * res )
2354```
2355
2356**描述:**
2357
2358Creates a **PixelMap** object.
2359
2360**参数:**
2361
2362| 名称 | 描述 |
2363| -------- | -------- |
2364| env | napi的环境指针。 |
2365| info | pixel map 数据设置项。 |
2366| buf | 图片的buffer数据。 |
2367| len | 图片大小信息。 |
2368| res | 应用层的 **PixelMap** 对象的指针。 |
2369
2370**返回:**
2371
2372参考[IRNdkErrCode](#irndkerrcode)。
2373
2374如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2375
2376如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2377
2378如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2379
2380如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2381
2382如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2383
2384如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2385
2386如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ;
2387
2388如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ;
2389
2390如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ;
2391
2392如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2393
2394如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2395
2396如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2397
2398如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2399
2400如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2401
2402如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ;
2403
2404如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2405
2406如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2407
2408如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2409
2410如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2411
2412如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2413
2414如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2415
2416如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2417
2418如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2419
2420如果图像添加像素位图失败则返回 IMAGE_RESULT_ENCODE_FAILED ;
2421
2422如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ;
2423
2424如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ;
2425
2426如果ipc失败则返回 IMAGE_RESULT_INDEX_INVALID ;
2427
2428如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2429
2430如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2431
2432如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2433
2434**起始版本:**
2435
243610
2437
2438**参见:**
2439
2440CreatePixelMap
2441
2442
2443### OH_PixelMap_Crop()
2444
2445```
2446int32_t OH_PixelMap_Crop (const NativePixelMap * native, int32_t x, int32_t y, int32_t width, int32_t height )
2447```
2448
2449**描述:**
2450
2451设置**PixelMap**对象的裁剪。
2452
2453**参数:**
2454
2455| 名称 | 描述 |
2456| -------- | -------- |
2457| native | NativePixelMap的指针。 |
2458| x | 目标图片左上角的x坐标。 |
2459| y | 目标图片左上角的y坐标。 |
2460| width | 裁剪区域的宽度。 |
2461| height | 裁剪区域的高度。 |
2462
2463**返回:**
2464
2465参考[IRNdkErrCode](#irndkerrcode)。
2466
2467如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2468
2469如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2470
2471如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2472
2473如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2474
2475如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2476
2477如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2478
2479如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2480
2481如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2482
2483如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2484
2485如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2486
2487如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2488
2489如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2490
2491如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2492
2493如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2494
2495如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2496
2497如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2498
2499如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2500
2501如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2502
2503如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2504
2505如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2506
2507**起始版本:**
2508
250910
2510
2511**参见:**
2512
2513Crop
2514
2515
2516### OH_PixelMap_Flip()
2517
2518```
2519int32_t OH_PixelMap_Flip (const NativePixelMap * native, int32_t x, int32_t y )
2520```
2521
2522**描述:**
2523
2524设置**PixelMap**对象的翻转。
2525
2526**参数:**
2527
2528| 名称 | 描述 |
2529| -------- | -------- |
2530| native | NativePixelMap的指针。 |
2531| x | 根据水平方向x轴进行图片翻转。 |
2532| y | 根据垂直方向y轴进行图片翻转。 |
2533
2534**返回:**
2535
2536参考[IRNdkErrCode](#irndkerrcode)。
2537
2538如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2539
2540如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2541
2542如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2543
2544如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2545
2546如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2547
2548如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2549
2550如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2551
2552如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2553
2554如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2555
2556如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2557
2558如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2559
2560如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2561
2562如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2563
2564如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2565
2566如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2567
2568如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2569
2570如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2571
2572如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2573
2574如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2575
2576如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2577
2578**起始版本:**
2579
258010
2581
2582**参见:**
2583
2584Flip
2585
2586
2587### OH_PixelMap_GetBytesNumberPerRow()
2588
2589```
2590int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap * native, int32_t * num )
2591```
2592
2593**描述:**
2594
2595获取**PixelMap**对象每行字节数。
2596
2597**参数:**
2598
2599| 名称 | 描述 |
2600| -------- | -------- |
2601| native | NativePixelMap的指针。 |
2602| num | **PixelMap**对象的每行字节数指针。 |
2603
2604**返回:**
2605
2606参考[IRNdkErrCode](#irndkerrcode)。
2607
2608如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2609
2610如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2611
2612如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2613
2614如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2615
2616如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2617
2618如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
2619
2620**起始版本:**
2621
262210
2623
2624**参见:**
2625
2626GetBytesNumberPerRow
2627
2628
2629### OH_PixelMap_GetDensity()
2630
2631```
2632int32_t OH_PixelMap_GetDensity (const NativePixelMap * native, int32_t * density )
2633```
2634
2635**描述:**
2636
2637获取**PixelMap**对象像素密度。
2638
2639**参数:**
2640
2641| 名称 | 描述 |
2642| -------- | -------- |
2643| native | NativePixelMap的指针。 |
2644| density | 像素密度指针。 |
2645
2646**返回:**
2647
2648参考[IRNdkErrCode](#irndkerrcode)。
2649
2650如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2651
2652如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2653
2654如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2655
2656如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2657
2658如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2659
2660如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
2661
2662**起始版本:**
2663
266410
2665
2666**参见:**
2667
2668GetDensity
2669
2670
2671### OH_PixelMap_GetImageInfo()
2672
2673```
2674int32_t OH_PixelMap_GetImageInfo (const NativePixelMap * native, OhosPixelMapInfos * info )
2675```
2676
2677**描述:**
2678
2679获取**PixelMap**对象图像信息。
2680
2681**参数:**
2682
2683| 名称 | 描述 |
2684| -------- | -------- |
2685| native | NativePixelMap的指针。 |
2686| info | 图像信息指针。 |
2687
2688**返回:**
2689
2690参考[IRNdkErrCode](#irndkerrcode)。
2691
2692如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2693
2694如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2695
2696如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2697
2698如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2699
2700如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2701
2702如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2703
2704如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2705
2706如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2707
2708如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2709
2710如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2711
2712如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2713
2714如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2715
2716如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2717
2718如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2719
2720如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2721
2722如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2723
2724如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2725
2726如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2727
2728如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2729
2730如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2731
2732**起始版本:**
2733
273410
2735
2736**参见:**
2737
2738[OhosPixelMapInfos](_ohos_pixel_map_infos.md)
2739
2740
2741### OH_PixelMap_GetIsEditable()
2742
2743```
2744int32_t OH_PixelMap_GetIsEditable (const NativePixelMap * native, int32_t * editable )
2745```
2746
2747**描述:**
2748
2749获取**PixelMap**对象是否可编辑的状态。
2750
2751**参数:**
2752
2753| 名称 | 描述 |
2754| -------- | -------- |
2755| native | NativePixelMap的指针。 |
2756| editable | **PixelMap** 对象是否可编辑的指针。 |
2757
2758**返回:**
2759
2760参考[IRNdkErrCode](#irndkerrcode)。
2761
2762如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2763
2764如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2765
2766如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2767
2768如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2769
2770如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2771
2772如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
2773
2774**起始版本:**
2775
277610
2777
2778**参见:**
2779
2780GetIsEditable
2781
2782
2783### OH_PixelMap_InitNativePixelMap()
2784
2785```
2786NativePixelMap* OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source )
2787```
2788
2789**描述:**
2790
2791初始化**PixelMap**对象数据。
2792
2793**参数:**
2794
2795| 名称 | 描述 |
2796| -------- | -------- |
2797| env | napi的环境指针。 |
2798| source | **PixelMap** 数据设置项。 |
2799
2800**返回:**
2801
2802操作成功则返回NativePixelMap的指针;如果操作失败,则返回错误码。
2803
2804**起始版本:**
2805
280610
2807
2808**参见:**
2809
2810InitNativePixelMap
2811
2812
2813### OH_PixelMap_IsSupportAlpha()
2814
2815```
2816int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap * native, int32_t * alpha )
2817```
2818
2819**描述:**
2820
2821获取**PixelMap**对象是否支持Alpha通道。
2822
2823**参数:**
2824
2825| 名称 | 描述 |
2826| -------- | -------- |
2827| native | NativePixelMap的指针。 |
2828| alpha | 是否支持Alpha的指针。 |
2829
2830**返回:**
2831
2832参考[IRNdkErrCode](#irndkerrcode)。
2833
2834如果操作成功则返回 IMAGE_RESULT_SUCCESS;
2835
2836如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2837
2838如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2839
2840如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2841
2842如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2843
2844如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
2845
2846**起始版本:**
2847
284810
2849
2850**参见:**
2851
2852IsSupportAlpha
2853
2854
2855### OH_PixelMap_Rotate()
2856
2857```
2858int32_t OH_PixelMap_Rotate (const NativePixelMap * native, float angle )
2859```
2860
2861**描述:**
2862
2863设置**PixelMap**对象的旋转。
2864
2865**参数:**
2866
2867| 名称 | 描述 |
2868| -------- | -------- |
2869| native | NativePixelMap的指针。 |
2870| angle | 旋转角度。 |
2871
2872**返回:**
2873
2874参考[IRNdkErrCode](#irndkerrcode)。
2875
2876如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2877
2878如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2879
2880如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2881
2882如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2883
2884如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2885
2886如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2887
2888如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2889
2890如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2891
2892如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2893
2894如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2895
2896如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2897
2898如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2899
2900如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2901
2902如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2903
2904如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2905
2906如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2907
2908如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2909
2910如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2911
2912如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2913
2914如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2915
2916**起始版本:**
2917
291810
2919
2920**参见:**
2921
2922Rotate
2923
2924
2925### OH_PixelMap_Scale()
2926
2927```
2928int32_t OH_PixelMap_Scale (const NativePixelMap * native, float x, float y )
2929```
2930
2931**描述:**
2932
2933设置**PixelMap**对象的缩放。
2934
2935**参数:**
2936
2937| 名称 | 描述 |
2938| -------- | -------- |
2939| native | NativePixelMap的指针。 |
2940| x | 缩放宽度。 |
2941| y | 缩放高度。 |
2942
2943**返回:**
2944
2945参考[IRNdkErrCode](#irndkerrcode)。
2946
2947如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
2948
2949如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
2950
2951如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
2952
2953如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
2954
2955如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
2956
2957如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
2958
2959如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
2960
2961如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
2962
2963如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
2964
2965如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
2966
2967如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
2968
2969如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
2970
2971如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2972
2973如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ;
2974
2975如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
2976
2977如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
2978
2979如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
2980
2981如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
2982
2983如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
2984
2985如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
2986
2987如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
2988
2989**起始版本:**
2990
299110
2992
2993**参见:**
2994
2995Scale
2996
2997
2998### OH_PixelMap_SetAlphaAble()
2999
3000```
3001int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap * native, int32_t alpha )
3002```
3003
3004**描述:**
3005
3006设置**PixelMap**对象的Alpha通道。
3007
3008**参数:**
3009
3010| 名称 | 描述 |
3011| -------- | -------- |
3012| native | NativePixelMap的指针。 |
3013| alpha | Alpha通道。 |
3014
3015**返回:**
3016
3017参考[IRNdkErrCode](#irndkerrcode)。
3018
3019如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3020
3021如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3022
3023如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3024
3025如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3026
3027如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3028
3029如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
3030
3031**起始版本:**
3032
303310
3034
3035**参见:**
3036
3037SetAlphaAble
3038
3039
3040### OH_PixelMap_SetDensity()
3041
3042
3043```
3044int32_t OH_PixelMap_SetDensity (const NativePixelMap * native, int32_t density )
3045```
3046
3047**描述:**
3048
3049设置**PixelMap**对象像素密度。
3050
3051**参数:**
3052
3053| 名称 | 描述 |
3054| -------- | -------- |
3055| native | NativePixelMap的指针。 |
3056| density | 像素密度。 |
3057
3058**返回:**
3059
3060参考[IRNdkErrCode](#irndkerrcode)。
3061
3062如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3063
3064如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3065
3066如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3067
3068如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3069
3070如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3071
3072如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
3073
3074**起始版本:**
3075
307610
3077
3078**参见:**
3079
3080GetDensity
3081
3082
3083### OH_PixelMap_SetOpacity()
3084
3085```
3086int32_t OH_PixelMap_SetOpacity (const NativePixelMap * native, float opacity )
3087```
3088
3089**描述:**
3090
3091设置**PixelMap**对象的透明度。
3092
3093**参数:**
3094
3095| 名称 | 描述 |
3096| -------- | -------- |
3097| native | NativePixelMap的指针。 |
3098| opacity | 透明度。 |
3099
3100**返回:**
3101
3102参考[IRNdkErrCode](#irndkerrcode)。
3103
3104如果操作成功则返回 IMAGE_RESULT_SUCCESS;
3105
3106如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3107
3108如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3109
3110如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3111
3112如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3113
3114如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。
3115
3116**起始版本:**
3117
311810
3119
3120**参见:**
3121
3122SetOpacity
3123
3124
3125### OH_PixelMap_Translate()
3126
3127```
3128int32_t OH_PixelMap_Translate (const NativePixelMap * native, float x, float y )
3129```
3130
3131**描述:**
3132
3133设置**PixelMap**对象的偏移。
3134
3135**参数:**
3136
3137| 名称 | 描述 |
3138| -------- | -------- |
3139| native | NativePixelMap的指针。 |
3140| x | 水平偏移量。 |
3141| y | 垂直偏移量。 |
3142
3143**返回:**
3144
3145参考[IRNdkErrCode](#irndkerrcode)。
3146
3147如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
3148
3149如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3150
3151如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3152
3153如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3154
3155如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
3156
3157如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
3158
3159如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
3160
3161如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
3162
3163如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3164
3165如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
3166
3167如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
3168
3169如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
3170
3171如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3172
3173如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
3174
3175如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
3176
3177如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
3178
3179如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
3180
3181如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3182
3183如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
3184
3185如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
3186
3187**起始版本:**
3188
318910
3190
3191**参见:**
3192
3193Translate
3194
3195
3196### OH_PixelMap_UnAccessPixels()
3197
3198```
3199int32_t OH_PixelMap_UnAccessPixels (const NativePixelMap * native)
3200```
3201
3202**描述:**
3203
3204释放native **PixelMap**对象数据的内存锁,用于匹配方法[OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels)。
3205
3206**参数:**
3207
3208| 名称 | 描述 |
3209| -------- | -------- |
3210| native | NativePixelMap的指针。 |
3211
3212**返回:**
3213
3214参考[IRNdkErrCode](#irndkerrcode)。
3215
3216如果操作成功则返回 IMAGE_RESULT_SUCCESS ;
3217
3218如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ;
3219
3220如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ;
3221
3222如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ;
3223
3224如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ;
3225
3226如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ;
3227
3228如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ;
3229
3230如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ;
3231
3232如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ;
3233
3234如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ;
3235
3236如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ;
3237
3238如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ;
3239
3240如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3241
3242如果裁剪失败失败则返回 IMAGE_RESULT_CROP ;
3243
3244如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ;
3245
3246如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ;
3247
3248如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ;
3249
3250如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ;
3251
3252如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ;
3253
3254如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。
3255
3256**起始版本:**
3257
325810
3259
3260**参见:**
3261
3262UnAccessPixels
3263
3264
3265### OH_UnAccessPixels()
3266
3267```
3268int32_t OHOS::Media::OH_UnAccessPixels (napi_env env, napi_value value )
3269```
3270
3271**描述:**
3272
3273释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。
3274
3275**参数:**
3276
3277| 名称 | 描述 |
3278| -------- | -------- |
3279| env | napi的环境指针。 |
3280| value | 应用层的 **PixelMap** 对象。 |
3281
3282**返回:**
3283
3284操作成功则返回 **OHOS_IMAGE_RESULT_SUCCESS**;如果操作失败,则返回错误码。
3285
3286**起始版本:**
3287
32888
3289
3290**废弃起始版本:**
3291
329210
3293
3294**参见:**
3295
3296AccessPixels
3297
3298
3299## 变量说明
3300
3301
3302### alphaType
3303
3304```
3305int32_t OhosImageSourceInfo::alphaType
3306```
3307
3308**描述:**
3309
3310图像源透明度类型
3311
3312**起始版本:**
3313
331410
3315
3316
3317### buffer [1/2]
3318
3319```
3320uint8_t* OhosImageSource::buffer = nullptr
3321```
3322
3323**描述:**
3324
3325图像源缓冲区资源,解手格式化包缓冲区或者base64缓冲区
3326
3327**起始版本:**
3328
332910
3330
3331
3332### buffer [2/2]
3333
3334```
3335uint8_t* OhosImageSourceUpdateData::buffer = nullptr
3336```
3337
3338**描述:**
3339
3340图像源更新数据缓冲区
3341
3342**起始版本:**
3343
334410
3345
3346
3347### bufferSize [1/2]
3348
3349```
3350size_t OhosImageSource::bufferSize = 0
3351```
3352
3353**描述:**
3354
3355图像源缓冲区资源大小
3356
3357**起始版本:**
3358
335910
3360
3361
3362### bufferSize [2/2]
3363
3364```
3365size_t OhosImageSourceUpdateData::bufferSize = 0
3366```
3367
3368**描述:**
3369
3370图像源更新数据缓冲区大小
3371
3372**起始版本:**
3373
337410
3375
3376
3377### colorSpace
3378
3379```
3380int32_t OhosImageSourceInfo::colorSpace
3381```
3382
3383**描述:**
3384
3385图像源色彩空间
3386
3387**起始版本:**
3388
338910
3390
3391
3392### delayTimeList
3393
3394```
3395int32_t* OhosImageSourceDelayTimeList::delayTimeList
3396```
3397
3398**描述:**
3399
3400图像源延迟时间列表头地址
3401
3402**起始版本:**
3403
340410
3405
3406
3407### density [1/2]
3408
3409```
3410int32_t OhosImageSourceOps::density
3411```
3412
3413**描述:**
3414
3415图像源像素密度
3416
3417**起始版本:**
3418
341910
3420
3421
3422### density [2/2]
3423
3424```
3425int32_t OhosImageSourceInfo::density
3426```
3427
3428**描述:**
3429
3430图像源密度, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置
3431
3432**起始版本:**
3433
343410
3435
3436
3437### editable
3438
3439```
3440int8_t OhosImageDecodingOps::editable
3441```
3442
3443**描述:**
3444
3445定义输出的像素位图是否可编辑
3446
3447**起始版本:**
3448
344910
3450
3451
3452### fd
3453
3454```
3455int32_t OhosImageSource::fd = -1
3456```
3457
3458**描述:**
3459
3460图像源文件资源描述符
3461
3462**起始版本:**
3463
346410
3465
3466
3467### fitDensity
3468
3469```
3470int32_t OhosImageDecodingOps::fitDensity
3471```
3472
3473**描述:**
3474
3475定义解码目标的像素密度
3476
3477**起始版本:**
3478
347910
3480
3481
3482### format
3483
3484```
3485char* OhosImageSourceSupportedFormat::format = nullptr
3486```
3487
3488**描述:**
3489
3490图像源支持的格式字符串头地址
3491
3492**起始版本:**
3493
349410
3495
3496
3497### height
3498
3499```
3500int32_t OhosImageRegion::height
3501```
3502
3503**描述:**
3504
3505高度范围,用pixels表示
3506
3507**起始版本:**
3508
350910
3510
3511
3512### index
3513
3514```
3515uint32_t OhosImageDecodingOps::index
3516```
3517
3518**描述:**
3519
3520定义图像源解码指数
3521
3522**起始版本:**
3523
352410
3525
3526
3527### isCompleted
3528
3529```
3530int8_t OhosImageSourceUpdateData::isCompleted = 0
3531```
3532
3533**描述:**
3534
3535图像源更新数据在此节中完成
3536
3537**起始版本:**
3538
353910
3540
3541
3542### offset
3543
3544```
3545uint32_t OhosImageSourceUpdateData::offset = 0
3546```
3547
3548**描述:**
3549
3550图像源更新数据缓冲区的开端
3551
3552**起始版本:**
3553
355410
3555
3556
3557### OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE
3558
3559```
3560const char* OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample"
3561```
3562
3563**描述:**
3564
3565定义每个样本比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3566
3567\@Syscap SystemCapability.Multimedia.Image
3568
3569**起始版本:**
3570
357110
3572
3573
3574### OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL
3575
3576```
3577const char* OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel"
3578```
3579
3580**描述:**
3581
3582定义每个像素的压缩比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3583
3584\@Syscap SystemCapability.Multimedia.Image
3585
3586**起始版本:**
3587
358810
3589
3590
3591### OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL
3592
3593```
3594const char* OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal"
3595```
3596
3597**描述:**
3598
3599定义初始日期时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3600
3601\@Syscap SystemCapability.Multimedia.Image
3602
3603**起始版本:**
3604
360510
3606
3607
3608### OHOS_IMAGE_PROPERTY_EXPOSURE_TIME
3609
3610```
3611const char* OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime"
3612```
3613
3614**描述:**
3615
3616定义曝光时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3617
3618\@Syscap SystemCapability.Multimedia.Image
3619
3620**起始版本:**
3621
362210
3623
3624
3625### OHOS_IMAGE_PROPERTY_F_NUMBER
3626
3627```
3628const char* OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber"
3629```
3630
3631**描述:**
3632
3633定义FNumber的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3634
3635\@Syscap SystemCapability.Multimedia.Image
3636
3637**起始版本:**
3638
363910
3640
3641
3642### OHOS_IMAGE_PROPERTY_GPS_LATITUDE
3643
3644```
3645const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude"
3646```
3647
3648**描述:**
3649
3650定义GPS纬度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3651
3652\@Syscap SystemCapability.Multimedia.Image
3653
3654**起始版本:**
3655
365610
3657
3658
3659### OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF
3660
3661```
3662const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef"
3663```
3664
3665**描述:**
3666
3667定义GPS纬度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3668
3669\@Syscap SystemCapability.Multimedia.Image
3670
3671**起始版本:**
3672
367310
3674
3675
3676### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE
3677
3678```
3679const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude"
3680```
3681
3682**描述:**
3683
3684定义GPS经度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3685
3686\@Syscap SystemCapability.Multimedia.Image
3687
3688**起始版本:**
3689
369010
3691
3692
3693### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF
3694
3695```
3696const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef"
3697```
3698
3699**描述:**
3700
3701定义GPS经度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3702
3703\@Syscap SystemCapability.Multimedia.Image
3704
3705**起始版本:**
3706
370710
3708
3709
3710### OHOS_IMAGE_PROPERTY_IMAGE_LENGTH
3711
3712```
3713const char* OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength"
3714```
3715
3716**描述:**
3717
3718定义图像长度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3719
3720\@Syscap SystemCapability.Multimedia.Image
3721
3722**起始版本:**
3723
372410
3725
3726
3727### OHOS_IMAGE_PROPERTY_IMAGE_WIDTH
3728
3729```
3730const char* OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth"
3731```
3732
3733**描述:**
3734
3735定义图像宽度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3736
3737\@Syscap SystemCapability.Multimedia.Image
3738
3739**起始版本:**
3740
374110
3742
3743
3744### OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS
3745
3746```
3747const char* OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings"
3748```
3749
3750**描述:**
3751
3752定义ISO速度等级的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3753
3754\@Syscap SystemCapability.Multimedia.Image
3755
3756**起始版本:**
3757
375810
3759
3760
3761### OHOS_IMAGE_PROPERTY_ORIENTATION
3762
3763```
3764const char* OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation"
3765```
3766
3767**描述:**
3768
3769定义方向的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3770
3771\@Syscap SystemCapability.Multimedia.Image
3772
3773**起始版本:**
3774
377510
3776
3777
3778### OHOS_IMAGE_PROPERTY_SCENE_TYPE
3779
3780```
3781const char* OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType"
3782```
3783
3784**描述:**
3785
3786定义场景类型的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。
3787
3788\@Syscap SystemCapability.Multimedia.Image
3789
3790**起始版本:**
3791
379210
3793
3794
3795### pixelFormat [1/3]
3796
3797```
3798int32_t OhosImageSourceOps::pixelFormat
3799```
3800
3801**描述:**
3802
3803图像源像素格式,通常用于描述YUV缓冲区
3804
3805**起始版本:**
3806
380710
3808
3809
3810### pixelFormat [2/3]
3811
3812```
3813int32_t OhosImageDecodingOps::pixelFormat
3814```
3815
3816**描述:**
3817
3818定义输出的像素格式
3819
3820**起始版本:**
3821
382210
3823
3824
3825### pixelFormat [3/3]
3826
3827```
3828int32_t OhosImageSourceInfo::pixelFormat
3829```
3830
3831**描述:**
3832
3833图像源像素格式, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置
3834
3835**起始版本:**
3836
383710
3838
3839
3840### region
3841
3842```
3843struct OhosImageRegion OhosImageDecodingOps::region
3844```
3845
3846**描述:**
3847
3848定义图像源解码的像素范围
3849
3850**起始版本:**
3851
385210
3853
3854
3855### rotate
3856
3857```
3858uint32_t OhosImageDecodingOps::rotate
3859```
3860
3861**描述:**
3862
3863定义解码旋转选项
3864
3865**起始版本:**
3866
386710
3868
3869
3870### sampleSize
3871
3872```
3873uint32_t OhosImageDecodingOps::sampleSize
3874```
3875
3876**描述:**
3877
3878定义解码样本大小选项
3879
3880**起始版本:**
3881
388210
3883
3884
3885### size [1/7]
3886
3887```
3888struct OhosImageSize OhosImageSourceOps::size
3889```
3890
3891**描述:**
3892
3893图像源像素宽高的大小
3894
3895**起始版本:**
3896
389710
3898
3899
3900### size [2/7]
3901
3902```
3903struct OhosImageSize OhosImageDecodingOps::size
3904```
3905
3906**描述:**
3907
3908定义解码目标像素宽高的大小
3909
3910**起始版本:**
3911
391210
3913
3914
3915### size [3/7]
3916
3917```
3918struct OhosImageSize OhosImageSourceInfo::size
3919```
3920
3921**描述:**
3922
3923图像源像素宽高的大小
3924
3925**起始版本:**
3926
392710
3928
3929
3930### size [4/7]
3931
3932```
3933size_t OhosImageSourceDelayTimeList::size = 0
3934```
3935
3936**描述:**
3937
3938图像源延迟时间列表大小
3939
3940**起始版本:**
3941
394210
3943
3944
3945### size [5/7]
3946
3947```
3948size_t OhosImageSourceSupportedFormat::size = 0
3949```
3950
3951**描述:**
3952
3953图像源支持的格式字符串大小
3954
3955**起始版本:**
3956
395710
3958
3959
3960### size [6/7]
3961
3962```
3963size_t OhosImageSourceSupportedFormatList::size = 0
3964```
3965
3966**描述:**
3967
3968图像源支持的格式字符串列表大小
3969
3970**起始版本:**
3971
397210
3973
3974
3975### size [7/7]
3976
3977```
3978size_t OhosImageSourceProperty::size = 0
3979```
3980
3981**描述:**
3982
3983定义图像源属性键值字符串大小
3984
3985**起始版本:**
3986
398710
3988
3989
3990### supportedFormatList
3991
3992```
3993struct OhosImageSourceSupportedFormat** OhosImageSourceSupportedFormatList::supportedFormatList = nullptr
3994```
3995
3996**描述:**
3997
3998图像源支持的格式字符串列表头地址
3999
4000**起始版本:**
4001
400210
4003
4004
4005### updateLength
4006
4007```
4008uint32_t OhosImageSourceUpdateData::updateLength = 0
4009```
4010
4011**描述:**
4012
4013图像源更新数据缓冲区的更新数据长度
4014
4015**起始版本:**
4016
401710
4018
4019
4020### uri
4021
4022```
4023char* OhosImageSource::uri = nullptr
4024```
4025
4026**描述:**
4027
4028图像源资源标识符,接受文件资源或者base64资源
4029
4030**起始版本:**
4031
403210
4033
4034
4035### uriSize
4036
4037```
4038size_t OhosImageSource::uriSize = 0
4039```
4040
4041**描述:**
4042
4043图像源资源长度
4044
4045**起始版本:**
4046
404710
4048
4049
4050### value
4051
4052```
4053char* OhosImageSourceProperty::value = nullptr
4054```
4055
4056**描述:**
4057
4058定义图像源属性键值字符串头地址
4059
4060**起始版本:**
4061
406210
4063
4064
4065### width
4066
4067```
4068int32_t OhosImageRegion::width
4069```
4070
4071**描述:**
4072
4073宽度范围,用pixels表示
4074
4075**起始版本:**
4076
407710
4078
4079
4080### x
4081
4082```
4083int32_t OhosImageRegion::x
4084```
4085
4086**描述:**
4087
4088起始x坐标,用pixels表示
4089
4090**起始版本:**
4091
409210
4093
4094
4095### y
4096
4097```
4098int32_t OhosImageRegion::y
4099```
4100
4101**描述:**
4102
4103起始y坐标,用pixels表示
4104
4105**起始版本:**
4106
410710
4108
4109