diff --git a/zh-cn/application-dev/reference/native-apis/Readme-CN.md b/zh-cn/application-dev/reference/native-apis/Readme-CN.md index a6977d524d55b1b23ba6590705a5426858d7a858..ca14570f8c6c8989b36fa8fc5ee57f81de78a93f 100644 --- a/zh-cn/application-dev/reference/native-apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/native-apis/Readme-CN.md @@ -44,7 +44,12 @@ - [drawing_text_typography.h](drawing__text__typography_8h.md) - [drawing_types.h](drawing__types_8h.md) - [external_window.h](external__window_8h.md) + - [image_mdk.h](image__mdk_8h.md) + - [image_mdk_common.h](image__mdk__common_8h.md) + - [image_pixel_map_mdk.h](image__pixel__map__mdk_8h.md) - [image_pixel_map_napi.h](image__pixel__map__napi_8h.md) + - [image_receiver_mdk.h](image__receiver__mdk_8h.md) + - [image_source_mdk.h](image__source__mdk_8h.md) - [log.h](log_8h.md) - [native_buffer.h](native__buffer_8h.md) - [native_image.h](native__image_8h.md) @@ -105,8 +110,23 @@ - [OH_NativeXComponent_TouchPoint](_o_h___native_x_component___touch_point.md) - [OHExtDataHandle](_o_h_ext_data_handle.md) - [OHHDRMetaData](_o_h_h_d_r_meta_data.md) + - [OHOS::Media::OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) + - [OHOS::Media::OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) + - [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) + - [OhosImageDecodingOps](_ohos_image_decoding_ops.md) + - [OhosImageReceiverInfo](_ohos_image_receiver_info.md) + - [OhosImageRegion](_ohos_image_region.md) + - [OhosImageSize](_ohos_image_size.md) + - [OhosImageSource](_ohos_image_source.md) + - [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) + - [OhosImageSourceInfo](_ohos_image_source_info.md) + - [OhosImageSourceOps](_ohos_image_source_ops.md) + - [OhosImageSourceProperty](_ohos_image_source_property.md) + - [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) + - [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) + - [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) - [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) - - [OhosPixelMapInfo](_ohos_pixel_map_info.md) + - [OhosPixelMapInfos](_ohos_pixel_map_infos.md) - [RawFileDescriptor](_raw_file_descriptor.md) - [Region](_region.md) - [Rect](_rect.md) diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_component.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_component.md new file mode 100644 index 0000000000000000000000000000000000000000..0ccd44c0a0b96bcdcc34adbd91e1d0cf9fd71586 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_component.md @@ -0,0 +1,86 @@ +# OHOS::Media::OhosImageComponent + + +## 概述 + +定义图像组成信息。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [byteBuffer](#bytebuffer) | 像素数据地址 | +| [size](#size) | 内存中的像素数据大小 | +| [componentType](#componenttype) | 像素数据类型 | +| [rowStride](#rowstride) | 像素数据行宽 | +| [pixelStride](#pixelstride) | 像素数据的像素大小 | + + +## 结构体成员变量说明 + + +### byteBuffer + +``` +uint8_t* OHOS::Media::OhosImageComponent::byteBuffer +``` + +**描述:** + +像素数据地址 + + +### componentType + +``` +int32_t OHOS::Media::OhosImageComponent::componentType +``` + +**描述:** + +像素数据类型 + + +### pixelStride + +``` +int32_t OHOS::Media::OhosImageComponent::pixelStride +``` + +**描述:** + +像素数据的像素大小 + + +### rowStride + +``` +int32_t OHOS::Media::OhosImageComponent::rowStride +``` + +**描述:** + +像素数据行宽 + + +### size + +``` +size_t OHOS::Media::OhosImageComponent::size +``` + +**描述:** + +内存中的像素数据大小 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_rect.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_rect.md new file mode 100644 index 0000000000000000000000000000000000000000..d935664dc4e69f4f4165ac979d45862e75810d4f --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_rect.md @@ -0,0 +1,74 @@ +# OHOS::Media::OhosImageRect + + +## 概述 + +定义图像矩形信息。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [x](#x) | 矩形x坐标值 | +| [y](#y) | 矩形y坐标值 | +| [width](#width) | 矩形宽度值,用pixels表示 | +| [height](#height) | 矩形高度值,用pixels表示 | + + +## 结构体成员变量说明 + + +### height + +``` +int32_t OHOS::Media::OhosImageRect::height +``` + +**描述:** + +矩形高度值,用pixels表示 + + +### width + +``` +int32_t OHOS::Media::OhosImageRect::width +``` + +**描述:** + +矩形宽度值,用pixels表示 + + +### x + +``` +int32_t OHOS::Media::OhosImageRect::x +``` + +**描述:** + +矩形x坐标值 + + +### y + +``` +int32_t OHOS::Media::OhosImageRect::y +``` + +**描述:** + +矩形y坐标值 diff --git a/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md new file mode 100644 index 0000000000000000000000000000000000000000..b549bcdeb859ab235e85aefa48ff57f8453b6a83 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md @@ -0,0 +1,78 @@ +# OHOS::Media::OhosPixelMapInfo + + +## 概述 + +用于定义 pixel map 的相关信息。 + +**起始版本:** + +8 + +**废弃起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [width](#width) | 图片的宽,用pixels表示 | +| [height](#height) | 图片的高,用pixels表示 | +| [rowSize](#rowsize) | 每行的bytes数 | +| [pixelFormat](#pixelformat) | Pixel 的格式 | + + +## 结构体成员变量说明 + + +### height + +``` +uint32_t OHOS::Media::OhosPixelMapInfo::height +``` + +**描述:** + +图片的高, 用pixels表示 + + +### pixelFormat + +``` +int32_t OHOS::Media::OhosPixelMapInfo::pixelFormat +``` + +**描述:** + +Pixel 的格式 + + +### rowSize + +``` +uint32_t OHOS::Media::OhosPixelMapInfo::rowSize +``` + +**描述:** + +每行的bytes数 + + +### width + +``` +uint32_t OHOS::Media::OhosPixelMapInfo::width +``` + +**描述:** + +图片的宽, 用pixels表示 diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_decoding_ops.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_decoding_ops.md new file mode 100644 index 0000000000000000000000000000000000000000..c42b81745f7eeb8137a9cd38ab3c03fc8f488611 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_decoding_ops.md @@ -0,0 +1,33 @@ +# OhosImageDecodingOps + + +## 概述 + +定义图像源解码选项。 此选项给[OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap)和[OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [editable](image.md#editable) | 定义输出的像素位图是否可编辑 | +| [pixelFormat](image.md#pixelformat-23) | 定义输出的像素格式 | +| [fitDensity](image.md#fitdensity) | 定义解码目标的像素密度 | +| [index](image.md#index) | 定义图像源解码指数 | +| [sampleSize](image.md#samplesize) | 定义解码样本大小选项 | +| [rotate](image.md#rotate) | 定义解码旋转选项 | +| [size](image.md#size-27) | 定义解码目标像素宽高的大小 | +| [region](image.md#region) | 定义图像源解码的像素范围 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_receiver_info.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_receiver_info.md new file mode 100644 index 0000000000000000000000000000000000000000..3029c251eba0df7bfe69c882f37488de00b71051 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_receiver_info.md @@ -0,0 +1,27 @@ +# OhosImageReceiverInfo + + +## 概述 + +定义**ImageReceiver**的相关信息。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| width | 消费端接收图片时的默认图像宽度,用pixels表示 | +| height | 消费端接收图片时的默认图像高度,用pixels表示 | +| format | 通过接收器创建图像格式OHOS_IMAGE_FORMAT_JPEG | +| capicity | 图片缓存数量的最大值 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_region.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_region.md new file mode 100644 index 0000000000000000000000000000000000000000..c8e86045cd8b29b91f93a4c2fe5a75363b8a68ea --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_region.md @@ -0,0 +1,29 @@ +# OhosImageRegion + + +## 概述 + +定义图像源解码的范围选项。 [OhosImageDecodingOps](_ohos_image_decoding_ops.md), [OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap) and [OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist). + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [x](image.md#x) | 起始x坐标,用pixels表示 | +| [y](image.md#y) | 起始y坐标,用pixels表示 | +| [width](image.md#width) | 宽度范围,用pixels表示 | +| [height](image.md#height) | 高度范围,用pixels表示 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_size.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_size.md new file mode 100644 index 0000000000000000000000000000000000000000..ee541fe5c7b0f36ecea0abe8c3ef02b60ac4115a --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_size.md @@ -0,0 +1,50 @@ +# OhosImageSize + + +## 概述 + +定义图像大小。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [width](#width) | 像素中的图像宽度,用pixels表示 | +| [height](#height) | 像素中的图像高度,用pixels表示 | + + +## 结构体成员变量说明 + + +### height + +``` +int32_t OhosImageSize::height +``` + +**描述:** + +像素中的图像高度,用pixels表示 + + +### width + +``` +int32_t OhosImageSize::width +``` + +**描述:** + +像素中的图像宽度,用pixels表示 diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source.md new file mode 100644 index 0000000000000000000000000000000000000000..3fca08cc75149eb84ee7455dd3b62c8e808fc4dc --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source.md @@ -0,0 +1,30 @@ +# OhosImageSource + + +## 概述 + +定义图像源输入资源,每次仅接收一种类型。由[OH_ImageSource_Create](image.md#oh_imagesource_create)获取。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [uri](image.md#uri) = nullptr | 图像源资源标识符,接受文件资源或者base64资源 | +| [uriSize](image.md#urisize) = 0 | 图像源资源长度 | +| [fd](image.md#fd) = -1 | 图像源文件资源描述符 | +| [buffer](image.md#buffer-12) = nullptr | 图像源缓冲区资源,解手格式化包缓冲区或者base64缓冲区 | +| [bufferSize](image.md#buffersize-12) = 0 | 图像源缓冲区资源大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_delay_time_list.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_delay_time_list.md new file mode 100644 index 0000000000000000000000000000000000000000..cee7c6caa79e44a59494fc48dac1da5d6ec2dc5c --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_delay_time_list.md @@ -0,0 +1,27 @@ +# OhosImageSourceDelayTimeList + + +## 概述 + +定义图像源延迟时间列表。由[OH_ImageSource_GetDelayTime](image.md#oh_imagesource_getdelaytime)获取。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [delayTimeList](image.md#delaytimelist) | 图像源延迟时间列表头地址 | +| [size](image.md#size-47) = 0 | 图像源延迟时间列表大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_info.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_info.md new file mode 100644 index 0000000000000000000000000000000000000000..b4432e43f5ad491c87ec62e85bfd8510d6dff433 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_info.md @@ -0,0 +1,30 @@ +# OhosImageSourceInfo + + +## 概述 + +定义图像源信息,由[OH_ImageSource_GetImageInfo](image.md#oh_imagesource_getimageinfo)获取。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [pixelFormat](image.md#pixelformat-33) | 图像源像素格式, 由[OH_ImageSource_Create()](image.md#oh_imagesource_create)设置 | +| [colorSpace](image.md#colorspace) | 图像源色彩空间 | +| [alphaType](image.md#alphatype) | 图像源透明度类型 | +| [density](image.md#density-22) | 图像源密度, 由 [OH_ImageSource_Create()](image.md#oh_imagesource_create)设置 | +| [size](image.md#size-37) | 图像源像素宽高的大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_ops.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_ops.md new file mode 100644 index 0000000000000000000000000000000000000000..4f779c65c5f57317a3f64b20b31882da2617214e --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_ops.md @@ -0,0 +1,28 @@ +# OhosImageSourceOps + + +## 概述 + +定义图像源选项信息。 此选项给[OH_ImageSource_Create](image.md#oh_imagesource_create)和[OH_ImageSource_CreateIncremental](image.md#oh_imagesource_createincremental)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [density](image.md#density-12) | 图像源像素密度 | +| [pixelFormat](image.md#pixelformat-13) | 图像源像素格式,通常用于描述YUV缓冲区 | +| [size](image.md#size-17) | 图像源像素宽高的大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_property.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_property.md new file mode 100644 index 0000000000000000000000000000000000000000..189325cb512945e20f0e0211b8134497ac5ca224 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_property.md @@ -0,0 +1,27 @@ +# OhosImageSourceProperty + + +## 概述 + +定义图像源属性键值字符串。 此选项给[OH_ImageSource_GetImageProperty](image.md#oh_imagesource_getimageproperty) and [OH_ImageSource_ModifyImageProperty](image.md#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [value](image.md#value) = nullptr | 定义图像源属性键值字符串头地址 | +| [size](image.md#size-77) = 0 | 定义图像源属性键值字符串大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format.md new file mode 100644 index 0000000000000000000000000000000000000000..8f1b5c1b5e181619e702989f96d8395fcb5248c2 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format.md @@ -0,0 +1,27 @@ +# OhosImageSourceSupportedFormat + + +## 概述 + +定义图像源支持的格式字符串。 此选项给[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md)和[OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [format](image.md#format) = nullptr | 图像源支持的格式字符串头地址 | +| [size](image.md#size-57) = 0 | 图像源支持的格式字符串大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format_list.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format_list.md new file mode 100644 index 0000000000000000000000000000000000000000..4476b8d7af0eae3da5b1dc3e087cb624d4886e24 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_supported_format_list.md @@ -0,0 +1,27 @@ +# OhosImageSourceSupportedFormatList + + +## 概述 + +定义图像源支持的格式字符串列表。 由[OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats)获取 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [supportedFormatList](image.md#supportedformatlist) = nullptr | 图像源支持的格式字符串列表头地址 | +| [size](image.md#size-67) = 0 | 图像源支持的格式字符串列表大小 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_image_source_update_data.md b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_update_data.md new file mode 100644 index 0000000000000000000000000000000000000000..fc682eafe73a6013080edacb5bf7fe9bdc4f85a5 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_image_source_update_data.md @@ -0,0 +1,30 @@ +# OhosImageSourceUpdateData + + +## 概述 + +定义图像源更新数据选项,由[OH_ImageSource_UpdateData](image.md#oh_imagesource_updatedata)获取。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [buffer](image.md#buffer-22) = nullptr | 图像源更新数据缓冲区 | +| [bufferSize](image.md#buffersize-22) = 0 | 图像源更新数据缓冲区大小 | +| [offset](image.md#offset) = 0 | 图像源更新数据缓冲区的开端 | +| [updateLength](image.md#updatelength) = 0 | 图像源更新数据缓冲区的更新数据长度 | +| [isCompleted](image.md#iscompleted) = 0 | 图像源更新数据在此节中完成 | diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_create_ops.md b/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_create_ops.md index 438de82b1db4612c61b4696f3c7db1e251a0f93e..1cd2947ade35aaf548febfa65bab0a697e2c6b00 100644 --- a/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_create_ops.md +++ b/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_create_ops.md @@ -3,12 +3,13 @@ ## 概述 -用于定义创建 pixel map 设置选项的相关信息. +用于定义创建 pixel map 设置选项的相关信息。 **起始版本:** + 10 -**相关模块:** +**相关模块:** [Image](image.md) @@ -20,12 +21,12 @@ | 名称 | 描述 | | -------- | -------- | -| [width](#width) | 图片的宽,用pixels表示。 | -| [height](#height) | 图片的高,用pixels表示。 | -| [pixelFormat](#pixelformat) | 图片的格式。 | -| [editable](#editable) | 图片的编辑类型。 | -| [alphaType](#alphatype) | 图片的alpha类型。 | -| [scaleMode](#scalemode) | 图片的缩放类型。 | +| [width](#width) | 图片的宽, 用pixels表示 | +| [height](#height) | 图片的高, 用pixels表示 | +| [pixelFormat](#pixelformat) | 图片的格式 | +| [editable](#editable) | 图片的编辑类型 | +| [alphaType](#alphatype) | 图片的alpha类型 | +| [scaleMode](#scalemode) | 图片的缩放类型 | ## 结构体成员变量说明 @@ -33,59 +34,65 @@ ### alphaType - ``` uint32_t OhosPixelMapCreateOps::alphaType ``` -**描述:** -图片的alpha类型。 + +**描述:** + +图片的alpha类型 ### editable - ``` uint32_t OhosPixelMapCreateOps::editable ``` -**描述:** -图片的编辑类型。 + +**描述:** + +图片的编辑类型 ### height - ``` uint32_t OhosPixelMapCreateOps::height ``` -**描述:** -图片的高,用pixels表示。 + +**描述:** + +图片的高, 用pixels表示 ### pixelFormat - ``` int32_t OhosPixelMapCreateOps::pixelFormat ``` -**描述:** -图片的格式。 + +**描述:** + +图片的格式 ### scaleMode - ``` uint32_t OhosPixelMapCreateOps::scaleMode ``` -**描述:** -图片的缩放类型。 + +**描述:** + +图片的缩放类型 ### width - ``` uint32_t OhosPixelMapCreateOps::width ``` -**描述:** -图片的宽,用pixels表示。 + +**描述:** + +图片的宽, 用pixels表示 diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_info.md b/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_info.md deleted file mode 100644 index 00e40e5e37abeee7c8e2c84c2d88bd9888bc6bf9..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_info.md +++ /dev/null @@ -1,78 +0,0 @@ -# OhosPixelMapInfo - - -## 概述 - -用于定义 pixel map 的相关信息。 - -**起始版本:** - -8 - -**相关模块:** - -[Image](image.md) - - -## 汇总 - - -### 成员变量 - - | 成员变量名称 | 描述 | -| -------- | -------- | -| [width](#width) | 图片的宽,用pixels表示。 | -| [height](#height) | 图片的高,用pixels表示。 | -| [rowSize](#rowsize) | 每行的bytes数。 | -| [pixelFormat](#pixelformat) | Pixel的格式。 | - - -## 结构体成员变量说明 - - -### height - - -``` -uint32_t OhosPixelMapInfo::height -``` - -**描述:** - -图片的高,用pixels表示。 - - -### pixelFormat - - -``` -int32_t OhosPixelMapInfo::pixelFormat -``` - -**描述:** - -Pixel的格式。 - - -### rowSize - - -``` -uint32_t OhosPixelMapInfo::rowSize -``` - -**描述:** - -每行的bytes数。 - - -### width - - -``` -uint32_t OhosPixelMapInfo::width -``` - -**描述:** - -图片的宽,用pixels表示。 diff --git a/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_infos.md b/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_infos.md new file mode 100644 index 0000000000000000000000000000000000000000..4def9703ccbde0a2b7b3e2e724210281041ba951 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/_ohos_pixel_map_infos.md @@ -0,0 +1,74 @@ +# OhosPixelMapInfos + + +## 概述 + +用于定义 pixel map 的相关信息。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 成员变量 + +| 名称 | 描述 | +| -------- | -------- | +| [width](#width) | 图片的宽, 用pixels表示 | +| [height](#height) | 图片的高, 用pixels表示 | +| [rowSize](#rowsize) | 每行的bytes数 | +| [pixelFormat](#pixelformat) | Pixel 的格式 | + + +## 结构体成员变量说明 + + +### height + +``` +uint32_t OhosPixelMapInfos::height +``` + +**描述:** + +图片的高, 用pixels表示 + + +### pixelFormat + +``` +int32_t OhosPixelMapInfos::pixelFormat +``` + +**描述:** + +Pixel 的格式 + + +### rowSize + +``` +uint32_t OhosPixelMapInfos::rowSize +``` + +**描述:** + +每行的bytes数 + + +### width + +``` +uint32_t OhosPixelMapInfos::width +``` + +**描述:** + +图片的宽, 用pixels表示 diff --git a/zh-cn/application-dev/reference/native-apis/image.md b/zh-cn/application-dev/reference/native-apis/image.md index 444a82a797cdcacd21fb9fdbcaa175ade707f56b..acc95bc24a013abd06309388aa3c13e832938ff8 100644 --- a/zh-cn/application-dev/reference/native-apis/image.md +++ b/zh-cn/application-dev/reference/native-apis/image.md @@ -1,14 +1,14 @@ # Image -提供获取pixelmap的数据和信息的接口方法。 +## 概述 -@Syscap SystemCapability.Multimedia.Image +提供访问Image接口的方法,包括如何获取图片数据、获取PixelMap的数据和信息。 +\@Syscap SystemCapability.Multimedia.Image **起始版本:** - 8 @@ -17,686 +17,4092 @@ ### 文件 -| 文件名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| [image_pixel_map_napi.h](image__pixel__map__napi_8h.md) | 声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。
**引用文件**:
**库**:libpixelmap_ndk.z.so| +| [image_mdk.h](image__mdk_8h.md) | 声明访问图像剪辑矩形、大小、格式和组件数据的函数。
**引用文件**:<multimedia/image_framework/image_mdk.h>
**库**:libimage_ndk.z.so | +| [image_mdk_common.h](image__mdk__common_8h.md) | 声明图像常用的枚举值和结构体。
**引用文件**:<multimedia/image_framework/image_mdk_common.h>
**库**:libimage_ndk.z.so | +| [image_pixel_map_mdk.h](image__pixel__map__mdk_8h.md) | 声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。
**引用文件**:<multimedia/image_framework/image_pixel_map_mdk.h>
**库**:libpixelmap_ndk.z.so | +| [image_pixel_map_napi.h](image__pixel__map__napi_8h.md) | 声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。
**引用文件**:<multimedia/image_framework/image_pixel_map_napi.h>
**库**:libpixelmap_ndk.z.so | +| [image_receiver_mdk.h](image__receiver__mdk_8h.md) | 声明从native层获取图片数据的方法。
**引用文件**:<multimedia/image_framework/image_receiver_mdk.h>
**库**:libimage_receiver_ndk.z.so | +| [image_source_mdk.h](image__source__mdk_8h.md) | 声明将图片源解码成像素位图的方法。
**引用文件**:<multimedia/image_framework/image_source_mdk.h>
**库**:libimage_source_ndk.z.so | ### 结构体 -| 结构体名称 | 描述 | +| 名称 | 描述 | | -------- | -------- | -| [OhosPixelMapInfo](_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 | -| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。| +| [OHOS::Media::OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) | 定义图像矩形信息。 | +| [OHOS::Media::OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) | 定义图像组成信息。 | +| [OhosImageSize](_ohos_image_size.md) | 定义图像大小。 | +| [OhosPixelMapInfos](_ohos_pixel_map_infos.md) | 用于定义 pixel map 的相关信息。 | +| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 | +| [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 | +| [OhosImageReceiverInfo](_ohos_image_receiver_info.md) | 定义**ImageReceiver**的相关信息。 | +| [OhosImageRegion](_ohos_image_region.md) | 定义图像源解码的范围选项。 | +| [OhosImageSourceOps](_ohos_image_source_ops.md) | 定义图像源选项信息。 | +| [OhosImageDecodingOps](_ohos_image_decoding_ops.md) | 定义图像源解码选项。 | +| [OhosImageSourceInfo](_ohos_image_source_info.md) | 定义图像源信息。 | +| [OhosImageSource](_ohos_image_source.md) | 定义图像源输入资源,每次仅接收一种类型。 | +| [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) | 定义图像源延迟时间列表。 | +| [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) | 定义图像源支持的格式字符串。 | +| [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) | 定义图像源支持的格式字符串列表。 | +| [OhosImageSourceProperty](_ohos_image_source_property.md) | 定义图像源属性键值字符串。 | +| [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) | 定义图像源更新数据选项。 | ### 类型定义 | 名称 | 描述 | | -------- | -------- | -| [NativePixelMap](#nativepixelmap) | 用于定义NativePixelMap数据类型名称。| +| [OHOS::Media::ImageNative](#imagenative) | 为图像接口定义native层图像对象。 | +| [NativePixelMap](#nativepixelmap) | 定义native层pixelmap数据类型名称。 | +| [OhosPixelMapInfos](#ohospixelmapinfos) | 用于定义 pixel map 的相关信息。 | +| [ImageReceiverNative](#imagereceivernative) | 用于定义ImageReceiverNative数据类型名称。 | +| (\*[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)) () | 定义native层图片的回调方法。 | +| [ImageSourceNative](#imagesourcenative) | 为图像源方法定义native层图像源对象。 | + +### 宏定义 +| 名称 | 描述 | +| -------- | -------- | +| **IMAGE_RESULT_BASE** 62980096 | 接口返回值的基础值 | ### 枚举 | 名称 | 描述 | | -------- | -------- | -| { OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | 函数方法返回值的错误码的枚举。| -| { OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | pixel 格式的枚举。| -| { OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0, OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1, OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2, OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 } | PixelMap alpha 类型的枚举。| -| { OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0, OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 } | PixelMap 缩放类型的枚举。| -| { OHOS_PIXEL_MAP_READ_ONLY = 0, OHOS_PIXEL_MAP_EDITABLE = 1 } | PixelMap 编辑类型的枚举。| +| { OHOS::Media::OHOS_IMAGE_FORMAT_YCBCR_422_SP = 1000,
OHOS::Media::OHOS_IMAGE_FORMAT_JPEG = 2000, } | 图像格式枚举值。 | +| { OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y = 1,
OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_U = 2,
OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_V = 3,
OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_JPEG = 4, } | 图像组成类型枚举值。 | +| [IRNdkErrCode](#irndkerrcode) {
IMAGE_RESULT_SUCCESS = 0,
IMAGE_RESULT_BAD_PARAMETER = -1,
IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,
IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,
IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,
IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3,
IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,
IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,
IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,
IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,
IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,
IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,
IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,
IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,
IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,
IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,
IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,
IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,
IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,
IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,
IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,
IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,
IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,
IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,
IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,
IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,
IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,
IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,
IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,
IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,
IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,
IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,
IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,
IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,
IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,
IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,
IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,
IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,
IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,
IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,
IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,
IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,
IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,
IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,
IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,
IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,
IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,
IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,
IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,
IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,
IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,
IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,
IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,
IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53, IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,
IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,
IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,
IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,
IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,
IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,
IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,
IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,
IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,
IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,
IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,
IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,
IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,
IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,
IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,
IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,
IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,
IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,
IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,
IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,
IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,
IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,
IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,
IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,
IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,
IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,
IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,
IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,
IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,
IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,
IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,
IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,
IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,
IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,
IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,
IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,
IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,
IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,
IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,
IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,
IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,
IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,
IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,
IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,
IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,
IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200
} | 可能出现的返回值的枚举。 | +| { OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0,
OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1,
OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2,
OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 } | PixelMap 透明度类型的枚举。 | +| { OHOS_PIXEL_MAP_READ_ONLY = 0,
OHOS_PIXEL_MAP_EDITABLE = 1 } | PixelMap 编辑类型的枚举。 | +| { OHOS::Media::OHOS_IMAGE_RESULT_SUCCESS = 0,
OHOS::Media::OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | 函数方法返回值的错误码的枚举。 | +| { OHOS::Media::OHOS_PIXEL_MAP_FORMAT_NONE = 0,
OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3,
OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | pixel 格式的枚举。 | +| { OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0,
OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 } | PixelMap 缩放类型的枚举。 | ### 函数 | 名称 | 描述 | | -------- | -------- | -| [OH_GetImageInfo](#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。| -| [OH_AccessPixels](#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。| -| [OH_UnAccessPixels](#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#oh_accesspixels)。| -| [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**对象。| -| [OH_PixelMap_CreateAlphaPixelMap](#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。| -| [OH_PixelMap_InitNativePixelMap](#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。| -| [OH_PixelMap_GetBytesNumberPerRow](#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。| -| [OH_PixelMap_GetIsEditable](#oh_pixelmap_getiseditable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*[editable](image__pixel__map__napi_8h.md#editable)) | 获取**PixelMap**对象是否可编辑的状态。| -| [OH_PixelMap_IsSupportAlpha](#oh_pixelmap_issupportalpha) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。| -| [OH_PixelMap_SetAlphaAble](#oh_pixelmap_setalphaable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。| -| [OH_PixelMap_GetDensity](#oh_pixelmap_getdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。| -| [OH_PixelMap_SetDensity](#oh_pixelmap_setdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。| -| [OH_PixelMap_SetOpacity](#oh_pixelmap_setopacity) (const [NativePixelMap](#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。| -| [OH_PixelMap_Scale](#oh_pixelmap_scale) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。| -| [OH_PixelMap_Translate](#oh_pixelmap_translate) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。| -| [OH_PixelMap_Rotate](#oh_pixelmap_rotate) (const [NativePixelMap](#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。| -| [OH_PixelMap_Flip](#oh_pixelmap_flip) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。| -| [OH_PixelMap_Crop](#oh_pixelmap_crop) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y, int32_t [width](image__pixel__map__napi_8h.md#width), int32_t [height](image__pixel__map__napi_8h.md#height)) | 设置**PixelMap**对象的裁剪。| +| [OHOS::Media::OH_Image_InitImageNative](#oh_image_initimagenative) (napi_env env, napi_value source) | 从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。 | +| [OHOS::Media::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) 信息。 | +| [OHOS::Media::OH_Image_Size](#oh_image_size) (const [ImageNative](#imagenative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。 | +| [OHOS::Media::OH_Image_Format](#oh_image_format) (const [ImageNative](#imagenative) \*native, int32_t \*format) | 获取native **ImageNative** 对象的图像格式。 | +| [OHOS::Media::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)。 | +| [OHOS::Media::OH_Image_Release](#oh_image_release) ([ImageNative](#imagenative) \*native) | 释放 **ImageNative** native对象。 | +| [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**对象。 | +| [OH_PixelMap_CreateAlphaPixelMap](#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 | +| [OH_PixelMap_InitNativePixelMap](#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 | +| [OH_PixelMap_GetBytesNumberPerRow](#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 | +| [OH_PixelMap_GetIsEditable](#oh_pixelmap_getiseditable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*editable) | 获取**PixelMap**对象是否可编辑的状态。 | +| [OH_PixelMap_IsSupportAlpha](#oh_pixelmap_issupportalpha) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 | +| [OH_PixelMap_SetAlphaAble](#oh_pixelmap_setalphaable) (const [NativePixelMap](#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 | +| [OH_PixelMap_GetDensity](#oh_pixelmap_getdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 | +| [OH_PixelMap_SetDensity](#oh_pixelmap_setdensity) (const [NativePixelMap](#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 | +| [OH_PixelMap_SetOpacity](#oh_pixelmap_setopacity) (const [NativePixelMap](#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 | +| [OH_PixelMap_Scale](#oh_pixelmap_scale) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 | +| [OH_PixelMap_Translate](#oh_pixelmap_translate) (const [NativePixelMap](#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 | +| [OH_PixelMap_Rotate](#oh_pixelmap_rotate) (const [NativePixelMap](#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 | +| [OH_PixelMap_Flip](#oh_pixelmap_flip) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 | +| [OH_PixelMap_Crop](#oh_pixelmap_crop) (const [NativePixelMap](#nativepixelmap) \*native, int32_t x, int32_t y, int32_t width, int32_t height) | 设置**PixelMap**对象的裁剪。 | +| [OH_PixelMap_GetImageInfo](#oh_pixelmap_getimageinfo) (const [NativePixelMap](#nativepixelmap) \*native, [OhosPixelMapInfos](_ohos_pixel_map_infos.md) \*info) | 获取**PixelMap**对象图像信息。 | +| [OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels) (const [NativePixelMap](#nativepixelmap) \*native, void \*\*addr) | 获取native **PixelMap** 对象数据的内存地址,并锁定该内存。 | +| [OH_PixelMap_UnAccessPixels](#oh_pixelmap_unaccesspixels) (const [NativePixelMap](#nativepixelmap) \*native) | 释放native **PixelMap**对象数据的内存锁,用于匹配方法 [OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels)。 | +| [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)结构中。 | +| [OHOS::Media::OH_AccessPixels](#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 | +| [OHOS::Media::OH_UnAccessPixels](#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。 | +| [OH_Image_Receiver_CreateImageReceiver](#oh_image_receiver_createimagereceiver) (napi_env env, struct [OhosImageReceiverInfo](_ohos_image_receiver_info.md) info, napi_value \*res) | 创建应用层 **ImageReceiver** 对象。 | +| [OH_Image_Receiver_InitImageReceiverNative](#oh_image_receiver_initimagereceivernative) (napi_env env, napi_value source) | 通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](#imagereceivernative)对象。 | +| [OH_Image_Receiver_GetReceivingSurfaceId](#oh_image_receiver_getreceivingsurfaceid) (const [ImageReceiverNative](#imagereceivernative) \*native, char \*id, size_t len) | 通过[ImageReceiverNative](#imagereceivernative)获取receiver的id。 | +| [OH_Image_Receiver_ReadLatestImage](#oh_image_receiver_readlatestimage) (const [ImageReceiverNative](#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](#imagereceivernative)获取最新的一张图片。 | +| [OH_Image_Receiver_ReadNextImage](#oh_image_receiver_readnextimage) (const [ImageReceiverNative](#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](#imagereceivernative)获取下一张图片。 | +| [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)回调事件。每当接收新图片,该回调事件就会响应。 | +| [OH_Image_Receiver_GetSize](#oh_image_receiver_getsize) (const [ImageReceiverNative](#imagereceivernative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的大小。 | +| [OH_Image_Receiver_GetCapacity](#oh_image_receiver_getcapacity) (const [ImageReceiverNative](#imagereceivernative) \*native, int32_t \*capacity) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的容量。 | +| [OH_Image_Receiver_GetFormat](#oh_image_receiver_getformat) (const [ImageReceiverNative](#imagereceivernative) \*native, int32_t \*format) | 通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的格式。 | +| [OH_Image_Receiver_Release](#oh_image_receiver_release) ([ImageReceiverNative](#imagereceivernative) \*native) | 释放native层 [ImageReceiverNative](#imagereceivernative) 对象。注意: 此方法不能释放应用层**ImageReceiver**对象。 | +| [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**对象。 | +| [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) | 通过给定的infomations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。 | +| [OH_ImageSource_GetSupportedFormats](#oh_imagesource_getsupportedformats) (struct [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) \*res) | 获取所有支持的解码格式元标记。 | +| [OH_ImageSource_InitNative](#oh_imagesource_initnative) (napi_env env, napi_value source) | 从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](#imagesourcenative)值。 | +| [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**对象 | +| [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**对象列表 | +| [OH_ImageSource_GetDelayTime](#oh_imagesource_getdelaytime) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) \*res) | 从一些**ImageSource**(如GIF图像源)获取延迟时间列表。 | +| [OH_ImageSource_GetFrameCount](#oh_imagesource_getframecount) (const [ImageSourceNative](#imagesourcenative) \*native, uint32_t \*res) | 从**ImageSource**中获取帧计数。 | +| [OH_ImageSource_GetImageInfo](#oh_imagesource_getimageinfo) (const [ImageSourceNative](#imagesourcenative) \*native, int32_t index, struct [OhosImageSourceInfo](_ohos_image_source_info.md) \*info) | 通过索引从**ImageSource**获取图像源信息。 | +| [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**中获取图像源属性。 | +| [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**修改图像源属性。 | +| [OH_ImageSource_UpdateData](#oh_imagesource_updatedata) (const [ImageSourceNative](#imagesourcenative) \*native, struct [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) \*data) | 为了增量类型的**ImageSource**更新源数据。 | +| [OH_ImageSource_Release](#oh_imagesource_release) ([ImageSourceNative](#imagesourcenative) \*native) | 释放native层图像源 **ImageSourceNative**。 | + + +### 变量 + +| 名称 | 描述 | +| -------- | -------- | +| [OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE](#ohos_image_property_bits_per_sample) = "BitsPerSample" | 定义每个样本比特的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_ORIENTATION](#ohos_image_property_orientation) = "Orientation" | 定义方向的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_IMAGE_LENGTH](#ohos_image_property_image_length) = "ImageLength" | 定义图像长度的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_IMAGE_WIDTH](#ohos_image_property_image_width) = "ImageWidth" | 定义图像宽度的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_GPS_LATITUDE](#ohos_image_property_gps_latitude) = "GPSLatitude" | 定义GPS纬度的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_GPS_LONGITUDE](#ohos_image_property_gps_longitude) = "GPSLongitude" | 定义GPS经度的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF](#ohos_image_property_gps_latitude_ref) = "GPSLatitudeRef" | 定义GPS纬度参考的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF](#ohos_image_property_gps_longitude_ref) = "GPSLongitudeRef" | 定义GPS经度参考的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL](#ohos_image_property_date_time_original) = "DateTimeOriginal" | 定义初始日期时间的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_EXPOSURE_TIME](#ohos_image_property_exposure_time) = "ExposureTime" | 定义曝光时间的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_SCENE_TYPE](#ohos_image_property_scene_type) = "SceneType" | 定义场景类型的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS](#ohos_image_property_iso_speed_ratings) = "ISOSpeedRatings" | 定义ISO速度等级的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_F_NUMBER](#ohos_image_property_f_number) = "FNumber" | 定义FNumber的图像属性关键字。 | +| [OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL](#ohos_image_property_compressed_bits_per_pixel) = "CompressedBitsPerPixel" | 定义每个像素的压缩比特的图像属性关键字。 | +| [OhosImageRegion::x](#x) | 起始x坐标,用pixels表示 | +| [OhosImageRegion::y](#y) | 起始y坐标,用pixels表示 | +| [OhosImageRegion::width](#width) | 宽度范围,用pixels表示 | +| [OhosImageRegion::height](#height) | 高度范围,用pixels表示 | +| [OhosImageSourceOps::density](#density-12) | 图像源像素密度 | +| [OhosImageSourceOps::pixelFormat](#pixelformat-13) | 图像源像素格式,通常用于描述YUV缓冲区 | +| [OhosImageSourceOps::size](#size-17) | 图像源像素宽高的大小 | +| [OhosImageDecodingOps::editable](#editable) | 定义输出的像素位图是否可编辑 | +| [OhosImageDecodingOps::pixelFormat](#pixelformat-23) | 定义输出的像素格式 | +| [OhosImageDecodingOps::fitDensity](#fitdensity) | 定义解码目标的像素密度 | +| [OhosImageDecodingOps::index](#index) | 定义图像源解码指数 | +| [OhosImageDecodingOps::sampleSize](#samplesize) | 定义解码样本大小选项 | +| [OhosImageDecodingOps::rotate](#rotate) | 定义解码旋转选项 | +| [OhosImageDecodingOps::size](#size-27) | 定义解码目标像素宽高的大小 | +| [OhosImageDecodingOps::region](#region) | 定义图像源解码的像素范围 | +| [OhosImageSourceInfo::pixelFormat](#pixelformat-33) | 图像源像素格式, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 | +| [OhosImageSourceInfo::colorSpace](#colorspace) | 图像源色彩空间 | +| [OhosImageSourceInfo::alphaType](#alphatype) | 图像源透明度类型 | +| [OhosImageSourceInfo::density](#density-22) | 图像源密度, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 | +| [OhosImageSourceInfo::size](#size-37) | 图像源像素宽高的大小 | +| [OhosImageSource::uri](#uri) = nullptr | 图像源资源标识符,接受文件资源或者base64资源 | +| [OhosImageSource::uriSize](#urisize) = 0 | 图像源资源长度 | +| [OhosImageSource::fd](#fd) = -1 | 图像源文件资源描述符 | +| [OhosImageSource::buffer](#buffer-12) = nullptr | 图像源缓冲区资源,解手格式化包缓冲区或者base64缓冲区 | +| [OhosImageSource::bufferSize](#buffersize-12) = 0 | 图像源缓冲区资源大小 | +| [OhosImageSourceDelayTimeList::delayTimeList](#delaytimelist) | 图像源延迟时间列表头地址 | +| [OhosImageSourceDelayTimeList::size](#size-47) = 0 | 图像源延迟时间列表大小 | +| [OhosImageSourceSupportedFormat::format](#format) = nullptr | 图像源支持的格式字符串头地址 | +| [OhosImageSourceSupportedFormat::size](#size-57) = 0 | 图像源支持的格式字符串大小 | +| [OhosImageSourceSupportedFormatList::supportedFormatList](#supportedformatlist) = nullptr | 图像源支持的格式字符串列表头地址 | +| [OhosImageSourceSupportedFormatList::size](#size-67) = 0 | 图像源支持的格式字符串列表大小 | +| [OhosImageSourceProperty::value](#value) = nullptr | 定义图像源属性键值字符串头地址 | +| [OhosImageSourceProperty::size](#size-77) = 0 | 定义图像源属性键值字符串大小 | +| [OhosImageSourceUpdateData::buffer](#buffer-22) = nullptr | 图像源更新数据缓冲区 | +| [OhosImageSourceUpdateData::bufferSize](#buffersize-22) = 0 | 图像源更新数据缓冲区大小 | +| [OhosImageSourceUpdateData::offset](#offset) = 0 | 图像源更新数据缓冲区的开端 | +| [OhosImageSourceUpdateData::updateLength](#updatelength) = 0 | 图像源更新数据缓冲区的更新数据长度 | +| [OhosImageSourceUpdateData::isCompleted](#iscompleted) = 0 | 图像源更新数据在此节中完成 | ## 类型定义说明 -### NativePixelMap +### ImageNative + - ``` -typedef struct NativePixelMap +typedef struct ImageNative_ OHOS::Media::ImageNative ``` -**描述:** -用于定义NativePixelMap数据类型名称。 -**起始版本:** -10 +**描述:** +为图像接口定义native层图像对象。 -## 枚举类型说明 +**起始版本:** + +10 -### anonymous enum +### ImageReceiverNative - ``` -anonymous enum +typedef struct ImageReceiverNative_ ImageReceiverNative ``` -**描述:** -函数方法返回值的错误码的枚举。 -| 枚举值 | 描述 | -| -------- | -------- | -| OHOS_IMAGE_RESULT_SUCCESS| 成功的结果 | -| OHOS_IMAGE_RESULT_BAD_PARAMETER| 无效值 | +**描述:** + +用于定义ImageReceiverNative数据类型名称。 **起始版本:** -8 -### anonymous enum +10 + + +### ImageSourceNative - ``` -anonymous enum +typedef struct ImageSourceNative_ ImageSourceNative ``` -**描述:** -pixel 格式的枚举。 -| 枚举值 | 描述 | -| -------- | -------- | -| OHOS_PIXEL_MAP_FORMAT_NONE| 未知的格式 | -| OHOS_PIXEL_MAP_FORMAT_RGBA_8888| 32-bit RGBA。 由 R, G, B组成,包括 A 都需要占用 8 bits。存储顺序是从高位到低位。 | -| OHOS_PIXEL_MAP_FORMAT_RGB_565| 16-bit RGB。 仅由 R, G, B 组成. 存储顺序是从高位到低位: 红色占用5 bits,绿色占用6 bits,蓝色占用5 bits。 | +**描述:** + +为图像源方法定义native层图像源对象。 + +\@Syscap SystemCapability.Multimedia.Image **起始版本:** -8 -### anonymous enum +10 + + +### NativePixelMap - ``` -anonymous enum +typedef struct NativePixelMap_ NativePixelMap ``` -**描述:** -PixelMap alpha 类型的枚举。 -| 枚举值 | 描述 | -| -------- | -------- | -| OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN| 未知的格式 | -| OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE| 不透明的格式 | -| OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL| 预乘的格式 | -| OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL| 预除的格式 | +**描述:** + +定义native层pixelmap数据类型名称。 + +**起始版本:** -**起始版本:** 10 -### anonymous enum - +### OH_Image_Receiver_On_Callback + ``` -anonymous enum +typedef void(* OH_Image_Receiver_On_Callback) () ``` -**描述:** -PixelMap 缩放类型的枚举。 -| 枚举值 | 描述 | -| -------- | -------- | -| OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE| 适应目标图片大小的格式 | -| OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP| 以中心进行缩放的格式 | +**描述:** + +定义native层图片的回调方法。 + +**起始版本:** -**起始版本:** 10 -### anonymous enum +### OhosPixelMapInfos - ``` -anonymous enum +typedef struct OhosPixelMapInfosOhosPixelMapInfos ``` -**描述:** -PixelMap 编辑类型的枚举。 -| 枚举值 | 描述 | -| -------- | -------- | -| OHOS_PIXEL_MAP_READ_ONLY| 只读的格式 | -| OHOS_PIXEL_MAP_EDITABLE| 可编辑的格式 | +**描述:** + +用于定义 pixel map 的相关信息。 + +**起始版本:** -**起始版本:** 10 -## 函数说明 +## 枚举类型说明 -### OH_AccessPixels() +### anonymous enum [1/3] - ``` -int32_t OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr ) +anonymous enum ``` -**描述:** -获取**PixelMap**对象数据的内存地址,并锁定该内存。 -函数执行成功后,**\*addrPtr**就是获取的待访问的内存地址. 访问操作完成后,必须要使用[OH_UnAccessPixels](#oh_unaccesspixels)来释放锁, 否则的话资源无法被释放. 待解锁后,内存地址就不可以再被访问和操作。 +**描述:** -**参数:** +图像格式枚举值。 -| 名称 | 描述 | +**起始版本:** + +10 + +| 枚举值 | 描述 | | -------- | -------- | -| env | napi的环境指针。| -| value | 应用层的 **PixelMap** 对象。| -| addrPtr | 用于指向的内存地址的双指针对象。| +| OHOS_IMAGE_FORMAT_YCBCR_422_SP | YCBCR422 semi-planar 格式 | +| OHOS_IMAGE_FORMAT_JPEG | JPEG 编码格式 | -**参见:** -UnAccessPixels +### anonymous enum [2/3] -**返回:** +``` +anonymous enum +``` + +**描述:** -操作成功则返回 OHOS_IMAGE_RESULT_SUCCESS; 如果操作失败,则返回错误码。 +PixelMap 透明度类型的枚举。 **起始版本:** -8 +10 + +| 枚举值 | 描述 | +| -------- | -------- | +| OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN | 未知的格式 | +| OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE | 不透明的格式 | +| OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL | 预乘的格式 | +| OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL | 预除的格式 | -### OH_GetImageInfo() - +### anonymous enum [3/3] + ``` -struct OhosPixelMapCreateOps OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo * info ) +anonymous enum ``` -**描述:** -获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。 -**参数:** +**描述:** -| 名称 | 描述 | -| -------- | -------- | -| env | napi的环境指针。| -| value | 应用层的 **PixelMap** 对象。| -| info | 用于保存信息的指针对象. 更多细节, 参看 [OhosPixelMapInfo](_ohos_pixel_map_info.md)。| +函数方法返回值的错误码的枚举。 -**返回:** +**起始版本:** -如果获取并保存信息成功,则返回**0**; 如果操作失败,则返回错误码。 +8 -**参见:** +**废弃起始版本:** -[OhosPixelMapInfo](_ohos_pixel_map_info.md) +10 -**起始版本:** -8 +| 枚举值 | 描述 | +| -------- | -------- | +| OHOS_IMAGE_RESULT_SUCCESS | 成功的结果 | +| OHOS_IMAGE_RESULT_BAD_PARAMETER | 无效值 | -### OH_PixelMap_CreateAlphaPixelMap() +### anonymous enum [1/3] - ``` -int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value * alpha ) +anonymous enum ``` -**描述:** -根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 -**参数:** +**描述:** -| 名称 | 描述 | +图像组成类型枚举值。 + +**起始版本:** + +10 + +| 枚举值 | 描述 | | -------- | -------- | -| env | napi的环境指针。| -| source | **PixelMap**数据设置项。| -| alpha | alpha通道的指针。| +| OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y | 亮度信息 | +| OHOS_IMAGE_COMPONENT_FORMAT_YUV_U | 色度信息 | +| OHOS_IMAGE_COMPONENT_FORMAT_YUV_V | 色差值信息 | +| OHOS_IMAGE_COMPONENT_FORMAT_JPEG | Jpeg 格式 | -**返回:** -操作成功则返回 **PixelMap** 对象; 如果操作失败,则返回错误码。 +### anonymous enum [2/3] -**参见:** +``` +anonymous enum +``` -CreateAlphaPixelMap +**描述:** + +PixelMap 编辑类型的枚举。 + +**起始版本:** -**起始版本:** 10 +| 枚举值 | 描述 | +| -------- | -------- | +| OHOS_PIXEL_MAP_READ_ONLY | 只读的格式 | +| OHOS_PIXEL_MAP_EDITABLE | 可编辑的格式 | + -### OH_PixelMap_CreatePixelMap() +### anonymous enum [3/3] - ``` -int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void * buf, size_t len, napi_value * res ) +anonymous enum ``` -**描述:** -创建**PixelMap**对象. - -**参数:** -| 名称 | 描述 | -| -------- | -------- | -| env | napi的环境指针。| -| info | pixel map 数据设置项。| -| buf | 图片的buffer数据。| -| len | 图片大小信息。| -| res | 应用层的 **PixelMap** 对象的指针。| +**描述:** -**返回:** +pixel 格式的枚举。 -操作成功则返回 **PixelMap** 对象; 如果操作失败,则返回错误码。 +**起始版本:** -**参见:** +8 -CreatePixelMap +**废弃起始版本:** -**起始版本:** 10 +| 枚举值 | 描述 | +| -------- | -------- | +| OHOS_PIXEL_MAP_FORMAT_NONE | 未知的格式 | +| OHOS_PIXEL_MAP_FORMAT_RGBA_8888 | 32-bit RGBA. 由 R, G, B组成,包括 A 都需要占用 8 bits。存储顺序是从高位到低位。 | +| OHOS_PIXEL_MAP_FORMAT_RGB_565 | 16-bit RGB. 仅由 R, G, B 组成。 存储顺序是从高位到低位: 红色占用5 bits,绿色占用6 bits,蓝色占用5 bits。 | + -### OH_PixelMap_Crop() +### anonymous enum - ``` -int32_t OH_PixelMap_Crop (const NativePixelMap * native, int32_t x, int32_t y, int32_t width, int32_t height ) +anonymous enum ``` -**描述:** -设置**PixelMap**对象的裁剪. - -**参数:** - -| 名称 | 描述 | -| -------- | -------- | -| native | NativePixelMap的指针。| -| x | 目标图片左上角的x坐标。| -| y | 目标图片左上角的y坐标。| -| width | 裁剪区域的宽度。| -| height | 裁剪区域的高度。| -**返回:** - -操作成功则返回**0**; 如果操作失败,则返回错误码。 +**描述:** -**参见:** +PixelMap 缩放类型的枚举。 -Crop +**起始版本:** -**起始版本:** 10 +| 枚举值 | 描述 | +| -------- | -------- | +| OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE | 适应目标图片大小的格式 | +| OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP | 以中心进行缩放的格式 | + -### OH_PixelMap_Flip() +### IRNdkErrCode - ``` -int32_t OH_PixelMap_Flip (const NativePixelMap * native, int32_t x, int32_t y ) +enum IRNdkErrCode ``` -**描述:** -设置**PixelMap**对象的翻转. -**参数:** +**描述:** -| 名称 | 描述 | -| -------- | -------- | -| native | NativePixelMap的指针。| -| x | 根据水平方向x轴进行图片翻转。| -| y | 根据垂直方向y轴进行图片翻转。| +可能被使用的接口返回值的枚举。 -**返回:** +**起始版本:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +10 -**参见:** +| 枚举值 | 描述 | +| -------- | -------- | +| IMAGE_RESULT_SUCCESS | 操作成功 | +| IMAGE_RESULT_BAD_PARAMETER | 无效参数 | +| IMAGE_RESULT_IMAGE_RESULT_BASE | 操作失败 | +| IMAGE_RESULT_ERR_IPC | ipc 错误 | +| IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST | 共享内存失败 | +| IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL | 共享内存数据异常 | +| IMAGE_RESULT_DECODE_ABNORMAL | 图像解码失败 | +| IMAGE_RESULT_DATA_ABNORMAL | 图像输入数据异常 | +| IMAGE_RESULT_MALLOC_ABNORMAL | 图像内存分配异常 | +| IMAGE_RESULT_DATA_UNSUPPORT | 图像类型不支持 | +| IMAGE_RESULT_INIT_ABNORMAL | 图像初始化失败 | +| IMAGE_RESULT_GET_DATA_ABNORMAL | 图像获取数据错误 | +| IMAGE_RESULT_TOO_LARGE | 图像数据过大 | +| IMAGE_RESULT_TRANSFORM | 图像转换错误 | +| IMAGE_RESULT_COLOR_CONVERT | 图像颜色转换错误 | +| IMAGE_RESULT_CROP | 裁剪错误 | +| IMAGE_RESULT_SOURCE_DATA | 图像源数据错误 | +| IMAGE_RESULT_SOURCE_DATA_INCOMPLETE | 图像源数据不完整 | +| IMAGE_RESULT_MISMATCHED_FORMAT | 图像格式不匹配 | +| IMAGE_RESULT_UNKNOWN_FORMAT | 图像未知格式 | +| IMAGE_RESULT_SOURCE_UNRESOLVED | 图像源未解析 | +| IMAGE_RESULT_INVALID_PARAMETER | 图像无效参数 | +| IMAGE_RESULT_DECODE_FAILED | 解码失败 | +| IMAGE_RESULT_PLUGIN_REGISTER_FAILED | 注册插件失败 | +| IMAGE_RESULT_PLUGIN_CREATE_FAILED | 创建插件失败 | +| IMAGE_RESULT_ENCODE_FAILED | 图像编码失败 | +| IMAGE_RESULT_ADD_PIXEL_MAP_FAILED | 图像添加像素位图失败 | +| IMAGE_RESULT_HW_DECODE_UNSUPPORT | 图像硬解码不支持 | +| IMAGE_RESULT_DECODE_HEAD_ABNORMAL | 图像头解码失败 | +| IMAGE_RESULT_DECODE_EXIF_UNSUPPORT | 图像解码EXIF不支持 | +| IMAGE_RESULT_PROPERTY_NOT_EXIST | 图像属性不存在 | +| IMAGE_RESULT_MEDIA_DATA_UNSUPPORT | 媒体类型不支持 | +| IMAGE_RESULT_MEDIA_TOO_LARGE | 媒体数据过大 | +| IMAGE_RESULT_MEDIA_MALLOC_FAILED | 媒体分配内存失败 | +| IMAGE_RESULT_MEDIA_END_OF_STREAM | 媒体数据流结束失败 | +| IMAGE_RESULT_MEDIA_IO_ABNORMAL | 媒体输入输出流异常 | +| IMAGE_RESULT_MEDIA_MALFORMED | 媒体功能异常 | +| IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL | 媒体数据过小错误 | +| IMAGE_RESULT_MEDIA_OUT_OF_RANGE | 媒体超出范围错误 | +| IMAGE_RESULT_MEDIA_STATUS_ABNORMAL | 媒体状态异常错误 | +| IMAGE_RESULT_MEDIA_VALUE_INVALID | 媒体值无效 | +| IMAGE_RESULT_MEDIA_NULL_POINTER | 媒体操作失败 | +| IMAGE_RESULT_MEDIA_INVALID_OPERATION | 媒体操作无效 | +| IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT | 媒体初始化异常 | +| IMAGE_RESULT_MEDIA_EARLY_PREPARE | 媒体过早预处理 | +| IMAGE_RESULT_MEDIA_SEEK_ERR | 媒体查找失败 | +| IMAGE_RESULT_MEDIA_PERMISSION_DENIED | 媒体权限拒绝 | +| IMAGE_RESULT_MEDIA_DEAD_OBJECT | 媒体对象注销 | +| IMAGE_RESULT_MEDIA_TIMED_OUT | 媒体超时 | +| IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED | 媒体能力不支持 | +| IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED | 媒体适配器初始化失败 | +| IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL | 写入parcel失败 | +| IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL | 读取parcel失败 | +| IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER | 无效数据 | +| IMAGE_RESULT_MEDIA_INVALID_PARAM | 媒体接口发现无效参数 | +| IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST | 媒体代码适配器不存在 | +| IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED | 媒体创建代码适配器失败 | +| IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT | 媒体代码适配器未初始化 | +| IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED | 媒体代码创建失败 | +| IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST | 媒体代码不存在 | +| IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST | 媒体JNI层类不存在 | +| IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST | 媒体JNI层方法不存在 | +| IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED | 媒体JNI层创建对象失败 | +| IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR | 媒体JNI层异常 | +| IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT | 媒体不支持分布 | +| IMAGE_RESULT_MEDIA_SOURCE_NOT_SET | 媒体源未设置 | +| IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT | 媒体rtsp适配器未初始化 | +| IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST | 媒体rtsp适配器不存在 | +| IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT | 媒体不支持rtsp surface | +| IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT | 媒体rtsp capture初始化失败 | +| IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID | 媒体rtsp源路径无效 | +| IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND | 媒体rtsp未发现视频能力 | +| IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX | rtsp相机数量达到最大数量 | +| IMAGE_RESULT_MEDIA_SET_VOLUME | 媒体设置卷失败 | +| IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW | 媒体操作次数溢出 | +| IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED | 媒体分布式播放器不支持 | +| IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED | 图像解码ICC失败 | +| IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED | 图像编码CC失败 | +| IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED | 读取像素位图失败 | +| IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED | 写入像素位图失败 | +| IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY | 像素位图不允许修改 | +| IMAGE_RESULT_MEDIA_CONFIG_FAILED | 配置失败 | +| IMAGE_RESULT_JNI_ENV_ABNORMAL | JNI环境异常 | +| IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED | surface申请内存失败 | +| IMAGE_RESULT_CREATE_SURFACE_FAILED | 创建surface失败 | +| IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED | 从surface获取参数失败 | +| IMAGE_RESULT_GET_SURFACE_FAILED | 获取sufrace失败 | +| IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED | 申请内存失败 | +| IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED | 申请内存失败 | +| IMAGE_RESULT_REGISTER_LISTENER_FAILED | 注册监听失败 | +| IMAGE_RESULT_REGISTER_BUFFER_FAILED | 注册内存失败 | +| IMAGE_RESULT_FREAD_FAILED | 读取文件失败 | +| IMAGE_RESULT_PEEK_FAILED | 检测文件失败 | +| IMAGE_RESULT_SEEK_FAILED | 查找文件失败 | +| IMAGE_RESULT_STREAM_SIZE_ERROR | 数据流损坏 | +| IMAGE_RESULT_FILE_FD_ERROR | 文件描述符损坏 | +| IMAGE_RESULT_FILE_DAMAGED | 文件损坏 | +| IMAGE_RESULT_CREATE_DECODER_FAILED | 创建解码失败 | +| IMAGE_RESULT_CREATE_ENCODER_FAILED | 创建编码失败 | +| IMAGE_RESULT_CHECK_FORMAT_ERROR | 检查格式失败 | +| IMAGE_RESULT_THIRDPART_SKIA_ERROR | skia解码失败 | +| IMAGE_RESULT_HW_DECODE_FAILED | 硬解码失败 | +| IMAGE_RESULT_ALLOCATER_TYPE_ERROR | 内存类型校验失败 | +| IMAGE_RESULT_ALPHA_TYPE_ERROR | 透明度类型失败 | +| IMAGE_RESULT_INDEX_INVALID | 参数无效 | +| IMAGE_RESULT_MEDIA_UNKNOWN | 媒体未知错误 | -Flip -**起始版本:** -10 +## 函数说明 -### OH_PixelMap_GetBytesNumberPerRow() +### OH_AccessPixels() - ``` -int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap * native, int32_t * num ) +int32_t OHOS::Media::OH_AccessPixels (napi_env env, napi_value value, void ** addrPtr ) ``` -**描述:** -获取**PixelMap**对象每行字节数. -**参数:** +**描述:** + +获取**PixelMap**对象数据的内存地址,并锁定该内存。 + +函数执行成功后,**\*addrPtr**就是获取的待访问的内存地址。访问操作完成后,必须要使用**OH_UnAccessPixels**来释放锁,否则的话资源无法被释放。 待解锁后,内存地址就不可以再被访问和操作。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| num | **PixelMap**对象的每行字节数指针。| +| env | napi的环境指针。 | +| value | 应用层的 **PixelMap** 对象。 | +| addrPtr | 用于指向的内存地址的双指针对象。 | -**返回:** +**返回:** -操作成功则返回 **PixelMap** 对象每行字节数; 如果操作失败,则返回错误码。 +操作成功则返回 **OHOS_IMAGE_RESULT_SUCCESS**;如果操作失败,则返回错误码。 -**参见:** +**起始版本:** -GetBytesNumberPerRow +8 + +**废弃起始版本:** -**起始版本:** 10 -### OH_PixelMap_GetDensity() +**参见:** + +UnAccessPixels + + +### OH_GetImageInfo() - ``` -int32_t OH_PixelMap_GetDensity (const NativePixelMap * native, int32_t * density ) +int32_t OHOS::Media::OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo * info ) ``` -**描述:** -获取**PixelMap**对象像素密度. -**参数:** +**描述:** + +获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)结构中。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| density | 像素密度指针。| +| env | napi的环境指针。 | +| value | 应用层的 **PixelMap** 对象。 | +| info | 用于保存信息的指针对象。 更多细节, 参看 [OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md)。 | -**返回:** +**返回:** + +如果获取并保存信息成功,则返回**0**; 如果操作失败,则返回错误码。 -操作成功则返回像素密度; 如果操作失败,则返回错误码。 +**起始版本:** -**参见:** +8 -GetDensity +**废弃起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_GetIsEditable() +[OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) + + +### OH_Image_ClipRect() - ``` -int32_t OH_PixelMap_GetIsEditable (const NativePixelMap * native, int32_t * editable ) +int32_t OHOS::Media::OH_Image_ClipRect (const ImageNative * native, struct OhosImageRect * rect ) ``` -**描述:** -获取**PixelMap**对象是否可编辑的状态. -**参数:** +**描述:** + +获取native **ImageNative** 对象 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 信息。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| editable | **PixelMap** 对象是否可编辑的指针。| +| native | 表示指向 **ImageNative** native层对象的指针。 | +| rect | 表示作为转换结果的 [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) 对象指针。 | -**返回:** +**返回:** -操作成功则返回编辑类型的枚举值; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功返回 IMAGE_RESULT_SUCCESS ; -GetIsEditable +如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED; + +如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。 + +**起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_InitNativePixelMap() +ImageNative, [OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) + + +### OH_Image_Format() - ``` -NativePixelMap* OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source ) +int32_t OHOS::Media::OH_Image_Format (const ImageNative * native, int32_t * format ) ``` -**描述:** -初始化**PixelMap**对象数据. -**参数:** +**描述:** + +获取native **ImageNative** 对象的图像格式。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| env | napi的环境指针。| -| source | **PixelMap** 数据设置项。| +| native | 表示 **ImageNative** native对象的指针。 | +| format | 表示作为转换结果的图像格式对象的指针。 | -**返回:** +**返回:** -操作成功则返回NativePixelMap的指针; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功返回 IMAGE_RESULT_SUCCESS ; -InitNativePixelMap +如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED; + +如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。 + +**起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_IsSupportAlpha() +ImageNative + + +### OH_Image_GetComponent() - ``` -int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap * native, int32_t * alpha ) +int32_t OHOS::Media::OH_Image_GetComponent (const ImageNative * native, int32_t componentType, struct OhosImageComponent * componentNative ) ``` -**描述:** -获取**PixelMap**对象是否支持Alpha通道. -**参数:** +**描述:** + +从 native **ImageNative** 对象中获取 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md)。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| alpha | 是否支持Alpha的指针。| +| native | 表示 **ImageNative** native对象的指针。 | +| componentType | 表示所需组件的组件类型。 | +| componentNative | 表示转换结果的 [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) 对象的指针。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功返回 IMAGE_RESULT_SUCCESS ; -IsSupportAlpha +如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED; + +如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。 + +**起始版本:** -**起始版本:** 10 +**参见:** +ImageNative, [OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) -### OH_PixelMap_Rotate() - +### OH_Image_InitImageNative() + ``` -int32_t OH_PixelMap_Rotate (const NativePixelMap * native, float angle ) +ImageNative* OHOS::Media::OH_Image_InitImageNative (napi_env env, napi_value source ) ``` -**描述:** -设置**PixelMap**对象的旋转. -**参数:** +**描述:** + +从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| angle | 旋转角度。| +| env | 表示指向 JNI 环境的指针。 | +| source | 表示 JavaScript Native API **图像** 对象。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +如果操作成果返回 **ImageNative** 指针对象,如果操作失败返回空指针。 -**参见:** +**起始版本:** -Rotate +10 + +**参见:** + +ImageNative, OH_Image_Release + + +### OH_Image_Receiver_CreateImageReceiver() + +``` +int32_t OH_Image_Receiver_CreateImageReceiver (napi_env env, struct OhosImageReceiverInfo info, napi_value * res ) +``` + +**描述:** + +创建应用层 **ImageReceiver** 对象。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | napi的环境指针。 | +| info | **ImageReceiver** 数据设置项。 | +| res | 应用层的 **ImageReceiver** 对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ; + +如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ; + +如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ; + +如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_Scale() +[OhosImageReceiverInfo](_ohos_image_receiver_info.md) + + +### OH_Image_Receiver_GetCapacity() - ``` -int32_t OH_PixelMap_Scale (const NativePixelMap * native, float x, float y ) +int32_t OH_Image_Receiver_GetCapacity (const ImageReceiverNative * native, int32_t * capacity ) ``` -**描述:** -设置**PixelMap**对象的缩放. -**参数:** +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的容量。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| x | 缩放宽度。| -| y | 缩放高度。| +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| capacity | 作为结果的指向容量的指针。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; -Scale +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_SetAlphaAble() +[ImageReceiverNative](#imagereceivernative), [OhosImageSize](_ohos_image_size.md) + + +### OH_Image_Receiver_GetFormat() - ``` -int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap * native, int32_t alpha ) +int32_t OH_Image_Receiver_GetFormat (const ImageReceiverNative * native, int32_t * format ) ``` -**描述:** -设置**PixelMap**对象的Alpha通道. -**参数:** +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的格式。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| alpha | Alpha通道。| +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| format | 作为结果的指向格式的指针。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; -SetAlphaAble +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** -### OH_PixelMap_SetDensity() +[ImageReceiverNative](#imagereceivernative) + + +### OH_Image_Receiver_GetReceivingSurfaceId() - ``` -int32_t OH_PixelMap_SetDensity (const NativePixelMap * native, int32_t density ) +int32_t OH_Image_Receiver_GetReceivingSurfaceId (const ImageReceiverNative * native, char * id, size_t len ) ``` -**描述:** -设置**PixelMap**对象像素密度. -**参数:** +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取receiver的id。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| density | 像素密度。| +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| id | 指向字符缓冲区的指针,用于获取字符串的id。 | +| len | **id**所对应的字符缓冲区的大小。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; -GetDensity +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** + +[ImageReceiverNative](#imagereceivernative) -### OH_PixelMap_SetOpacity() - +### OH_Image_Receiver_GetSize() + ``` -int32_t OH_PixelMap_SetOpacity (const NativePixelMap * native, float opacity ) +int32_t OH_Image_Receiver_GetSize (const ImageReceiverNative * native, struct OhosImageSize * size ) ``` -**描述:** -设置**PixelMap**对象的透明度. -**参数:** +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取**ImageReceiver**的大小。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| opacity | 透明度。| +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| size | 作为结果的[OhosImageSize](_ohos_image_size.md)指针。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; -SetOpacity +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** + +[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback) -### OH_PixelMap_Translate() - +### OH_Image_Receiver_InitImageReceiverNative() + ``` -int32_t OH_PixelMap_Translate (const NativePixelMap * native, float x, float y ) +ImageReceiverNative* OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source ) ``` -**描述:** -设置**PixelMap**对象的偏移. -**参数:** +**描述:** + +通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](#imagereceivernative)对象。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| native | NativePixelMap的指针。| -| x | 水平偏移量。| -| y | 垂直偏移量。| +| env | napi的环境指针。 | +| source | napi的 **ImageReceiver** 对象。 | -**返回:** +**返回:** -操作成功则返回**0**; 如果操作失败,则返回错误码。 +操作成功则返回 [ImageReceiverNative](#imagereceivernative) 指针;如果操作失败,则返回nullptr。 -**参见:** +**起始版本:** -Translate +10 + +**参见:** + +[ImageReceiverNative](#imagereceivernative), [OH_Image_Receiver_Release](#oh_image_receiver_release) + + +### OH_Image_Receiver_On() + +``` +int32_t OH_Image_Receiver_On (const ImageReceiverNative * native, OH_Image_Receiver_On_Callback callback ) +``` + +**描述:** + +注册一个[OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| callback | [OH_Image_Receiver_On_Callback](#oh_image_receiver_on_callback)事件的回调函数。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。 + +**起始版本:** -**起始版本:** 10 +**参见:** + +[ImageReceiverNative](#imagereceivernative) -### OH_UnAccessPixels() - +### OH_Image_Receiver_ReadLatestImage() + ``` -int32_t OH_UnAccessPixels (napi_env env, napi_value value ) +int32_t OH_Image_Receiver_ReadLatestImage (const ImageReceiverNative * native, napi_value * image ) ``` -**描述:** -释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](#oh_accesspixels). -**参数:** +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取最新的一张图片。 + +**参数:** | 名称 | 描述 | | -------- | -------- | -| env | napi的环境指针。| -| value | 应用层的 **PixelMap** 对象。| +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| image | 获取到的应用层的 **Image** 指针对象。 | -**返回:** +**返回:** -操作成功则返回 OHOS_IMAGE_RESULT_SUCCESS; 如果操作失败,则返回错误码。 +参考[IRNdkErrCode](#irndkerrcode)。 -**参见:** +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; -AccessPixels +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ; + +如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ; + +如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ; + +如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +[ImageReceiverNative](#imagereceivernative) + + +### OH_Image_Receiver_ReadNextImage() + +``` +int32_t OH_Image_Receiver_ReadNextImage (const ImageReceiverNative * native, napi_value * image ) +``` + +**描述:** + +通过[ImageReceiverNative](#imagereceivernative)获取下一张图片。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | +| image | 读取到的应用层的 **Image** 指针对象。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果创建surface失败则返回 IMAGE_RESULT_CREATE_SURFACE_FAILED ; + +如果surface分配内存失败则返回 IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED ; + +如果获取surface失败则返回 IMAGE_RESULT_GET_SURFACE_FAILED ; + +如果媒体rtsp surface不支持则返回 IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果媒体类型不支持失败则返回 IMAGE_RESULT_MEDIA_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +[ImageReceiverNative](#imagereceivernative) + + +### OH_Image_Receiver_Release() + +``` +int32_t OH_Image_Receiver_Release (ImageReceiverNative * native) +``` + +**描述:** + +释放native层 [ImageReceiverNative](#imagereceivernative) 对象。注意: 此方法不能释放应用层**ImageReceiver**对象。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | native层的[ImageReceiverNative](#imagereceivernative)指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像类型不支持失败则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +[ImageReceiverNative](#imagereceivernative) + + +### OH_Image_Release() + +``` +int32_t OHOS::Media::OH_Image_Release (ImageNative * native) +``` + +**描述:** + +释放 **ImageNative** native对象。 Note: 这个方法无法释放 JavaScript Native API **Image** 对象, 而是释放被 **OH_Image_InitImageNative** 解析的 **ImageNative** native 对象。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表示 **ImageNative** native对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回 IMAGE_RESULT_SUCCESS ; + +如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。 + +**起始版本:** + +10 + +**参见:** + +ImageNative, OH_Image_InitImageNative + + +### OH_Image_Size() + +``` +int32_t OHOS::Media::OH_Image_Size (const ImageNative * native, struct OhosImageSize * size ) +``` + +**描述:** + +获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表示 **ImageNative** native对象的指针。 | +| size | 表示作为转换结果的 [OhosImageSize](_ohos_image_size.md) 对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回 IMAGE_RESULT_SUCCESS ; + +如果JNI环境异常返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果从surface获取参数失败返回 IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED; + +如果参数错误返回 IMAGE_RESULT_BAD_PARAMETER 。 + +**起始版本:** + +10 + +**参见:** + +ImageNative, [OhosImageSize](_ohos_image_size.md) + + +### OH_ImageSource_Create() + +``` +int32_t OH_ImageSource_Create (napi_env env, struct OhosImageSource * src, struct OhosImageSourceOps * ops, napi_value * res ) +``` + +**描述:** + +通过给定的信息[OhosImageSource](_ohos_image_source.md) 和 [OhosImageSourceOps](_ohos_image_source_ops.md)结构体,获取JavaScript native层API** ImageSource**对象。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | 表明JNI环境的指针。 | +| src | 表明创建一个图像源的信息。查看[OhosImageSource](_ohos_image_source.md)获取更多细节。 | +| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 | +| res | 表明JavaScript native层API**ImageSource**对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE; + +如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA; + +如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST; + +如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED; + +如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR; + +如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR; + +如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED; + +如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED; + +如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。 + +**起始版本:** + +10 + +**参见:** + +[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md) + + +### OH_ImageSource_CreateIncremental() + +``` +int32_t OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource * source, struct OhosImageSourceOps * ops, napi_value * res ) +``` + +**描述:** + +通过给定的infomations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过**OH_ImageSource_UpdateData**更新。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | 表明JNI环境的指针。 | +| src | 表明创建一个图像源的信息。这里只接收缓冲区类型。查看[OhosImageSource](_ohos_image_source.md)获取更多细节 | +| ops | 表明创建一个图像源的选项。查看[OhosImageSourceOps](_ohos_image_source_ops.md)。 | +| res | 表明JavaScript native层API**ImageSource**对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果图像源数据不完整,返回IMAGE_RESULT_SOURCE_DATA_INCOMPLETE; + +如果图像源数据错误,返回IMAGE_RESULT_SOURCE_DATA; + +如果图像获取数据错误,返回IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果图像数据太大,返回IMAGE_RESULT_TOO_LARGE; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果图像解码 EXIF 不支持,返回IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图像属性不存在,返回IMAGE_RESULT_PROPERTY_NOT_EXIST; + +如果文件损坏,返回IMAGE_RESULT_FILE_DAMAGED; + +如果文件 FD 错误,返回IMAGE_RESULT_FILE_FD_ERROR; + +如果数据流错误,返回IMAGE_RESULT_STREAM_SIZE_ERROR; + +如果查找文件失败,返回IMAGE_RESULT_SEEK_FAILED; + +如果速览文件失败,返回IMAGE_RESULT_PEEK_FAILED; + +如果读取文件失败,返回IMAGE_RESULT_FREAD_FAILED。 + +**起始版本:** + +10 + +**参见:** + +[OhosImageSource](_ohos_image_source.md), [OhosImageSourceOps](_ohos_image_source_ops.md), [OH_ImageSource_UpdateData](#oh_imagesource_updatedata) + + +### OH_ImageSource_CreatePixelMap() + +``` +int32_t OH_ImageSource_CreatePixelMap (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res ) +``` + +**描述:** + +通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层[ImageSourceNative](#imagesourcenative)值的指针。 | +| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 | +| res | 表明JavaScript native层API**PixelMap**对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED; + +如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。 + +如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST; + +如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL; + +如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL; + +如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL; + +如果裁剪错误,返回 IMAGE_RESULT_CROP; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED; + +如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT; + +如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED; + +如果ipc失败,返回 IMAGE_RESULT_ERR_IPC; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR; + +如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md) + + +### OH_ImageSource_CreatePixelMapList() + +``` +int32_t OH_ImageSource_CreatePixelMapList (const ImageSourceNative * native, struct OhosImageDecodingOps * ops, napi_value * res ) +``` + +**描述:** + +通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| ops | 表明为了解码图像源的选项,查看[OhosImageDecodingOps](_ohos_image_decoding_ops.md)。 | +| res | 表明JavaScript native层API**PixelMap** 列表对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED; + +如果检查格式不对,返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST; + +如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL; + +如果图片解码异常,返回 IMAGE_RESULT_DECODE_ABNORMAL; + +如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL; + +如果裁剪错误,返回 IMAGE_RESULT_CROP; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED; + +如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT; + +如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED; + +如果ipc失败,返回 IMAGE_RESULT_ERR_IPC; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR; + +如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageDecodingOps](_ohos_image_decoding_ops.md) + + +### OH_ImageSource_GetDelayTime() + +``` +int32_t OH_ImageSource_GetDelayTime (const ImageSourceNative * native, struct OhosImageSourceDelayTimeList * res ) +``` + +**描述:** + +从一些**ImageSource**(如GIF图像源)获取延迟时间列表。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| res | 表明延迟时间列表 [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) 的指针。 当输入的res中**delayTimeList**是空指针并且**size**是0时,将通过res的**size**中返回延迟时间列表大小 为了获取延迟时间,需要比返回的**delayTimeList**大小值大的足够空间 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) + + +### OH_ImageSource_GetFrameCount() + +``` +int32_t OH_ImageSource_GetFrameCount (const ImageSourceNative * native, uint32_t * res ) +``` + +**描述:** + +从**ImageSource**中获取帧计数。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| res | 表明帧计数的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative) + + +### OH_ImageSource_GetImageInfo() + +``` +int32_t OH_ImageSource_GetImageInfo (const ImageSourceNative * native, int32_t index, struct OhosImageSourceInfo * info ) +``` + +**描述:** + +通过索引从**ImageSource**获取图像源信息。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| index | 表明帧计数的指针。 | +| info | 表明图像源信息[OhosImageSourceInfo](_ohos_image_source_info.md)的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageSourceInfo](_ohos_image_source_info.md) + + +### OH_ImageSource_GetImageProperty() + +``` +int32_t OH_ImageSource_GetImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value ) +``` + +**描述:** + +通过关键字从**ImageSource**中获取图像源属性。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 | +| value | 表明作为结果的属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 当输入的value中**value**是空指针并且**size**是0时,将通过value中的**size**返回属性值的大小。 为了获取属性值,需要比**value**中的结果大小大的足够的空间。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md) + + +### OH_ImageSource_GetSupportedFormats() + +``` +int32_t OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList * res) +``` + +**描述:** + +获取所有支持的解码格式元标记。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| res | 表明指向**[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md)**结构的列表指针。 当**supportedFormatList**为nullptr并且**size**以res为0作为输入时,它将以res** size**返回支持的格式大小。
为了获得所有的格式标记,它需要比**supportedFormatList**中的结果大小大的足够空间, 还需要为[OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md)项目中的每个格式提供足够的空间。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果检查格式不对,返回MAGE_RESULT_CHECK_FORMAT_ERROR。 + +**起始版本:** + +10 + +**参见:** + +[OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md), [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) + + +### OH_ImageSource_InitNative() + +``` +ImageSourceNative* OH_ImageSource_InitNative (napi_env env, napi_value source ) +``` + +**描述:** + +从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](#imagesourcenative)值。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | 表明JNI环境的指针。 | +| source | 表明JavaScript native层API** ImageSource**对象的指针。 | + +**返回:** + +如果操作成功返回[ImageSourceNative](#imagesourcenative)指针;如果操作失败,返回空指针。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Release](#oh_imagesource_release) + + +### OH_ImageSource_ModifyImageProperty() + +``` +int32_t OH_ImageSource_ModifyImageProperty (const ImageSourceNative * native, struct OhosImageSourceProperty * key, struct OhosImageSourceProperty * value ) +``` + +**描述:** + +通过关键字为**ImageSource**修改图像源属性。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针 | +| key | 表明属性关键字[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 | +| value | 为了修改表明属性值[OhosImageSourceProperty](_ohos_image_source_property.md)的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果图片解码异常, IMAGE_RESULT_DECODE_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果解码的EXIF不支持,返回 IMAGE_RESULT_DECODE_EXIF_UNSUPPORT; + +如果图片属性不存在,返回 IMAGE_RESULT_PROPERTY_NOT_EXIST。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageSourceProperty](_ohos_image_source_property.md) + + +### OH_ImageSource_Release() + +``` +int32_t OH_ImageSource_Release (ImageSourceNative * native) +``` + +**描述:** + +释放native层图像源 **ImageSourceNative**。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OH_ImageSource_Create](#oh_imagesource_create), [OH_ImageSource_CreateIncremental](#oh_imagesource_createincremental) + + +### OH_ImageSource_UpdateData() + +``` +int32_t OH_ImageSource_UpdateData (const ImageSourceNative * native, struct OhosImageSourceUpdateData * data ) +``` + +**描述:** + +为了增量类型的**ImageSource**更新源数据。 + +\@Syscap SystemCapability.Multimedia.Image + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | 表明native层 [ImageSourceNative](#imagesourcenative) 值的指针。 | +| data | 表明更新数据信息[OhosImageSourceUpdateData](_ohos_image_source_update_data.md)的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功返回OHOS_IMAGE_RESULT_SUCCESS; + +如果参数错误,返回IMAGE_RESULT_BAD_PARAMETER; + +如果 JNI 环境异常,返回IMAGE_RESULT_JNI_ENV_ABNORMAL; + +如果参数无效,IMAGE_RESULT_INVALID_PARAMETER; + +如果获取图片数据异常,返回 IMAGE_RESULT_GET_DATA_ABNORMAL; + +如果解码失败,返回IMAGE_RESULT_DECODE_FAILED; + +如果图像解码头错误,返回IMAGE_RESULT_DECODE_HEAD_ABNORMAL; + +如果创建解码器失败,返回 IMAGE_RESULT_CREATE_DECODER_FAILED; + +如果创建编码器失败,返回 IMAGE_RESULT_CREATE_ENCODER_FAILED; + +如果检查格式不对,返回IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia错误,返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR; + +如果输入图片数据错误,返回 IMAGE_RESULT_DATA_ABNORMAL; + +如果共享内存错误,返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST; + +如果共享内存数据异常,返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL; + +如果图片解码异常,返回IMAGE_RESULT_DECODE_ABNORMAL; + +如果图像错误,返回 IMAGE_RESULT_MALLOC_ABNORMAL; + +如果图片初始化错误,返回 IMAGE_RESULT_DATA_UNSUPPORT; + +如果图片输入数据错误,返回 IMAGE_RESULT_INIT_ABNORMAL; + +如果裁剪错误,返回 IMAGE_RESULT_CROP; + +如果图片格式未知,返回 IMAGE_RESULT_UNKNOWN_FORMAT; + +如果注册插件失败,返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED; + +如果创建插件失败。返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED; + +如果增加位图失败,返回 IMAGE_RESULT_ENCODE_FAILED; + +如果不支持图片硬解码,返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT; + +如果硬解码失败,返回 IMAGE_RESULT_HW_DECODE_FAILED; + +如果ipc失败,返回 IMAGE_RESULT_ERR_IPC; + +如果索引无效,返回 IMAGE_RESULT_INDEX_INVALID; + +如果透明度类型错误,返回 IMAGE_RESULT_ALPHA_TYPE_ERROR; + +如果内存分配类型错误,返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR。 + +**起始版本:** + +10 + +**参见:** + +[ImageSourceNative](#imagesourcenative), [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) + + +### OH_PixelMap_AccessPixels() + +``` +int32_t OH_PixelMap_AccessPixels (const NativePixelMap * native, void ** addr ) +``` + +**描述:** + +获取native **PixelMap** 对象数据的内存地址,并锁定该内存。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| addr | 用于指向的内存地址的双指针对象。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +AccessPixels + + +### OH_PixelMap_CreateAlphaPixelMap() + +``` +int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value * alpha ) +``` + +**描述:** + +根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | napi的环境指针。 | +| source | **PixelMap**数据设置项。 | +| alpha | alpha通道的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ; + +如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ; + +如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果图像添加像素位图失败则返回 IMAGE_RESULT_ENCODE_FAILED ; + +如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ; + +如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ; + +如果ipc失败则返回 IMAGE_RESULT_INDEX_INVALID ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +CreateAlphaPixelMap + + +### OH_PixelMap_CreatePixelMap() + +``` +int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void * buf, size_t len, napi_value * res ) +``` + +**描述:** + +Creates a **PixelMap** object. + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | napi的环境指针。 | +| info | pixel map 数据设置项。 | +| buf | 图片的buffer数据。 | +| len | 图片大小信息。 | +| res | 应用层的 **PixelMap** 对象的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果图像头解码失败则返回 IMAGE_RESULT_DECODE_HEAD_ABNORMAL ; + +如果创建解码器失败则返回 IMAGE_RESULT_CREATE_DECODER_FAILED ; + +如果创建编码器失败则返回 IMAGE_RESULT_CREATE_ENCODER_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像解码失败则返回 IMAGE_RESULT_DECODE_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果图像添加像素位图失败则返回 IMAGE_RESULT_ENCODE_FAILED ; + +如果图像不支持硬件解码则返回 IMAGE_RESULT_HW_DECODE_UNSUPPORT ; + +如果硬件解码失败则返回 IMAGE_RESULT_HW_DECODE_FAILED ; + +如果ipc失败则返回 IMAGE_RESULT_INDEX_INVALID ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +CreatePixelMap + + +### OH_PixelMap_Crop() + +``` +int32_t OH_PixelMap_Crop (const NativePixelMap * native, int32_t x, int32_t y, int32_t width, int32_t height ) +``` + +**描述:** + +设置**PixelMap**对象的裁剪。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| x | 目标图片左上角的x坐标。 | +| y | 目标图片左上角的y坐标。 | +| width | 裁剪区域的宽度。 | +| height | 裁剪区域的高度。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +Crop + + +### OH_PixelMap_Flip() + +``` +int32_t OH_PixelMap_Flip (const NativePixelMap * native, int32_t x, int32_t y ) +``` + +**描述:** + +设置**PixelMap**对象的翻转。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| x | 根据水平方向x轴进行图片翻转。 | +| y | 根据垂直方向y轴进行图片翻转。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +Flip + + +### OH_PixelMap_GetBytesNumberPerRow() + +``` +int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap * native, int32_t * num ) +``` + +**描述:** + +获取**PixelMap**对象每行字节数。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| num | **PixelMap**对象的每行字节数指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +GetBytesNumberPerRow + + +### OH_PixelMap_GetDensity() + +``` +int32_t OH_PixelMap_GetDensity (const NativePixelMap * native, int32_t * density ) +``` + +**描述:** + +获取**PixelMap**对象像素密度。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| density | 像素密度指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +GetDensity + + +### OH_PixelMap_GetImageInfo() + +``` +int32_t OH_PixelMap_GetImageInfo (const NativePixelMap * native, OhosPixelMapInfos * info ) +``` + +**描述:** + +获取**PixelMap**对象图像信息。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| info | 图像信息指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +[OhosPixelMapInfos](_ohos_pixel_map_infos.md) + + +### OH_PixelMap_GetIsEditable() + +``` +int32_t OH_PixelMap_GetIsEditable (const NativePixelMap * native, int32_t * editable ) +``` + +**描述:** + +获取**PixelMap**对象是否可编辑的状态。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| editable | **PixelMap** 对象是否可编辑的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +GetIsEditable + + +### OH_PixelMap_InitNativePixelMap() + +``` +NativePixelMap* OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source ) +``` + +**描述:** + +初始化**PixelMap**对象数据。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | napi的环境指针。 | +| source | **PixelMap** 数据设置项。 | + +**返回:** + +操作成功则返回NativePixelMap的指针;如果操作失败,则返回错误码。 + +**起始版本:** + +10 + +**参见:** + +InitNativePixelMap + + +### OH_PixelMap_IsSupportAlpha() + +``` +int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap * native, int32_t * alpha ) +``` + +**描述:** + +获取**PixelMap**对象是否支持Alpha通道。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| alpha | 是否支持Alpha的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +IsSupportAlpha + + +### OH_PixelMap_Rotate() + +``` +int32_t OH_PixelMap_Rotate (const NativePixelMap * native, float angle ) +``` + +**描述:** + +设置**PixelMap**对象的旋转。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| angle | 旋转角度。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +Rotate + + +### OH_PixelMap_Scale() + +``` +int32_t OH_PixelMap_Scale (const NativePixelMap * native, float x, float y ) +``` + +**描述:** + +设置**PixelMap**对象的缩放。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| x | 缩放宽度。 | +| y | 缩放高度。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果图像初始化失败则返回 IMAGE_RESULT_INIT_ABNORMAL ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +Scale + + +### OH_PixelMap_SetAlphaAble() + +``` +int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap * native, int32_t alpha ) +``` + +**描述:** + +设置**PixelMap**对象的Alpha通道。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| alpha | Alpha通道。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +SetAlphaAble + + +### OH_PixelMap_SetDensity() + + +``` +int32_t OH_PixelMap_SetDensity (const NativePixelMap * native, int32_t density ) +``` + +**描述:** + +设置**PixelMap**对象像素密度。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| density | 像素密度。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +GetDensity + + +### OH_PixelMap_SetOpacity() + +``` +int32_t OH_PixelMap_SetOpacity (const NativePixelMap * native, float opacity ) +``` + +**描述:** + +设置**PixelMap**对象的透明度。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| opacity | 透明度。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT 。 + +**起始版本:** + +10 + +**参见:** + +SetOpacity + + +### OH_PixelMap_Translate() + +``` +int32_t OH_PixelMap_Translate (const NativePixelMap * native, float x, float y ) +``` + +**描述:** + +设置**PixelMap**对象的偏移。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | +| x | 水平偏移量。 | +| y | 垂直偏移量。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +Translate + + +### OH_PixelMap_UnAccessPixels() + +``` +int32_t OH_PixelMap_UnAccessPixels (const NativePixelMap * native) +``` + +**描述:** + +释放native **PixelMap**对象数据的内存锁,用于匹配方法[OH_PixelMap_AccessPixels](#oh_pixelmap_accesspixels)。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| native | NativePixelMap的指针。 | + +**返回:** + +参考[IRNdkErrCode](#irndkerrcode)。 + +如果操作成功则返回 IMAGE_RESULT_SUCCESS ; + +如果参数错误则返回 IMAGE_RESULT_BAD_PARAMETER ; + +如果JNI环境异常则返回 IMAGE_RESULT_JNI_ENV_ABNORMAL ; + +如果参数无效则返回 IMAGE_RESULT_INVALID_PARAMETER ; + +如果图像获取数据失败则返回 IMAGE_RESULT_GET_DATA_ABNORMAL ; + +如果解码失败则返回 IMAGE_RESULT_DECODE_FAILED ; + +如果检查格式失败则返回 IMAGE_RESULT_CHECK_FORMAT_ERROR ; + +如果skia能力失败则返回 IMAGE_RESULT_THIRDPART_SKIA_ERROR ; + +如果图像输入数据失败则返回 IMAGE_RESULT_DATA_ABNORMAL ; + +如果共享内存失败则返回 IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST ; + +如果共享内存数据错误则返回 IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL ; + +如果图像分配内存失败则返回 IMAGE_RESULT_MALLOC_ABNORMAL ; + +如果图像数据不支持则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果裁剪失败失败则返回 IMAGE_RESULT_CROP ; + +如果图像格式未知则返回 IMAGE_RESULT_UNKNOWN_FORMAT ; + +如果注册插件失败失败则返回 IMAGE_RESULT_PLUGIN_REGISTER_FAILED ; + +如果创建插件失败失败则返回 IMAGE_RESULT_PLUGIN_CREATE_FAILED ; + +如果属性无效则返回 IMAGE_RESULT_DATA_UNSUPPORT ; + +如果透明度类型错误则返回 IMAGE_RESULT_ALPHA_TYPE_ERROR ; + +如果内存分配类型错误则返回 IMAGE_RESULT_ALLOCATER_TYPE_ERROR 。 + +**起始版本:** + +10 + +**参见:** + +UnAccessPixels + + +### OH_UnAccessPixels() + +``` +int32_t OHOS::Media::OH_UnAccessPixels (napi_env env, napi_value value ) +``` + +**描述:** + +释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。 + +**参数:** + +| 名称 | 描述 | +| -------- | -------- | +| env | napi的环境指针。 | +| value | 应用层的 **PixelMap** 对象。 | + +**返回:** + +操作成功则返回 **OHOS_IMAGE_RESULT_SUCCESS**;如果操作失败,则返回错误码。 + +**起始版本:** + +8 + +**废弃起始版本:** + +10 + +**参见:** + +AccessPixels + + +## 变量说明 + + +### alphaType + +``` +int32_t OhosImageSourceInfo::alphaType +``` + +**描述:** + +图像源透明度类型 + +**起始版本:** + +10 + + +### buffer [1/2] + +``` +uint8_t* OhosImageSource::buffer = nullptr +``` + +**描述:** + +图像源缓冲区资源,解手格式化包缓冲区或者base64缓冲区 + +**起始版本:** + +10 + + +### buffer [2/2] + +``` +uint8_t* OhosImageSourceUpdateData::buffer = nullptr +``` + +**描述:** + +图像源更新数据缓冲区 + +**起始版本:** + +10 + + +### bufferSize [1/2] + +``` +size_t OhosImageSource::bufferSize = 0 +``` + +**描述:** + +图像源缓冲区资源大小 + +**起始版本:** + +10 + + +### bufferSize [2/2] + +``` +size_t OhosImageSourceUpdateData::bufferSize = 0 +``` + +**描述:** + +图像源更新数据缓冲区大小 + +**起始版本:** + +10 + + +### colorSpace + +``` +int32_t OhosImageSourceInfo::colorSpace +``` + +**描述:** + +图像源色彩空间 + +**起始版本:** + +10 + + +### delayTimeList + +``` +int32_t* OhosImageSourceDelayTimeList::delayTimeList +``` + +**描述:** + +图像源延迟时间列表头地址 + +**起始版本:** + +10 + + +### density [1/2] + +``` +int32_t OhosImageSourceOps::density +``` + +**描述:** + +图像源像素密度 + +**起始版本:** + +10 + + +### density [2/2] + +``` +int32_t OhosImageSourceInfo::density +``` + +**描述:** + +图像源密度, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 + +**起始版本:** + +10 + + +### editable + +``` +int8_t OhosImageDecodingOps::editable +``` + +**描述:** + +定义输出的像素位图是否可编辑 + +**起始版本:** + +10 + + +### fd + +``` +int32_t OhosImageSource::fd = -1 +``` + +**描述:** + +图像源文件资源描述符 + +**起始版本:** + +10 + + +### fitDensity + +``` +int32_t OhosImageDecodingOps::fitDensity +``` + +**描述:** + +定义解码目标的像素密度 + +**起始版本:** + +10 + + +### format + +``` +char* OhosImageSourceSupportedFormat::format = nullptr +``` + +**描述:** + +图像源支持的格式字符串头地址 + +**起始版本:** + +10 + + +### height + +``` +int32_t OhosImageRegion::height +``` + +**描述:** + +高度范围,用pixels表示 + +**起始版本:** + +10 + + +### index + +``` +uint32_t OhosImageDecodingOps::index +``` + +**描述:** + +定义图像源解码指数 + +**起始版本:** + +10 + + +### isCompleted + +``` +int8_t OhosImageSourceUpdateData::isCompleted = 0 +``` + +**描述:** + +图像源更新数据在此节中完成 + +**起始版本:** + +10 + + +### offset + +``` +uint32_t OhosImageSourceUpdateData::offset = 0 +``` + +**描述:** + +图像源更新数据缓冲区的开端 + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE + +``` +const char* OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample" +``` + +**描述:** + +定义每个样本比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL + +``` +const char* OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel" +``` + +**描述:** + +定义每个像素的压缩比特的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL + +``` +const char* OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal" +``` + +**描述:** + +定义初始日期时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_EXPOSURE_TIME + +``` +const char* OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime" +``` + +**描述:** + +定义曝光时间的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_F_NUMBER + +``` +const char* OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber" +``` + +**描述:** + +定义FNumber的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_GPS_LATITUDE + +``` +const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude" +``` + +**描述:** + +定义GPS纬度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF + +``` +const char* OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef" +``` + +**描述:** + +定义GPS纬度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE + +``` +const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude" +``` + +**描述:** + +定义GPS经度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF + +``` +const char* OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef" +``` + +**描述:** + +定义GPS经度参考的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_IMAGE_LENGTH + +``` +const char* OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength" +``` + +**描述:** + +定义图像长度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_IMAGE_WIDTH + +``` +const char* OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth" +``` + +**描述:** + +定义图像宽度的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS + +``` +const char* OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings" +``` + +**描述:** + +定义ISO速度等级的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_ORIENTATION + +``` +const char* OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation" +``` + +**描述:** + +定义方向的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### OHOS_IMAGE_PROPERTY_SCENE_TYPE + +``` +const char* OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType" +``` + +**描述:** + +定义场景类型的图像属性关键字。 此标签给[OH_ImageSource_GetImageProperty](#oh_imagesource_getimageproperty)和[OH_ImageSource_ModifyImageProperty](#oh_imagesource_modifyimageproperty)这两个接口使用。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + + +### pixelFormat [1/3] + +``` +int32_t OhosImageSourceOps::pixelFormat +``` + +**描述:** + +图像源像素格式,通常用于描述YUV缓冲区 + +**起始版本:** + +10 + + +### pixelFormat [2/3] + +``` +int32_t OhosImageDecodingOps::pixelFormat +``` + +**描述:** + +定义输出的像素格式 + +**起始版本:** + +10 + + +### pixelFormat [3/3] + +``` +int32_t OhosImageSourceInfo::pixelFormat +``` + +**描述:** + +图像源像素格式, 由 [OH_ImageSource_Create](#oh_imagesource_create) 设置 + +**起始版本:** + +10 + + +### region + +``` +struct OhosImageRegion OhosImageDecodingOps::region +``` + +**描述:** + +定义图像源解码的像素范围 + +**起始版本:** + +10 + + +### rotate + +``` +uint32_t OhosImageDecodingOps::rotate +``` + +**描述:** + +定义解码旋转选项 + +**起始版本:** + +10 + + +### sampleSize + +``` +uint32_t OhosImageDecodingOps::sampleSize +``` + +**描述:** + +定义解码样本大小选项 + +**起始版本:** + +10 + + +### size [1/7] + +``` +struct OhosImageSize OhosImageSourceOps::size +``` + +**描述:** + +图像源像素宽高的大小 + +**起始版本:** + +10 + + +### size [2/7] + +``` +struct OhosImageSize OhosImageDecodingOps::size +``` + +**描述:** + +定义解码目标像素宽高的大小 + +**起始版本:** + +10 + + +### size [3/7] + +``` +struct OhosImageSize OhosImageSourceInfo::size +``` + +**描述:** + +图像源像素宽高的大小 + +**起始版本:** + +10 + + +### size [4/7] + +``` +size_t OhosImageSourceDelayTimeList::size = 0 +``` + +**描述:** + +图像源延迟时间列表大小 + +**起始版本:** + +10 + + +### size [5/7] + +``` +size_t OhosImageSourceSupportedFormat::size = 0 +``` + +**描述:** + +图像源支持的格式字符串大小 + +**起始版本:** + +10 + + +### size [6/7] + +``` +size_t OhosImageSourceSupportedFormatList::size = 0 +``` + +**描述:** + +图像源支持的格式字符串列表大小 + +**起始版本:** + +10 + + +### size [7/7] + +``` +size_t OhosImageSourceProperty::size = 0 +``` + +**描述:** + +定义图像源属性键值字符串大小 + +**起始版本:** + +10 + + +### supportedFormatList + +``` +struct OhosImageSourceSupportedFormat** OhosImageSourceSupportedFormatList::supportedFormatList = nullptr +``` + +**描述:** + +图像源支持的格式字符串列表头地址 + +**起始版本:** + +10 + + +### updateLength + +``` +uint32_t OhosImageSourceUpdateData::updateLength = 0 +``` + +**描述:** + +图像源更新数据缓冲区的更新数据长度 + +**起始版本:** + +10 + + +### uri + +``` +char* OhosImageSource::uri = nullptr +``` + +**描述:** + +图像源资源标识符,接受文件资源或者base64资源 + +**起始版本:** + +10 + + +### uriSize + +``` +size_t OhosImageSource::uriSize = 0 +``` + +**描述:** + +图像源资源长度 + +**起始版本:** + +10 + + +### value + +``` +char* OhosImageSourceProperty::value = nullptr +``` + +**描述:** + +定义图像源属性键值字符串头地址 + +**起始版本:** + +10 + + +### width + +``` +int32_t OhosImageRegion::width +``` + +**描述:** + +宽度范围,用pixels表示 + +**起始版本:** + +10 + + +### x + +``` +int32_t OhosImageRegion::x +``` + +**描述:** + +起始x坐标,用pixels表示 + +**起始版本:** + +10 + + +### y + +``` +int32_t OhosImageRegion::y +``` + +**描述:** + +起始y坐标,用pixels表示 + +**起始版本:** + +10 -**起始版本:** -8 diff --git a/zh-cn/application-dev/reference/native-apis/image__mdk_8h.md b/zh-cn/application-dev/reference/native-apis/image__mdk_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..b0799afdd268114ff08c9ac17c5764bffe3389fd --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/image__mdk_8h.md @@ -0,0 +1,52 @@ +# image_mdk.h + + +## 概述 + +声明访问图像剪辑矩形、大小、格式和组件数据的函数。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 结构体 + +| 名称 | 描述 | +| -------- | -------- | +| [OHOS::Media::OhosImageRect](_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) | 定义图像矩形信息。 | +| [OHOS::Media::OhosImageComponent](_o_h_o_s_1_1_media_1_1_ohos_image_component.md) | 定义图像组成信息。 | + + +### 类型定义 + +| 名称 | 描述 | +| -------- | -------- | +| [OHOS::Media::ImageNative](image.md#imagenative) | 为图像接口定义native层图像对象。 | + + +### 枚举 + +| 名称 | 描述 | +| -------- | -------- | +| { [OHOS::Media::OHOS_IMAGE_FORMAT_YCBCR_422_SP](image.md) = 1000,
[OHOS::Media::OHOS_IMAGE_FORMAT_JPEG](image.md) = 2000, } | 图像格式枚举值。 | +| { [OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y](image.md) = 1,
[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_U](image.md) = 2,
[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_YUV_V](image.md) = 3,
[OHOS::Media::OHOS_IMAGE_COMPONENT_FORMAT_JPEG](image.md) = 4, } | 图像组成类型枚举值。 | + + +### 函数 + +| 名称 | 描述 | +| -------- | -------- | +| [OHOS::Media::OH_Image_InitImageNative](image.md#oh_image_initimagenative) (napi_env env, napi_value source) | 从输入的JavaScript Native API **图像** 对象中解析 native **ImageNative** 对象。 | +| [OHOS::Media::OH_Image_ClipRect](image.md#oh_image_cliprect) (const [ImageNative](image.md#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) 信息。 | +| [OHOS::Media::OH_Image_Size](image.md#oh_image_size) (const [ImageNative](image.md#imagenative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 获取native **ImageNative** 对象的 [OhosImageSize](_ohos_image_size.md) 信息。 | +| [OHOS::Media::OH_Image_Format](image.md#oh_image_format) (const [ImageNative](image.md#imagenative) \*native, int32_t \*format) | 获取native **ImageNative** 对象的图像格式。 | +| [OHOS::Media::OH_Image_GetComponent](image.md#oh_image_getcomponent) (const [ImageNative](image.md#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)。 | +| [OHOS::Media::OH_Image_Release](image.md#oh_image_release) ([ImageNative](image.md#imagenative) \*native) | 释放 **ImageNative** native对象。 | diff --git a/zh-cn/application-dev/reference/native-apis/image__mdk__common_8h.md b/zh-cn/application-dev/reference/native-apis/image__mdk__common_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..485d3215454a4ae2fb53ddc325a09cb361389620 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/image__mdk__common_8h.md @@ -0,0 +1,36 @@ +# image_mdk_common.h + + +## 概述 + +声明图像常用的枚举值和结构体。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 结构体 + +| 名称 | 描述 | +| -------- | -------- | +| [OhosImageSize](_ohos_image_size.md) | 定义图像大小。 | + +### 宏定义 + +| 名称 | 描述 | +| -------- | -------- | +| **IMAGE_RESULT_BASE** 62980096 | 接口返回值的基础值 | + +### 枚举 + +| 名称 | 描述 | +| -------- | -------- | +| [IRNdkErrCode](image.md#irndkerrcode) {
IMAGE_RESULT_SUCCESS = 0,
IMAGE_RESULT_BAD_PARAMETER = -1,
IMAGE_RESULT_IMAGE_RESULT_BASE = IMAGE_RESULT_BASE,
IMAGE_RESULT_ERR_IPC = IMAGE_RESULT_BASE + 1,
IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST = IMAGE_RESULT_BASE + 2,
IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL = IMAGE_RESULT_BASE + 3,
IMAGE_RESULT_DECODE_ABNORMAL = IMAGE_RESULT_BASE + 4,
IMAGE_RESULT_DATA_ABNORMAL = IMAGE_RESULT_BASE + 5,
IMAGE_RESULT_MALLOC_ABNORMAL = IMAGE_RESULT_BASE + 6,
IMAGE_RESULT_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 7,
IMAGE_RESULT_INIT_ABNORMAL = IMAGE_RESULT_BASE + 8,
IMAGE_RESULT_GET_DATA_ABNORMAL = IMAGE_RESULT_BASE + 9,
IMAGE_RESULT_TOO_LARGE = IMAGE_RESULT_BASE + 10,
IMAGE_RESULT_TRANSFORM = IMAGE_RESULT_BASE + 11,
IMAGE_RESULT_COLOR_CONVERT = IMAGE_RESULT_BASE + 12,
IMAGE_RESULT_CROP = IMAGE_RESULT_BASE + 13,
IMAGE_RESULT_SOURCE_DATA = IMAGE_RESULT_BASE + 14,
IMAGE_RESULT_SOURCE_DATA_INCOMPLETE = IMAGE_RESULT_BASE + 15,
IMAGE_RESULT_MISMATCHED_FORMAT = IMAGE_RESULT_BASE + 16,
IMAGE_RESULT_UNKNOWN_FORMAT = IMAGE_RESULT_BASE + 17,
IMAGE_RESULT_SOURCE_UNRESOLVED = IMAGE_RESULT_BASE + 18,
IMAGE_RESULT_INVALID_PARAMETER = IMAGE_RESULT_BASE + 19,
IMAGE_RESULT_DECODE_FAILED = IMAGE_RESULT_BASE + 20,
IMAGE_RESULT_PLUGIN_REGISTER_FAILED = IMAGE_RESULT_BASE + 21,
IMAGE_RESULT_PLUGIN_CREATE_FAILED = IMAGE_RESULT_BASE + 22,
IMAGE_RESULT_ENCODE_FAILED = IMAGE_RESULT_BASE + 23,
IMAGE_RESULT_ADD_PIXEL_MAP_FAILED = IMAGE_RESULT_BASE + 24,
IMAGE_RESULT_HW_DECODE_UNSUPPORT = IMAGE_RESULT_BASE + 25,
IMAGE_RESULT_DECODE_HEAD_ABNORMAL = IMAGE_RESULT_BASE + 26,
IMAGE_RESULT_DECODE_EXIF_UNSUPPORT = IMAGE_RESULT_BASE + 27,
IMAGE_RESULT_PROPERTY_NOT_EXIST = IMAGE_RESULT_BASE + 28,
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT = IMAGE_RESULT_BASE + 30,
IMAGE_RESULT_MEDIA_TOO_LARGE = IMAGE_RESULT_BASE + 31,
IMAGE_RESULT_MEDIA_MALLOC_FAILED = IMAGE_RESULT_BASE + 32,
IMAGE_RESULT_MEDIA_END_OF_STREAM = IMAGE_RESULT_BASE + 33,
IMAGE_RESULT_MEDIA_IO_ABNORMAL = IMAGE_RESULT_BASE + 34,
IMAGE_RESULT_MEDIA_MALFORMED = IMAGE_RESULT_BASE + 35,
IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL = IMAGE_RESULT_BASE + 36,
IMAGE_RESULT_MEDIA_OUT_OF_RANGE = IMAGE_RESULT_BASE + 37,
IMAGE_RESULT_MEDIA_STATUS_ABNORMAL = IMAGE_RESULT_BASE + 38,
IMAGE_RESULT_MEDIA_VALUE_INVALID = IMAGE_RESULT_BASE + 39,
IMAGE_RESULT_MEDIA_NULL_POINTER = IMAGE_RESULT_BASE + 40,
IMAGE_RESULT_MEDIA_INVALID_OPERATION = IMAGE_RESULT_BASE + 41,
IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT = IMAGE_RESULT_BASE + 42,
IMAGE_RESULT_MEDIA_EARLY_PREPARE = IMAGE_RESULT_BASE + 43,
IMAGE_RESULT_MEDIA_SEEK_ERR = IMAGE_RESULT_BASE + 44,
IMAGE_RESULT_MEDIA_PERMISSION_DENIED = IMAGE_RESULT_BASE + 45,
IMAGE_RESULT_MEDIA_DEAD_OBJECT = IMAGE_RESULT_BASE + 46,
IMAGE_RESULT_MEDIA_TIMED_OUT = IMAGE_RESULT_BASE + 47,
IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED = IMAGE_RESULT_BASE + 48,
IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED = IMAGE_RESULT_BASE + 49,
IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL = IMAGE_RESULT_BASE + 50,
IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL = IMAGE_RESULT_BASE + 51,
IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER = IMAGE_RESULT_BASE + 52,
IMAGE_RESULT_MEDIA_INVALID_PARAM = IMAGE_RESULT_BASE + 53, IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 54,
IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED = IMAGE_RESULT_BASE + 55,
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 56,
IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED = IMAGE_RESULT_BASE + 57,
IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST = IMAGE_RESULT_BASE + 58,
IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST = IMAGE_RESULT_BASE + 59,
IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST = IMAGE_RESULT_BASE + 60,
IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED = IMAGE_RESULT_BASE + 61,
IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR = IMAGE_RESULT_BASE + 62,
IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT = IMAGE_RESULT_BASE + 63,
IMAGE_RESULT_MEDIA_SOURCE_NOT_SET = IMAGE_RESULT_BASE + 64,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT = IMAGE_RESULT_BASE + 65,
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST = IMAGE_RESULT_BASE + 66,
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT = IMAGE_RESULT_BASE + 67,
IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT = IMAGE_RESULT_BASE + 68,
IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID = IMAGE_RESULT_BASE + 69,
IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND = IMAGE_RESULT_BASE + 70,
IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX = IMAGE_RESULT_BASE + 71,
IMAGE_RESULT_MEDIA_SET_VOLUME = IMAGE_RESULT_BASE + 72,
IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW = IMAGE_RESULT_BASE + 73,
IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED = IMAGE_RESULT_BASE + 74,
IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 75,
IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED = IMAGE_RESULT_BASE + 76,
IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 150,
IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED = IMAGE_RESULT_BASE + 151,
IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY = IMAGE_RESULT_BASE + 152,
IMAGE_RESULT_MEDIA_CONFIG_FAILED = IMAGE_RESULT_BASE + 153,
IMAGE_RESULT_JNI_ENV_ABNORMAL = IMAGE_RESULT_BASE + 154,
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED = IMAGE_RESULT_BASE + 155,
IMAGE_RESULT_CREATE_SURFACE_FAILED = IMAGE_RESULT_BASE + 156,
IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED = IMAGE_RESULT_BASE + 157,
IMAGE_RESULT_GET_SURFACE_FAILED = IMAGE_RESULT_BASE + 158,
IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED = IMAGE_RESULT_BASE + 159,
IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED = IMAGE_RESULT_BASE + 160,
IMAGE_RESULT_REGISTER_LISTENER_FAILED = IMAGE_RESULT_BASE + 161,
IMAGE_RESULT_REGISTER_BUFFER_FAILED = IMAGE_RESULT_BASE + 162,
IMAGE_RESULT_FREAD_FAILED = IMAGE_RESULT_BASE + 163,
IMAGE_RESULT_PEEK_FAILED = IMAGE_RESULT_BASE + 164,
IMAGE_RESULT_SEEK_FAILED = IMAGE_RESULT_BASE + 165,
IMAGE_RESULT_STREAM_SIZE_ERROR = IMAGE_RESULT_BASE + 166,
IMAGE_RESULT_FILE_FD_ERROR = IMAGE_RESULT_BASE + 167,
IMAGE_RESULT_FILE_DAMAGED = IMAGE_RESULT_BASE + 168,
IMAGE_RESULT_CREATE_DECODER_FAILED = IMAGE_RESULT_BASE + 169,
IMAGE_RESULT_CREATE_ENCODER_FAILED = IMAGE_RESULT_BASE + 170,
IMAGE_RESULT_CHECK_FORMAT_ERROR = IMAGE_RESULT_BASE + 171,
IMAGE_RESULT_THIRDPART_SKIA_ERROR = IMAGE_RESULT_BASE + 172,
IMAGE_RESULT_HW_DECODE_FAILED = IMAGE_RESULT_BASE + 173,
IMAGE_RESULT_ALLOCATER_TYPE_ERROR = IMAGE_RESULT_BASE + 174,
IMAGE_RESULT_ALPHA_TYPE_ERROR = IMAGE_RESULT_BASE + 175,
IMAGE_RESULT_INDEX_INVALID = IMAGE_RESULT_BASE + 176,
IMAGE_RESULT_MEDIA_UNKNOWN = IMAGE_RESULT_BASE + 200
} | 可能出现的返回值的枚举。 | diff --git a/zh-cn/application-dev/reference/native-apis/image__pixel__map__mdk_8h.md b/zh-cn/application-dev/reference/native-apis/image__pixel__map__mdk_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..feec9732f75f4e40e916bd4fa85155d373caf8d3 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/image__pixel__map__mdk_8h.md @@ -0,0 +1,65 @@ +# image_pixel_map_mdk.h + + +## 概述 + +声明可以锁定并访问pixelmap数据的方法,声明解锁的方法。 Need link **libpixelmapndk.z.so** + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 结构体 + +| 名称 | 描述 | +| -------- | -------- | +| [OhosPixelMapInfos](_ohos_pixel_map_infos.md) | 用于定义 pixel map 的相关信息。 | +| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 | + + +### 类型定义 + +| 名称 | 描述 | +| -------- | -------- | +| [NativePixelMap](image.md#nativepixelmap) | 定义native层pixelmap数据类型名称。 | +| [OhosPixelMapInfos](image.md#ohospixelmapinfos) | 用于定义 pixel map 的相关信息。 | + + +### 枚举 + +| 名称 | 描述 | +| -------- | -------- | +| { [OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN](image.md) = 0,
[OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE](image.md) = 1,
[OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL](image.md) = 2,
[OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL](image.md) = 3 } | PixelMap 透明度类型的枚举。 | +| { [OHOS_PIXEL_MAP_READ_ONLY](image.md) = 0,
[OHOS_PIXEL_MAP_EDITABLE](image.md) = 1 } | PixelMap 编辑类型的枚举。 | + + +### 函数 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_PixelMap_CreatePixelMap](image.md#oh_pixelmap_createpixelmap) (napi_env env, [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) info, void \*buf, size_t len, napi_value \*res) | 创建**PixelMap**对象。 | +| [OH_PixelMap_CreateAlphaPixelMap](image.md#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 | +| [OH_PixelMap_InitNativePixelMap](image.md#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 | +| [OH_PixelMap_GetBytesNumberPerRow](image.md#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 | +| [OH_PixelMap_GetIsEditable](image.md#oh_pixelmap_getiseditable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*editable) | 获取**PixelMap**对象是否可编辑的状态。 | +| [OH_PixelMap_IsSupportAlpha](image.md#oh_pixelmap_issupportalpha) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 | +| [OH_PixelMap_SetAlphaAble](image.md#oh_pixelmap_setalphaable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 | +| [OH_PixelMap_GetDensity](image.md#oh_pixelmap_getdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 | +| [OH_PixelMap_SetDensity](image.md#oh_pixelmap_setdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 | +| [OH_PixelMap_SetOpacity](image.md#oh_pixelmap_setopacity) (const [NativePixelMap](image.md#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 | +| [OH_PixelMap_Scale](image.md#oh_pixelmap_scale) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 | +| [OH_PixelMap_Translate](image.md#oh_pixelmap_translate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 | +| [OH_PixelMap_Rotate](image.md#oh_pixelmap_rotate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 | +| [OH_PixelMap_Flip](image.md#oh_pixelmap_flip) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 | +| [OH_PixelMap_Crop](image.md#oh_pixelmap_crop) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y, int32_t width, int32_t height) | 设置**PixelMap**对象的裁剪。 | +| [OH_PixelMap_GetImageInfo](image.md#oh_pixelmap_getimageinfo) (const [NativePixelMap](image.md#nativepixelmap) \*native, [OhosPixelMapInfos](_ohos_pixel_map_infos.md) \*info) | 获取**PixelMap**对象图像信息。 | +| [OH_PixelMap_AccessPixels](image.md#oh_pixelmap_accesspixels) (const [NativePixelMap](image.md#nativepixelmap) \*native, void \*\*addr) | 获取native **PixelMap** 对象数据的内存地址,并锁定该内存。 | +| [OH_PixelMap_UnAccessPixels](image.md#oh_pixelmap_unaccesspixels) (const [NativePixelMap](image.md#nativepixelmap) \*native) | 释放native **PixelMap**对象数据的内存锁,用于匹配方法 [OH_PixelMap_AccessPixels](image.md#oh_pixelmap_accesspixels)。 | diff --git a/zh-cn/application-dev/reference/native-apis/image__pixel__map__napi_8h.md b/zh-cn/application-dev/reference/native-apis/image__pixel__map__napi_8h.md index 2b375f4330ae4243d5f737345efd9bd78351fab5..26113cb4232ab665181b6bda16f814d3c02ad46b 100644 --- a/zh-cn/application-dev/reference/native-apis/image__pixel__map__napi_8h.md +++ b/zh-cn/application-dev/reference/native-apis/image__pixel__map__napi_8h.md @@ -19,122 +19,24 @@ ### 结构体 -| 名称 | 描述 | -| -------- | -------- | -| [OhosPixelMapInfo](_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 | -| [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) | 用于定义创建 pixel map 设置选项的相关信息。 | - -### 类型定义 - | 名称 | 描述 | | -------- | -------- | -| [NativePixelMap](image.md#nativepixelmap) | 用于定义NativePixelMap数据类型名称。 | +| [OHOS::Media::OhosPixelMapInfo](_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) | 用于定义 pixel map 的相关信息。 | ### 枚举 | 名称 | 描述 | | -------- | -------- | -| { OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 } | 函数方法返回值的错误码的枚举。 | -| { OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 } | pixel 格式的枚举。 | -| { OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN = 0, OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE = 1, OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL = 2, OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL = 3 } | PixelMap alpha 类型的枚举。 | -| { OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0, OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 } | PixelMap 缩放类型的枚举。 | -| { OHOS_PIXEL_MAP_READ_ONLY = 0, OHOS_PIXEL_MAP_EDITABLE = 1 } | PixelMap 编辑类型的枚举。 | +| { [OHOS::Media::OHOS_IMAGE_RESULT_SUCCESS](image.md) = 0,
[OHOS::Media::OHOS_IMAGE_RESULT_BAD_PARAMETER](image.md) = -1 } | 函数方法返回值的错误码的枚举。 | +| { [OHOS::Media::OHOS_PIXEL_MAP_FORMAT_NONE](image.md) = 0,
[OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGBA_8888](image.md) = 3,
[OHOS::Media::OHOS_PIXEL_MAP_FORMAT_RGB_565](image.md) = 2 } | pixel 格式的枚举。 | +| { [OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE](image.md) = 0,
[OHOS::Media::OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP](image.md) = 1 } | PixelMap 缩放类型的枚举。 | ### 函数 | 名称 | 描述 | | -------- | -------- | -| [OH_GetImageInfo](image.md#oh_getimageinfo) (napi_env env, napi_value value, [OhosPixelMapInfo](_ohos_pixel_map_info.md) \*info) | 获取 **PixelMap** 的信息,并记录信息到[OhosPixelMapInfo](_ohos_pixel_map_info.md)结构中。 | -| [OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 | -| [OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法[OH_AccessPixels](image.md#oh_accesspixels)。 | -| [OH_PixelMap_CreatePixelMap](image.md#oh_pixelmap_createpixelmap) (napi_env env, [OhosPixelMapCreateOps](_ohos_pixel_map_create_ops.md) info, void \*buf, size_t len, napi_value \*res) | 创建**PixelMap**对象。 | -| [OH_PixelMap_CreateAlphaPixelMap](image.md#oh_pixelmap_createalphapixelmap) (napi_env env, napi_value source, napi_value \*alpha) | 根据Alpha通道的信息,来生成一个仅包含Alpha通道信息的**PixelMap**对象。 | -| [OH_PixelMap_InitNativePixelMap](image.md#oh_pixelmap_initnativepixelmap) (napi_env env, napi_value source) | 初始化**PixelMap**对象数据。 | -| [OH_PixelMap_GetBytesNumberPerRow](image.md#oh_pixelmap_getbytesnumberperrow) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*num) | 获取**PixelMap**对象每行字节数。 | -| [OH_PixelMap_GetIsEditable](image.md#oh_pixelmap_getiseditable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*[editable](#editable)) | 获取**PixelMap**对象是否可编辑的状态。 | -| [OH_PixelMap_IsSupportAlpha](image.md#oh_pixelmap_issupportalpha) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*alpha) | 获取**PixelMap**对象是否支持Alpha通道。 | -| [OH_PixelMap_SetAlphaAble](image.md#oh_pixelmap_setalphaable) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t alpha) | 设置**PixelMap**对象的Alpha通道。 | -| [OH_PixelMap_GetDensity](image.md#oh_pixelmap_getdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t \*density) | 获取**PixelMap**对象像素密度。 | -| [OH_PixelMap_SetDensity](image.md#oh_pixelmap_setdensity) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t density) | 设置**PixelMap**对象像素密度。 | -| [OH_PixelMap_SetOpacity](image.md#oh_pixelmap_setopacity) (const [NativePixelMap](image.md#nativepixelmap) \*native, float opacity) | 设置**PixelMap**对象的透明度。 | -| [OH_PixelMap_Scale](image.md#oh_pixelmap_scale) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的缩放。 | -| [OH_PixelMap_Translate](image.md#oh_pixelmap_translate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float x, float y) | 设置**PixelMap**对象的偏移。 | -| [OH_PixelMap_Rotate](image.md#oh_pixelmap_rotate) (const [NativePixelMap](image.md#nativepixelmap) \*native, float angle) | 设置**PixelMap**对象的旋转。 | -| [OH_PixelMap_Flip](image.md#oh_pixelmap_flip) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y) | 设置**PixelMap**对象的翻转。 | -| [OH_PixelMap_Crop](image.md#oh_pixelmap_crop) (const [NativePixelMap](image.md#nativepixelmap) \*native, int32_t x, int32_t y, int32_t [width](#width), int32_t [height](#height)) | 设置**PixelMap**对象的裁剪。 | - -### 变量 - -| 名称 | 描述 | -| -------- | -------- | -| [width](#width) | 图片的宽, 用pixels表示。| -| [height](#height) | 图片的高, 用pixels表示。| -| [pixelFormat](#pixelformat) | 图片的格式。| -| [editable](#editable) | 图片的编辑类型。| -| [alphaType](#alphatype) | 图片的alpha类型。| -| [scaleMode](#scalemode) | 图片的缩放类型。| - -## 变量说明 - - -### alphaType - - -``` -uint32_t alphaType -``` -**描述:** -图片的alpha类型。 - - -### editable - - -``` -uint32_t editable -``` -**描述:** -图片的编辑类型。 - - -### height - - -``` -uint32_t height -``` -**描述:** -图片的高, 用pixels表示。 - - -### pixelFormat - - -``` -int32_t pixelFormat -``` -**描述:** -图片的格式。 - - -### scaleMode - - -``` -uint32_t scaleMode -``` -**描述:** -图片的缩放类型。 - - -### width - - -``` -uint32_t width -``` -**描述:** -图片的宽, 用pixels表示。 - +| [OHOS::Media::OH_GetImageInfo](image.md#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)结构中。 | +| [OHOS::Media::OH_AccessPixels](image.md#oh_accesspixels) (napi_env env, napi_value value, void \*\*addrPtr) | 获取**PixelMap**对象数据的内存地址,并锁定该内存。 | +| [OHOS::Media::OH_UnAccessPixels](image.md#oh_unaccesspixels) (napi_env env, napi_value value) | 释放**PixelMap**对象数据的内存锁, 用于匹配方法**OH_AccessPixels**。 | diff --git a/zh-cn/application-dev/reference/native-apis/image__receiver__mdk_8h.md b/zh-cn/application-dev/reference/native-apis/image__receiver__mdk_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..a865aedbb7d49359b367524db06d0dc86144ed6a --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/image__receiver__mdk_8h.md @@ -0,0 +1,48 @@ +# image_receiver_mdk.h + + +## 概述 + +声明从native层获取图片数据的方法。 + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 结构体 + +| 名称 | 描述 | +| -------- | -------- | +| [OhosImageReceiverInfo](_ohos_image_receiver_info.md) | 定义**ImageReceiver**的相关信息。 | + + +### 类型定义 + +| 名称 | 描述 | +| -------- | -------- | +| [ImageReceiverNative](image.md#imagereceivernative) | 用于定义ImageReceiverNative数据类型名称。 | +| (\*[OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback)) () | 定义native层图片的回调方法。 | + + +### 函数 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_Image_Receiver_CreateImageReceiver](image.md#oh_image_receiver_createimagereceiver) (napi_env env, struct [OhosImageReceiverInfo](_ohos_image_receiver_info.md) info, napi_value \*res) | 创建应用层 **ImageReceiver** 对象。 | +| [OH_Image_Receiver_InitImageReceiverNative](image.md#oh_image_receiver_initimagereceivernative) (napi_env env, napi_value source) | 通过应用层**ImageReceiver**对象初始化native层[ImageReceiverNative](image.md#imagereceivernative)对象。 | +| [OH_Image_Receiver_GetReceivingSurfaceId](image.md#oh_image_receiver_getreceivingsurfaceid) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, char \*id, size_t len) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取receiver的id。 | +| [OH_Image_Receiver_ReadLatestImage](image.md#oh_image_receiver_readlatestimage) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取最新的一张图片。 | +| [OH_Image_Receiver_ReadNextImage](image.md#oh_image_receiver_readnextimage) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, napi_value \*image) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取下一张图片。 | +| [OH_Image_Receiver_On](image.md#oh_image_receiver_on) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, [OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback) callback) | 注册一个[OH_Image_Receiver_On_Callback](image.md#oh_image_receiver_on_callback)回调事件。每当接收新图片,该回调事件就会响应。 | +| [OH_Image_Receiver_GetSize](image.md#oh_image_receiver_getsize) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, struct [OhosImageSize](_ohos_image_size.md) \*size) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的大小。 | +| [OH_Image_Receiver_GetCapacity](image.md#oh_image_receiver_getcapacity) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, int32_t \*capacity) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的容量。 | +| [OH_Image_Receiver_GetFormat](image.md#oh_image_receiver_getformat) (const [ImageReceiverNative](image.md#imagereceivernative) \*native, int32_t \*format) | 通过[ImageReceiverNative](image.md#imagereceivernative)获取**ImageReceiver**的格式。 | +| [OH_Image_Receiver_Release](image.md#oh_image_receiver_release) ([ImageReceiverNative](image.md#imagereceivernative) \*native) | 释放native层 [ImageReceiverNative](image.md#imagereceivernative) 对象。 | diff --git a/zh-cn/application-dev/reference/native-apis/image__source__mdk_8h.md b/zh-cn/application-dev/reference/native-apis/image__source__mdk_8h.md new file mode 100644 index 0000000000000000000000000000000000000000..68292c346a97fa604a4d7d8fb06793daa7d1b061 --- /dev/null +++ b/zh-cn/application-dev/reference/native-apis/image__source__mdk_8h.md @@ -0,0 +1,81 @@ +# image_source_mdk.h + + +## 概述 + +声明将图片源解码成像素位图的方法。 + +\@Syscap SystemCapability.Multimedia.Image + +**起始版本:** + +10 + +**相关模块:** + +[Image](image.md) + + +## 汇总 + + +### 结构体 + +| 名称 | 描述 | +| -------- | -------- | +| [OhosImageRegion](_ohos_image_region.md) | 定义图像源解码的范围选项。 | +| [OhosImageSourceOps](_ohos_image_source_ops.md) | 定义图像源选项信息。 | +| [OhosImageDecodingOps](_ohos_image_decoding_ops.md) | 定义图像源解码选项。 | +| [OhosImageSourceInfo](_ohos_image_source_info.md) | 定义图像源信息。 | +| [OhosImageSource](_ohos_image_source.md) | 定义图像源输入资源,每次仅接收一种类型。 | +| [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) | 定义图像源延迟时间列表。 | +| [OhosImageSourceSupportedFormat](_ohos_image_source_supported_format.md) | 定义图像源支持的格式字符串。 | +| [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) | 定义图像源支持的格式字符串列表。 | +| [OhosImageSourceProperty](_ohos_image_source_property.md) | 定义图像源属性键值字符串。 | +| [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) | 定义图像源更新数据选项。 | + + +### 类型定义 + +| 名称 | 描述 | +| -------- | -------- | +| [ImageSourceNative](image.md#imagesourcenative) | 为图像源方法定义native层图像源对象。 | + + +### 函数 + +| 名称 | 描述 | +| -------- | -------- | +| [OH_ImageSource_Create](image.md#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**对象。 | +| [OH_ImageSource_CreateIncremental](image.md#oh_imagesource_createincremental) (napi_env env, struct [OhosImageSource](_ohos_image_source.md) \*source, struct [OhosImageSourceOps](_ohos_image_source_ops.md) \*ops, napi_value \*res) | 通过给定的infomations[OhosImageSource](_ohos_image_source.md)和[OhosImageSourceOps](_ohos_image_source_ops.md)结构, 获取增量类型的JavaScript Native API ImageSource对象,图像数据应通过OH_ImageSource_UpdateData更新。 | +| [OH_ImageSource_GetSupportedFormats](image.md#oh_imagesource_getsupportedformats) (struct [OhosImageSourceSupportedFormatList](_ohos_image_source_supported_format_list.md) \*res) | 获取所有支持的解码格式元标记。 | +| \*[OH_ImageSource_InitNative](image.md#oh_imagesource_initnative) (napi_env env, napi_value source) | 从输入JavaScript native层API **ImageSource** 对象中,转换成[ImageSourceNative](image.md#imagesourcenative)值。 | +| [OH_ImageSource_CreatePixelMap](image.md#oh_imagesource_createpixelmap) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码JavaScript native层API**PixelMap**对象 | +| [OH_ImageSource_CreatePixelMapList](image.md#oh_imagesource_createpixelmaplist) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageDecodingOps](_ohos_image_decoding_ops.md) \*ops, napi_value \*res) | 通过一个给定的选项[OhosImageDecodingOps](_ohos_image_decoding_ops.md)结构体,从**ImageSource**中解码所有的JavaScript native层API**PixelMap**对象列表 | +| [OH_ImageSource_GetDelayTime](image.md#oh_imagesource_getdelaytime) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceDelayTimeList](_ohos_image_source_delay_time_list.md) \*res) | 从一些**ImageSource**(如GIF图像源)获取延迟时间列表。 | +| [OH_ImageSource_GetFrameCount](image.md#oh_imagesource_getframecount) (const [ImageSourceNative](image.md#imagesourcenative) \*native, uint32_t \*res) | 从**ImageSource**中获取帧计数。 | +| [OH_ImageSource_GetImageInfo](image.md#oh_imagesource_getimageinfo) (const [ImageSourceNative](image.md#imagesourcenative) \*native, int32_t index, struct [OhosImageSourceInfo](_ohos_image_source_info.md) \*info) | 通过索引从**ImageSource**获取图像源信息。 | +| [OH_ImageSource_GetImageProperty](image.md#oh_imagesource_getimageproperty) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字从**ImageSource**中获取图像源属性。 | +| [OH_ImageSource_ModifyImageProperty](image.md#oh_imagesource_modifyimageproperty) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*key, struct [OhosImageSourceProperty](_ohos_image_source_property.md) \*value) | 通过关键字为**ImageSource**修改图像源属性。 | +| [OH_ImageSource_UpdateData](image.md#oh_imagesource_updatedata) (const [ImageSourceNative](image.md#imagesourcenative) \*native, struct [OhosImageSourceUpdateData](_ohos_image_source_update_data.md) \*data) | 为了增量类型的**ImageSource**更新源数据。 | +| [OH_ImageSource_Release](image.md#oh_imagesource_release) ([ImageSourceNative](image.md#imagesourcenative) \*native) | 释放native层图像源 **ImageSourceNative**。 | + + +### 变量 + +| 名称 | 描述 | +| -------- | -------- | +| \*[OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE](image.md#ohos_image_property_bits_per_sample) = "BitsPerSample" | 定义每个样本比特的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_ORIENTATION](image.md#ohos_image_property_orientation) = "Orientation" | 定义方向的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_IMAGE_LENGTH](image.md#ohos_image_property_image_length) = "ImageLength" | 定义图像长度的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_IMAGE_WIDTH](image.md#ohos_image_property_image_width) = "ImageWidth" | 定义图像宽度的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_GPS_LATITUDE](image.md#ohos_image_property_gps_latitude) = "GPSLatitude" | 定义GPS纬度的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_GPS_LONGITUDE](image.md#ohos_image_property_gps_longitude) = "GPSLongitude" | 定义GPS经度的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF](image.md#ohos_image_property_gps_latitude_ref) = "GPSLatitudeRef" | 定义GPS纬度参考的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF](image.md#ohos_image_property_gps_longitude_ref) = "GPSLongitudeRef" | 定义GPS经度参考的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL](image.md#ohos_image_property_date_time_original) = "DateTimeOriginal" | 定义初始日期时间的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_EXPOSURE_TIME](image.md#ohos_image_property_exposure_time) = "ExposureTime" | 定义曝光时间的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_SCENE_TYPE](image.md#ohos_image_property_scene_type) = "SceneType" | 定义场景类型的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS](image.md#ohos_image_property_iso_speed_ratings) = "ISOSpeedRatings" | 定义ISO速度等级的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_F_NUMBER](image.md#ohos_image_property_f_number) = "FNumber" | 定义FNumber的图像属性关键字。 | +| \*[OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL](image.md#ohos_image_property_compressed_bits_per_pixel) = "CompressedBitsPerPixel" | 定义每个像素的压缩比特的图像属性关键字。 | diff --git a/zh-cn/application-dev/website.md b/zh-cn/application-dev/website.md index 91d94f2e6f6dbaef0e2d70bc988cfa3fb691856b..1f3ac1fba5d684eff95ea240f838785032f14e84 100644 --- a/zh-cn/application-dev/website.md +++ b/zh-cn/application-dev/website.md @@ -1772,7 +1772,12 @@ - [drawing_text_typography.h](reference/native-apis/drawing__text__typography_8h.md) - [drawing_types.h](reference/native-apis/drawing__types_8h.md) - [external_window.h](reference/native-apis/external__window_8h.md) + - [image_mdk.h](reference/native-apis/image__mdk_8h.md) + - [image_mdk_common.h](reference/native-apis/image__mdk__common_8h.md) + - [image_pixel_map_mdk.h](reference/native-apis/image__pixel__map__mdk_8h.md) - [image_pixel_map_napi.h](reference/native-apis/image__pixel__map__napi_8h.md) + - [image_receiver_mdk.h](reference/native-apis/image__receiver__mdk_8h.md) + - [image_source_mdk.h](reference/native-apis/image__source__mdk_8h.md) - [log.h](reference/native-apis/log_8h.md) - [native_buffer.h](reference/native-apis/native__buffer_8h.md) - [native_image.h](reference/native-apis/native__image_8h.md) @@ -1831,8 +1836,23 @@ - [OH_NativeXComponent_TouchPoint](reference/native-apis/_o_h___native_x_component___touch_point.md) - [OHExtDataHandle](reference/native-apis/_o_h_ext_data_handle.md) - [OHHDRMetaData](reference/native-apis/_o_h_h_d_r_meta_data.md) + - [OHOS::Media::OhosImageComponent](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_component.md) + - [OHOS::Media::OhosImageRect](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_image_rect.md) + - [OHOS::Media::OhosPixelMapInfo](reference/native-apis/_o_h_o_s_1_1_media_1_1_ohos_pixel_map_info.md) + - [OhosImageDecodingOps](reference/native-apis/_ohos_image_decoding_ops.md) + - [OhosImageReceiverInfo](reference/native-apis/_ohos_image_receiver_info.md) + - [OhosImageRegion](reference/native-apis/_ohos_image_region.md) + - [OhosImageSize](reference/native-apis/_ohos_image_size.md) + - [OhosImageSource](reference/native-apis/_ohos_image_source.md) + - [OhosImageSourceDelayTimeList](reference/native-apis/_ohos_image_source_delay_time_list.md) + - [OhosImageSourceInfo](reference/native-apis/_ohos_image_source_info.md) + - [OhosImageSourceOps](reference/native-apis/_ohos_image_source_ops.md) + - [OhosImageSourceProperty](reference/native-apis/_ohos_image_source_property.md) + - [OhosImageSourceSupportedFormat](reference/native-apis/_ohos_image_source_supported_format.md) + - [OhosImageSourceSupportedFormatList](reference/native-apis/_ohos_image_source_supported_format_list.md) + - [OhosImageSourceUpdateData](reference/native-apis/_ohos_image_source_update_data.md) - [OhosPixelMapCreateOps](reference/native-apis/_ohos_pixel_map_create_ops.md) - - [OhosPixelMapInfo](reference/native-apis/_ohos_pixel_map_info.md) + - [OhosPixelMapInfos](reference/native-apis/_ohos_pixel_map_infos.md) - [RawFileDescriptor](reference/native-apis/_raw_file_descriptor.md) - [Region](reference/native-apis/_region.md) - [Rect](reference/native-apis/_rect.md)