wusongqingUpdate docs against 73387+69328+73710+71787+71447+71294+71291+70451+69139

53f69bc7创建于 2025年4月28日历史提交

Image

Overview

The Image module enables access to image APIs.

You can refer to the corresponding development guide and samples based on your development requirements.

System capability: SystemCapability.Multimedia.Image

Since: 8

Summary

Files

Name	Description
image_mdk.h	Declares the APIs used to access the image rectangle, size, format, and component data.
image_mdk_common.h	Declares the common enums and structs used by the image APIs.
image_packer_mdk.h	Declares the APIs used to pack an image into a buffer or file.
image_pixel_map_mdk.h	Declares the APIs used to lock, access, and unlock a PixelMap.
image_pixel_map_napi.h	(Deprecated) Declares the APIs used to lock, access, and unlock a PixelMap.
image_receiver_mdk.h	Declares the APIs used to obtain image data from the native layer.
image_source_mdk.h	Declares the APIs used to decode an image source into a PixelMap.

Structs

Name	Description
struct OhosImageRect	Defines the information about an image rectangle.
struct OhosImageComponent	Defines the information about an image component.
struct OhosImageSize	Defines the image size.
struct ImagePacker_Opts_	Defines the image packing options.
struct OhosPixelMapInfos	Defines the information about a PixelMap.
struct OhosPixelMapCreateOps	Defines the options for creating a PixelMap.
struct OhosPixelMapInfo	Defines the information about a PixelMap.
struct OhosImageReceiverInfo	Defines the information about an image receiver.
struct OhosImageRegion	Defines the region of an image source to decode.
struct OhosImageSourceOps	Defines the image source options.
struct OhosImageDecodingOps	Defines the options for decoding an image source.
struct OhosImageSourceInfo	Defines the information about an image source.
struct OhosImageSource	Defines the input resource of an image source. Only one type of resource is accepted at a time.
struct OhosImageSourceDelayTimeList	Defines the delay time list of an image source.
struct OhosImageSourceSupportedFormat	Defines the format string supported by an image source.
struct OhosImageSourceSupportedFormatList	Defines the format string list supported by an image source.
struct OhosImageSourceProperty	Defines the property string (in key-value format) of an image source.
struct OhosImageSourceUpdateData	Defines the update data of an image source.

Macros

Name	Description
IMAGE_RESULT_BASE 62980096	Defines the basic value returned by the interface.

Types

Name	Description
typedef struct ImageNative_ ImageNative	Defines an image object at the native layer.
typedef struct ImagePacker_Native_ ImagePacker_Native	Defines an image packer object at the native layer.
typedef struct ImagePacker_Opts_ ImagePacker_Opts	Defines the alias of the image packing options.
typedef struct NativePixelMap_ NativePixelMap	Defines the data type name of the PixelMap at the native layer.
typedef struct OhosPixelMapInfos OhosPixelMapInfos	Defines the information about a PixelMap.
typedef struct ImageReceiverNative_ ImageReceiverNative	Defines the data type name of the image receiver at the native layer.
typedef void(* OH_Image_Receiver_On_Callback) ()	Defines the callbacks for the image interface at the native layer.
typedef struct ImageSourceNative_ ImageSourceNative	Defines an image source object at the native layer.

Enums

Name	Description
{ OHOS_IMAGE_FORMAT_YCBCR_422_SP = 1000, OHOS_IMAGE_FORMAT_JPEG = 2000 }	Enumerates the image formats.
{ OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y = 1, OHOS_IMAGE_COMPONENT_FORMAT_YUV_U = 2, OHOS_IMAGE_COMPONENT_FORMAT_YUV_V = 3, OHOS_IMAGE_COMPONENT_FORMAT_JPEG = 4 }	Enumerates the image components.
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 }	Enumerates the return values that may be used by the interface.
{ 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 }	Enumerates the PixelMap alpha types.
{ OHOS_PIXEL_MAP_READ_ONLY = 0, OHOS_PIXEL_MAP_EDITABLE = 1 }	Enumerates the PixelMap editing types.
OH_PixelMap_AntiAliasingLevel { OH_PixelMap_AntiAliasing_NONE = 0, OH_PixelMap_AntiAliasing_LOW = 1, OH_PixelMap_AntiAliasing_MEDIUM = 2, OH_PixelMap_AntiAliasing_HIGH = 3 }	Enumerates the antialiasing levels used for scaling PixelMaps.
{ OHOS_IMAGE_RESULT_SUCCESS = 0, OHOS_IMAGE_RESULT_BAD_PARAMETER = -1 }	Enumerates the error codes returned by the functions.
{ OHOS_PIXEL_MAP_FORMAT_NONE = 0, OHOS_PIXEL_MAP_FORMAT_RGBA_8888 = 3, OHOS_PIXEL_MAP_FORMAT_RGB_565 = 2 }	Enumerates the PixelMap formats.
{ OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE = 0, OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP = 1 }	Enumerates the PixelMap scale modes.

Functions

Name	Description
ImageNative * OH_Image_InitImageNative (napi_env env, napi_value source)	Converts an Image object at the JavaScript native layer into an ImageNative object.
int32_t OH_Image_ClipRect (const ImageNative native, struct OhosImageRect rect)	Obtains OhosImageRect of an ImageNative object.
int32_t OH_Image_Size (const ImageNative native, struct OhosImageSize size)	Obtains OhosImageSize of an ImageNative object.
int32_t OH_Image_Format (const ImageNative native, int32_t format)	Obtains the format of an ImageNative object.
int32_t OH_Image_GetComponent (const ImageNative native, int32_t componentType, struct OhosImageComponent componentNative)	Obtains OhosImageComponent of an ImageNative object.
int32_t OH_Image_Release (ImageNative *native)	Releases an ImageNative object.
int32_t OH_ImagePacker_Create (napi_env env, napi_value *res)	Obtains an ImagePacker object at the JavaScript native layer.
ImagePacker_Native * OH_ImagePacker_InitNative (napi_env env, napi_value packer)	Converts an ImagePacker object at the JavaScript native layer into an ImagePacker_Native object.
int32_t OH_ImagePacker_PackToData (ImagePacker_Native native, napi_value source, ImagePacker_Opts opts, uint8_t outData, size_t size)	Packs a PixelMap object or an ImagePacker object at the JavaScript native layer to a buffer (defined by outData) based on the specified ImagePacker_Opts struct.
int32_t OH_ImagePacker_PackToFile (ImagePacker_Native native, napi_value source, ImagePacker_Opts opts, int fd)	Packs a PixelMap object or an ImagePacker object at the JavaScript native layer to a file based on the specified ImagePacker_Opts struct.
int32_t OH_ImagePacker_Release (ImagePacker_Native *native)	Releases an ImagePacker_Native object.
int32_t OH_PixelMap_CreatePixelMap (napi_env env, OhosPixelMapCreateOps info, void buf, size_t len, napi_value res)	Creates a PixelMap object.
int32_t OH_PixelMap_CreatePixelMapWithStride (napi_env env, OhosPixelMapCreateOps info, void buf, size_t len, int32_t rowStride, napi_value res)	Creates a PixelMap object. Currently, only BGRA input streams are supported. For a PixelMap in RGBA format (with the size greater than 512*512), DMA memory is used by default.
int32_t OH_PixelMap_CreateAlphaPixelMap (napi_env env, napi_value source, napi_value *alpha)	Creates a PixelMap object that contains only alpha channel information.
NativePixelMap * OH_PixelMap_InitNativePixelMap (napi_env env, napi_value source)	Initializes a NativePixelMap object.
int32_t OH_PixelMap_GetBytesNumberPerRow (const NativePixelMap native, int32_t num)	Obtains the number of bytes per row of a NativePixelMap object.
int32_t OH_PixelMap_GetIsEditable (const NativePixelMap native, int32_t editable)	Checks whether a NativePixelMap object is editable.
int32_t OH_PixelMap_IsSupportAlpha (const NativePixelMap native, int32_t alpha)	Checks whether a NativePixelMap object supports alpha channels.
int32_t OH_PixelMap_SetAlphaAble (const NativePixelMap *native, int32_t alpha)	Sets an alpha channel for a NativePixelMap object.
int32_t OH_PixelMap_GetDensity (const NativePixelMap native, int32_t density)	Obtains the pixel density of a NativePixelMap object.
int32_t OH_PixelMap_SetDensity (const NativePixelMap *native, int32_t density)	Sets the pixel density for a NativePixelMap object.
int32_t OH_PixelMap_SetOpacity (const NativePixelMap *native, float opacity)	Sets the opacity for a NativePixelMap object.
int32_t OH_PixelMap_Scale (const NativePixelMap *native, float x, float y)	Scales a NativePixelMap object.
int32_t OH_PixelMap_ScaleWithAntiAliasing (const NativePixelMap *native, float x, float y, OH_PixelMap_AntiAliasingLevel level)	Scales an image based on the specified antialiasing level, width, and height.
int32_t OH_PixelMap_Translate (const NativePixelMap *native, float x, float y)	Translates a NativePixelMap object.
int32_t OH_PixelMap_Rotate (const NativePixelMap *native, float angle)	Rotates a NativePixelMap object.
int32_t OH_PixelMap_Flip (const NativePixelMap *native, int32_t x, int32_t y)	Flips a NativePixelMap object.
int32_t OH_PixelMap_Crop (const NativePixelMap *native, int32_t x, int32_t y, int32_t width, int32_t height)	Crops a NativePixelMap object.
int32_t OH_PixelMap_GetImageInfo (const NativePixelMap native, OhosPixelMapInfos info)	Obtains the image information of a NativePixelMap object.
int32_t OH_PixelMap_AccessPixels (const NativePixelMap native, void *addr)	Obtains the memory address of a NativePixelMap object and locks the memory.
int32_t OH_PixelMap_UnAccessPixels (const NativePixelMap *native)	Unlocks the memory of a NativePixelMap object. This function is used with OH_PixelMap_AccessPixels in pairs.
int32_t OH_GetImageInfo (napi_env env, napi_value value, OhosPixelMapInfo *info)	Obtains the information about a PixelMap object and stores the information to the OhosPixelMapInfo struct.
int32_t OH_AccessPixels (napi_env env, napi_value value, void **addrPtr)	Obtains the memory address of a PixelMap object and locks the memory.
int32_t OH_UnAccessPixels (napi_env env, napi_value value)	Unlocks the memory of a PixelMap object. This function is used with OH_AccessPixels in pairs.
int32_t OH_Image_Receiver_CreateImageReceiver (napi_env env, struct OhosImageReceiverInfo info, napi_value *res)	Creates an ImageReceiver object at the application layer.
ImageReceiverNative * OH_Image_Receiver_InitImageReceiverNative (napi_env env, napi_value source)	Initializes an ImageReceiverNative object through an ImageReceiver object.
int32_t OH_Image_Receiver_GetReceivingSurfaceId (const ImageReceiverNative native, char id, size_t len)	Obtains the receiver ID through an ImageReceiverNative object.
int32_t OH_Image_Receiver_ReadLatestImage (const ImageReceiverNative native, napi_value image)	Obtains the latest image through an ImageReceiverNative object.
int32_t OH_Image_Receiver_ReadNextImage (const ImageReceiverNative native, napi_value image)	Obtains the next image through an ImageReceiverNative object.
int32_t OH_Image_Receiver_On (const ImageReceiverNative *native, OH_Image_Receiver_On_Callback callback)	Registers an OH_Image_Receiver_On_Callback callback. This callback is triggered whenever a new image is received.
int32_t OH_Image_Receiver_GetSize (const ImageReceiverNative native, struct OhosImageSize size)	Obtains the size of the image receiver through an ImageReceiverNative object.
int32_t OH_Image_Receiver_GetCapacity (const ImageReceiverNative native, int32_t capacity)	Obtains the capacity of the image receiver through an ImageReceiverNative object.
int32_t OH_Image_Receiver_GetFormat (const ImageReceiverNative native, int32_t format)	Obtains the format of the image receiver through an ImageReceiverNative object.
int32_t OH_Image_Receiver_Release (ImageReceiverNative *native)	Releases an ImageReceiverNative object.
int32_t OH_ImageSource_Create (napi_env env, struct OhosImageSource src, struct OhosImageSourceOps ops, napi_value *res)	Creates an ImageSource object at the JavaScript native layer based on the specified OhosImageSource and OhosImageSourceOps structs.
int32_t OH_ImageSource_CreateFromUri (napi_env env, char uri, size_t size, struct OhosImageSourceOps ops, napi_value *res)	Creates an ImageSource object at the JavaScript native layer based on the specified URI and OhosImageSourceOps struct.
int32_t OH_ImageSource_CreateFromFd (napi_env env, int32_t fd, struct OhosImageSourceOps ops, napi_value res)	Creates an ImageSource object at the JavaScript native layer based on the specified file descriptor and OhosImageSourceOps struct.
int32_t OH_ImageSource_CreateFromData (napi_env env, uint8_t data, size_t dataSize, struct OhosImageSourceOps ops, napi_value *res)	Creates an ImageSource object at the JavaScript native layer based on the specified image source buffer (defined by data) and OhosImageSourceOps struct.
int32_t OH_ImageSource_CreateFromRawFile (napi_env env, RawFileDescriptor rawFile, struct OhosImageSourceOps ops, napi_value res)	Creates an ImageSource object at the JavaScript native layer based on the specified raw file descriptor and OhosImageSourceOps struct.
int32_t OH_ImageSource_CreateIncremental (napi_env env, struct OhosImageSource source, struct OhosImageSourceOps ops, napi_value *res)	Creates an ImageSource object of the incremental type at the JavaScript native layer based on the specified OhosImageSource and OhosImageSourceOps structs.
int32_t OH_ImageSource_CreateIncrementalFromData (napi_env env, uint8_t data, size_t dataSize, struct OhosImageSourceOps ops, napi_value *res)	Creates an ImageSource object of the incremental type at the JavaScript native layer based on the specified image source buffer (defined by data) and OhosImageSourceOps struct. The image data is updated through OH_ImageSource_UpdateData.
int32_t OH_ImageSource_GetSupportedFormats (struct OhosImageSourceSupportedFormatList *res)	Obtains all supported decoding formats.
ImageSourceNative * OH_ImageSource_InitNative (napi_env env, napi_value source)	Converts an ImageSource object at the JavaScript native layer into an ImageSourceNative object.
int32_t OH_ImageSource_CreatePixelMap (const ImageSourceNative native, struct OhosImageDecodingOps ops, napi_value *res)	Decodes an ImageSourceNative object to obtain a PixelMap object at the JavaScript native layer based on the specified OhosImageDecodingOps struct.
int32_t OH_ImageSource_CreatePixelMapList (const ImageSourceNative native, struct OhosImageDecodingOps ops, napi_value *res)	Decodes an ImageSourceNative object to obtain all PixelMap objects at the JavaScript native layer based on the specified OhosImageDecodingOps struct.
int32_t OH_ImageSource_GetDelayTime (const ImageSourceNative native, struct OhosImageSourceDelayTimeList res)	Obtains the delay time list from an ImageSourceNative object (such as GIF image source).
int32_t OH_ImageSource_GetFrameCount (const ImageSourceNative native, uint32_t res)	Obtains the number of frames from an ImageSourceNative object.
int32_t OH_ImageSource_GetImageInfo (const ImageSourceNative native, int32_t index, struct OhosImageSourceInfo info)	Obtains image source information from an ImageSourceNative object by index.
int32_t OH_ImageSource_GetImageProperty (const ImageSourceNative native, struct OhosImageSourceProperty key, struct OhosImageSourceProperty *value)	Obtains the value of an image property from an ImageSourceNative object.
int32_t OH_ImageSource_ModifyImageProperty (const ImageSourceNative native, struct OhosImageSourceProperty key, struct OhosImageSourceProperty *value)	Modifies the value of an image property of an ImageSourceNative object.
int32_t OH_ImageSource_UpdateData (const ImageSourceNative native, struct OhosImageSourceUpdateData data)	Updates the data of an ImageSourceNative object.
int32_t OH_ImageSource_Release (ImageSourceNative *native)	Releases an ImageSourceNative object.

Variables

Name	Description
const char * OHOS_IMAGE_PROPERTY_BITS_PER_SAMPLE = "BitsPerSample"	Defines a pointer to bits per sample, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_ORIENTATION = "Orientation"	Defines a pointer to the orientation, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_IMAGE_LENGTH = "ImageLength"	Defines a pointer to the image length, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_IMAGE_WIDTH = "ImageWidth"	Defines a pointer to the image width, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_GPS_LATITUDE = "GPSLatitude"	Defines a pointer to the GPS latitude, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_GPS_LONGITUDE = "GPSLongitude"	Defines a pointer to the GPS longitude, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_GPS_LATITUDE_REF = "GPSLatitudeRef"	Defines a pointer to the GPS latitude reference information, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_GPS_LONGITUDE_REF = "GPSLongitudeRef"	Defines a pointer to the GPS longitude reference information, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_DATE_TIME_ORIGINAL = "DateTimeOriginal"	Defines a pointer to the created date and time, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_EXPOSURE_TIME = "ExposureTime"	Defines a pointer to the exposure time, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_SCENE_TYPE = "SceneType"	Defines a pointer to the scene type, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_ISO_SPEED_RATINGS = "ISOSpeedRatings"	Defines a pointer to the ISO speed ratings, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_F_NUMBER = "FNumber"	Defines a pointer to the f-number of the image, one of the image properties.
const char * OHOS_IMAGE_PROPERTY_COMPRESSED_BITS_PER_PIXEL = "CompressedBitsPerPixel"	Defines a pointer to the compressed bits per pixel, one of the image properties.
int32_t OhosImageRegion::x	Defines the X coordinate of the start point, in pixels.
int32_t OhosImageRegion::y	Defines the Y coordinate of the start point, in pixels.
int32_t OhosImageRegion::width	Defines the width of the region, in pixels.
int32_t OhosImageRegion::height	Defines the height of the region, in pixels.
int32_t OhosImageSourceOps::density	Defines the pixel density of the image source.
int32_t OhosImageSourceOps::pixelFormat	Defines the pixel format of the image source. It is usually used to describe the YUV buffer.
struct OhosImageSize OhosImageSourceOps::size	Defines the pixel width and height of the image source.
int8_t OhosImageDecodingOps::editable	Defines whether the output PixelMap is editable.
int32_t OhosImageDecodingOps::pixelFormat	Defines the pixel format of the output PixelMap.
int32_t OhosImageDecodingOps::fitDensity	Defines the pixel density of the output PixelMap.
uint32_t OhosImageDecodingOps::index	Defines the index of the output PixelMap.
uint32_t OhosImageDecodingOps::sampleSize	Defines the size of the sample.
uint32_t OhosImageDecodingOps::rotate	Defines the decoding rotation options.
struct OhosImageSize OhosImageDecodingOps::size	Defines the pixel width and height of the output PixelMap.
struct OhosImageRegion OhosImageDecodingOps::region	Defines the region of the output PixelMap.
int32_t OhosImageSourceInfo::pixelFormat	Defines the pixel format of the image source. It is set in OH_ImageSource_Create.
int32_t OhosImageSourceInfo::colorSpace	Defines the color space of the image source.
int32_t OhosImageSourceInfo::alphaType	Defines the alpha type of the image source.
int32_t OhosImageSourceInfo::density	Defines the image density of the image source. It is set in OH_ImageSource_Create.
struct OhosImageSize OhosImageSourceInfo::size	Defines the pixel width and height of the image source.
char * OhosImageSource::uri = nullptr	Defines a pointer to the image source URI. Only a file URI or Base64 URI is accepted.
size_t OhosImageSource::uriSize = 0	Defines the length of the image source URI.
int32_t OhosImageSource::fd = -1	Defines the descriptor of the image source.
uint8_t * OhosImageSource::buffer = nullptr	Defines a pointer to the image source buffer. Only a formatted packet buffer or Base64 buffer is accepted.
size_t OhosImageSource::bufferSize = 0	Defines the size of the image source buffer.
int32_t * OhosImageSourceDelayTimeList::delayTimeList	Defines a pointer to the head of the image source delay time list.
size_t OhosImageSourceDelayTimeList::size = 0	Defines the size of the image source delay time list.
char * OhosImageSourceSupportedFormat::format = nullptr	Defines a pointer to the head of the format string.
size_t OhosImageSourceSupportedFormat::size = 0	Defines the size of the format string.
struct OhosImageSourceSupportedFormat ** OhosImageSourceSupportedFormatList::supportedFormatList = nullptr	Defines a double pointer to the head of the format string list.
size_t OhosImageSourceSupportedFormatList::size = 0	Defines the size of the format string list.
char * OhosImageSourceProperty::value = nullptr	Defines a pointer to the head of the property string.
size_t OhosImageSourceProperty::size = 0	Defines the size of the property string.
uint8_t * OhosImageSourceUpdateData::buffer = nullptr	Defines a pointer to the buffer for storing the update data.
size_t OhosImageSourceUpdateData::bufferSize = 0	Defines the size of the buffer.
uint32_t OhosImageSourceUpdateData::offset = 0	Defines the offset of the update data in the buffer.
uint32_t OhosImageSourceUpdateData::updateLength = 0	Defines the length of the update data in the buffer.
int8_t OhosImageSourceUpdateData::isCompleted = 0	Defines whether the image source data update is completed.

Type Description

ImageNative

typedef struct ImageNative_ ImageNative

Description

Defines an image object at the native layer.

Since: 10

ImagePacker_Native

typedef struct ImagePacker_Native_ ImagePacker_Native

Description

Defines an image packer object at the native layer.

Since: 11

ImagePacker_Opts

typedef struct ImagePacker_Opts_ ImagePacker_Opts

Description

Defines the alias of the image packing options.

Since: 11

ImageReceiverNative

typedef struct ImageReceiverNative_ ImageReceiverNative

Description

Defines the data type name of the image receiver at the native layer.

Since: 10

ImageSourceNative

typedef struct ImageSourceNative_ ImageSourceNative

Description

Defines an image source object at the native layer.

System capability: SystemCapability.Multimedia.Image

Since: 10

NativePixelMap

typedef struct NativePixelMap_ NativePixelMap

Description

Defines the data type name of the PixelMap at the native layer.

Since: 10

OH_Image_Receiver_On_Callback

typedef void(* OH_Image_Receiver_On_Callback) ()

Description

Defines the callbacks for the image interface at the native layer.

Since: 10

OhosPixelMapInfos

typedef struct OhosPixelMapInfos

Description

Defines the information about a PixelMap.

Since: 10

Enum Description

Image Formats

anonymous enum

Description

Enumerates the image formats.

Since: 10

Value	Description
OHOS_IMAGE_FORMAT_YCBCR_422_SP	YCbCr422 semi-planar format.
OHOS_IMAGE_FORMAT_JPEG	JPEG encoding format.

PixelMap Alpha Types

anonymous enum

Description

Enumerates the PixelMap alpha types.

Since: 10

Value	Description
OHOS_PIXEL_MAP_ALPHA_TYPE_UNKNOWN	Unknown format.
OHOS_PIXEL_MAP_ALPHA_TYPE_OPAQUE	Opaque format.
OHOS_PIXEL_MAP_ALPHA_TYPE_PREMUL	Premultiplied format.
OHOS_PIXEL_MAP_ALPHA_TYPE_UNPREMUL	Unpremultiplied format.

Error Codes Returned by Functions

anonymous enum

Description

Enumerates the error codes returned by the functions.

Deprecated from: 10

Since: 8

Value	Description
OHOS_IMAGE_RESULT_SUCCESS	Operation success.
OHOS_IMAGE_RESULT_BAD_PARAMETER	Invalid parameter.

Image Color Channel Types

anonymous enum

Description

Enumerates the image color channel types.

Since: 10

Value	Description
OHOS_IMAGE_COMPONENT_FORMAT_YUV_Y	Luminance component.
OHOS_IMAGE_COMPONENT_FORMAT_YUV_U	Chrominance component - blue projection.
OHOS_IMAGE_COMPONENT_FORMAT_YUV_V	Chrominance component - red projection.
OHOS_IMAGE_COMPONENT_FORMAT_JPEG	JPEG format.

PixelMap Editing Types

anonymous enum

Description

Enumerates the PixelMap editing types.

Since: 10

Value	Description
OHOS_PIXEL_MAP_READ_ONLY	Read-only.
OHOS_PIXEL_MAP_EDITABLE	Editable.

Pixel Formats

anonymous enum

Description

Enumerates the pixel formats.

Deprecated from: 10

Since: 8

Value	Description
OHOS_PIXEL_MAP_FORMAT_NONE	Unknown format.
OHOS_PIXEL_MAP_FORMAT_RGBA_8888	RGBA_8888 format.
OHOS_PIXEL_MAP_FORMAT_RGB_565	RGB_565 format.

PixelMap Scale Modes

anonymous enum

Description

Enumerates the PixelMap scale modes.

Since: 10

Value	Description
OHOS_PIXEL_MAP_SCALE_MODE_FIT_TARGET_SIZE	Adapting to the target image size.
OHOS_PIXEL_MAP_SCALE_MODE_CENTER_CROP	Cropping the center portion of an image to the target size.

IRNdkErrCode

enum IRNdkErrCode

Description

Enumerates the return values that may be used by the interface.

Since: 10

Value	Description
IMAGE_RESULT_SUCCESS	Operation success.
IMAGE_RESULT_BAD_PARAMETER	Invalid parameter.
IMAGE_RESULT_IMAGE_RESULT_BASE	Operation failed.
IMAGE_RESULT_ERR_IPC	IPC error.
IMAGE_RESULT_ERR_SHAMEM_NOT_EXIST	Failed to share the memory.
IMAGE_RESULT_ERR_SHAMEM_DATA_ABNORMAL	Abnormal data in the shared memory.
IMAGE_RESULT_DECODE_ABNORMAL	Failed to decode the image.
IMAGE_RESULT_DATA_ABNORMAL	Abnormal input data.
IMAGE_RESULT_MALLOC_ABNORMAL	An error occurs during memory allocation.
IMAGE_RESULT_DATA_UNSUPPORT	The image type is not supported.
IMAGE_RESULT_INIT_ABNORMAL	Failed to initialize the image.
IMAGE_RESULT_GET_DATA_ABNORMAL	An error occurs during image data retrieval.
IMAGE_RESULT_TOO_LARGE	The image is too large.
IMAGE_RESULT_TRANSFORM	An error occurs during image transformation.
IMAGE_RESULT_COLOR_CONVERT	An error occurs during image color conversion.
IMAGE_RESULT_CROP	An error occurs during image cropping.
IMAGE_RESULT_SOURCE_DATA	The image source data is incorrect.
IMAGE_RESULT_SOURCE_DATA_INCOMPLETE	The image source data is incomplete.
IMAGE_RESULT_MISMATCHED_FORMAT	The image format does not match.
IMAGE_RESULT_UNKNOWN_FORMAT	Unknown image format.
IMAGE_RESULT_SOURCE_UNRESOLVED	The image source is not parsed.
IMAGE_RESULT_INVALID_PARAMETER	Invalid image parameter.
IMAGE_RESULT_DECODE_FAILED	Failed to decode the image.
IMAGE_RESULT_PLUGIN_REGISTER_FAILED	Failed to register the plug-in.
IMAGE_RESULT_PLUGIN_CREATE_FAILED	Failed to create the plug-in.
IMAGE_RESULT_ENCODE_FAILED	Failed to encode the image.
IMAGE_RESULT_ADD_PIXEL_MAP_FAILED	Failed to add the PixelMap.
IMAGE_RESULT_HW_DECODE_UNSUPPORT	Hardware decoding is not supported.
IMAGE_RESULT_DECODE_HEAD_ABNORMAL	Failed to decode the image header.
IMAGE_RESULT_DECODE_EXIF_UNSUPPORT	Exchangeable Image File (EXIF) is not supported for image decoding.
IMAGE_RESULT_PROPERTY_NOT_EXIST	The image property does not exist.
IMAGE_RESULT_MEDIA_DATA_UNSUPPORT	The media type is not supported.
IMAGE_RESULT_MEDIA_TOO_LARGE	The media is too large.
IMAGE_RESULT_MEDIA_MALLOC_FAILED	Memory allocation failed.
IMAGE_RESULT_MEDIA_END_OF_STREAM	Failed to end the media data stream.
IMAGE_RESULT_MEDIA_IO_ABNORMAL	Abnormal input and output streams.
IMAGE_RESULT_MEDIA_MALFORMED	The media service functions abnormally.
IMAGE_RESULT_MEDIA_BUFFER_TOO_SMALL	The media data is too small.
IMAGE_RESULT_MEDIA_OUT_OF_RANGE	The media is out of range.
IMAGE_RESULT_MEDIA_STATUS_ABNORMAL	Abnormal media status.
IMAGE_RESULT_MEDIA_VALUE_INVALID	Invalid media value.
IMAGE_RESULT_MEDIA_NULL_POINTER	Media operation failed.
IMAGE_RESULT_MEDIA_INVALID_OPERATION	Invalid media operation.
IMAGE_RESULT_MEDIA_ERR_PLAYER_NOT_INIT	An error occurs during media initialization.
IMAGE_RESULT_MEDIA_EARLY_PREPARE	Media preprocessing is carried out too early.
IMAGE_RESULT_MEDIA_SEEK_ERR	The seek operation failed.
IMAGE_RESULT_MEDIA_PERMISSION_DENIED	Permission denied.
IMAGE_RESULT_MEDIA_DEAD_OBJECT	The media object is deregistered.
IMAGE_RESULT_MEDIA_TIMED_OUT	A timeout occurs.
IMAGE_RESULT_MEDIA_TRACK_NOT_ALL_SUPPORTED	The media capability is not supported.
IMAGE_RESULT_MEDIA_ADAPTER_INIT_FAILED	Failed to initialize the media adapter.
IMAGE_RESULT_MEDIA_WRITE_PARCEL_FAIL	Failed to write data to the parcel.
IMAGE_RESULT_MEDIA_READ_PARCEL_FAIL	Failed to read data from the parcel.
IMAGE_RESULT_MEDIA_NO_AVAIL_BUFFER	Invalid data.
IMAGE_RESULT_MEDIA_INVALID_PARAM	Invalid parameters.
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_EXIST	The media codec adapter does not exist.
IMAGE_RESULT_MEDIA_CREATE_CODEC_ADAPTER_FAILED	Failed to create the media codec adapter.
IMAGE_RESULT_MEDIA_CODEC_ADAPTER_NOT_INIT	The media codec adapter is not initialized.
IMAGE_RESULT_MEDIA_ZCODEC_CREATE_FAILED	Failed to create the media codec.
IMAGE_RESULT_MEDIA_ZCODEC_NOT_EXIST	The media codec does not exist.
IMAGE_RESULT_MEDIA_JNI_CLASS_NOT_EXIST	The media JNI layer class does not exist.
IMAGE_RESULT_MEDIA_JNI_METHOD_NOT_EXIST	The media JNI layer method does not exist.
IMAGE_RESULT_MEDIA_JNI_NEW_OBJ_FAILED	Failed to create the object at the media JNI layer.
IMAGE_RESULT_MEDIA_JNI_COMMON_ERROR	The media JNI layer is abnormal.
IMAGE_RESULT_MEDIA_DISTRIBUTE_NOT_SUPPORT	The distributed feature is not supported.
IMAGE_RESULT_MEDIA_SOURCE_NOT_SET	The media source is not set.
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_INIT	The media RTSP adapter is not initialized.
IMAGE_RESULT_MEDIA_RTSP_ADAPTER_NOT_EXIST	The media RTSP adapter does not exist.
IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT	The media does not support the RTSP surface.
IMAGE_RESULT_MEDIA_RTSP_CAPTURE_NOT_INIT	Failed to initialize the media RTSP capturer.
IMAGE_RESULT_MEDIA_RTSP_SOURCE_URL_INVALID	Invalid media RTSP source path.
IMAGE_RESULT_MEDIA_RTSP_VIDEO_TRACK_NOT_FOUND	No video capability is found in the media RTSP.
IMAGE_RESULT_MEDIA_RTSP_CAMERA_NUM_REACH_MAX	The maximum number of RTSP cameras has been reached.
IMAGE_RESULT_MEDIA_SET_VOLUME	Failed to set the volume.
IMAGE_RESULT_MEDIA_NUMBER_OVERFLOW	The number of operations overflows.
IMAGE_RESULT_MEDIA_DIS_PLAYER_UNSUPPORTED	The distributed media player is not supported.
IMAGE_RESULT_MEDIA_DENCODE_ICC_FAILED	Failed to decode the ICC.
IMAGE_RESULT_MEDIA_ENCODE_ICC_FAILED	Failed to encode the ICC.
IMAGE_RESULT_MEDIA_READ_PIXELMAP_FAILED	Failed to read the PixelMap.
IMAGE_RESULT_MEDIA_WRITE_PIXELMAP_FAILED	Failed to write the PixelMap.
IMAGE_RESULT_MEDIA_PIXELMAP_NOT_ALLOW_MODIFY	The PixelMap cannot be modified.
IMAGE_RESULT_MEDIA_CONFIG_FAILED	Configuration failed.
IMAGE_RESULT_JNI_ENV_ABNORMAL	The JNI environment is abnormal.
IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED	Failed to allocate memory for the surface.
IMAGE_RESULT_CREATE_SURFACE_FAILED	Failed to create the surface.
IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED	Failed to obtain parameters from the surface.
IMAGE_RESULT_GET_SURFACE_FAILED	Failed to obtain the surface.
IMAGE_RESULT_SURFACE_ACQUIRE_BUFFER_FAILED	Failed to apply for a buffer.
IMAGE_RESULT_SURFACE_REQUEST_BUFFER_FAILED	Failed to request a buffer.
IMAGE_RESULT_REGISTER_LISTENER_FAILED	Failed to register the listener.
IMAGE_RESULT_REGISTER_BUFFER_FAILED	Failed to register the buffer.
IMAGE_RESULT_FREAD_FAILED	Failed to read the file.
IMAGE_RESULT_PEEK_FAILED	Failed to peek the file.
IMAGE_RESULT_SEEK_FAILED	Failed to seek the file.
IMAGE_RESULT_STREAM_SIZE_ERROR	The data stream is damaged.
IMAGE_RESULT_FILE_FD_ERROR	The file descriptor is damaged.
IMAGE_RESULT_FILE_DAMAGED	The file is damaged.
IMAGE_RESULT_CREATE_DECODER_FAILED	Failed to create a decoder.
IMAGE_RESULT_CREATE_ENCODER_FAILED	Failed to create an encoder.
IMAGE_RESULT_CHECK_FORMAT_ERROR	Failed to check the format.
IMAGE_RESULT_THIRDPART_SKIA_ERROR	Skia decoding failed.
IMAGE_RESULT_HW_DECODE_FAILED	Hardware decoding failed.
IMAGE_RESULT_ALLOCATER_TYPE_ERROR	Failed to verify the memory type.
IMAGE_RESULT_ALPHA_TYPE_ERROR	Failed to verify the alpha type.
IMAGE_RESULT_INDEX_INVALID	Invalid parameter.
IMAGE_RESULT_MEDIA_UNKNOWN	Unknown error.

OH_PixelMap_AntiAliasingLevel

enum OH_PixelMap_AntiAliasingLevel

Description

Enumerates the antialiasing levels used for scaling PixelMaps.

Since: 12

Value	Description
OH_PixelMap_AntiAliasing_NONE	Nearest neighbor interpolation.
OH_PixelMap_AntiAliasing_LOW	Bilinear interpolation.
OH_PixelMap_AntiAliasing_MEDIUM	Bilinear interpolation with mipmap enabled. You are advised to use this value when zooming out an image.
OH_PixelMap_AntiAliasing_HIGH	Cubic interpolation.

Function Description

OH_AccessPixels()

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

Description

Obtains the memory address of a PixelMap object and locks the memory.

*addrPtr is the memory address obtained. After finishing the access, you must use OH_UnAccessPixels to unlock the memory. Then the memory cannot be accessed or operated.

Deprecated from: 10

Since: 8

Parameters

Name	Description
env	Pointer to the NAPI environment.
value	PixelMap object at the application layer.
addrPtr	Double pointer to the memory address.

See

UnAccessPixels

Returns

For details, see IRNdkErrCode.

Returns OHOS_IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_BAD_PARAMETER if the operation fails.

OH_GetImageInfo()

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

Description

Obtains the information about a PixelMap object and stores the information to the OhosPixelMapInfo struct.

Deprecated from: 10

Since: 8

Parameters

Name	Description
env	Pointer to the NAPI environment.
value	PixelMap object at the application layer.
info	Pointer to the object that stores the information obtained. For details, see OhosPixelMapInfo.

Returns

For details, see IRNdkErrCode.

Returns OHOS_IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_BAD_PARAMETER if the operation fails.

See

OhosPixelMapInfo

OH_Image_ClipRect()

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

Description

Obtains OhosImageRect of an ImageNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageNative object.
rect	Pointer to the OhosImageRect object obtained.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED if parameters fail to be obtained from the surface.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

See

ImageNative, OhosImageRect

OH_Image_Format()

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

Description

Obtains the format of an ImageNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageNative object.
format	Pointer to the image format obtained.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED if parameters fail to be obtained from the surface.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

See

ImageNative

OH_Image_GetComponent()

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

Description

Obtains OhosImageComponent of an ImageNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageNative object.
componentType	Type of the component.
componentNative	Pointer to the OhosImageComponent object obtained.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED if parameters fail to be obtained from the surface.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

See

ImageNative, OhosImageComponent

OH_Image_InitImageNative()

ImageNative* OH_Image_InitImageNative (napi_env env, napi_value source )

Description

Parses an ImageNative object from an Image object at the JavaScript native layer.

Since: 10

Parameters

Name	Description
env	Pointer to the JNI environment.
source	Image object at the JavaScript native layer.

Returns

Returns a pointer to the ImageNative object if the operation is successful; returns a null pointer otherwise.

See

ImageNative, OH_Image_Release

OH_Image_Receiver_CreateImageReceiver()

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

Description

Creates an ImageReceiver object at the application layer.

Since: 10

Parameters

Name	Description
env	Pointer to the NAPI environment.
info	Options for setting the ImageReceiver object.
res	Pointer to the ImageReceiver object at the application layer.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_SURFACE_GET_PARAMETER_FAILED if parameters fail to be obtained from the surface.

Returns IMAGE_RESULT_CREATE_SURFACE_FAILED if the surface fails to be created.

Returns IMAGE_RESULT_SURFACE_GRALLOC_BUFFER_FAILED if the buffer fails to be allocated to the surface.

Returns IMAGE_RESULT_GET_SURFACE_FAILED if the surface fails to be obtained.

Returns IMAGE_RESULT_MEDIA_RTSP_SURFACE_UNSUPPORT if the media RTSP surface is not supported.

Returns IMAGE_RESULT_DATA_UNSUPPORT if the image type is not supported.

Returns IMAGE_RESULT_MEDIA_DATA_UNSUPPORT if the media type is not supported.

See

OhosImageReceiverInfo

OH_Image_Receiver_GetCapacity()

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

Description

Obtains the capacity of the image receiver through an ImageReceiverNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageReceiverNative object.
capacity	Pointer to the capacity obtained.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_DATA_UNSUPPORT if the image type is not supported.

See

ImageReceiverNative, OhosImageSize

OH_Image_Receiver_GetFormat()

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

Description

Obtains the format of the image receiver through an ImageReceiverNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageReceiverNative object.
format	Pointer to the format obtained.

Returns

For details, see IRNdkErrCode.

Returns IMAGE_RESULT_SUCCESS if the operation is successful.

Returns IMAGE_RESULT_BAD_PARAMETER if a parameter is incorrect.

Returns IMAGE_RESULT_JNI_ENV_ABNORMAL if the JNI environment is abnormal.

Returns IMAGE_RESULT_INVALID_PARAMETER if a parameter is invalid.

Returns IMAGE_RESULT_DATA_UNSUPPORT if the image type is not supported.

See

ImageReceiverNative

OH_Image_Receiver_GetReceivingSurfaceId()

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

Description

Obtains the receiver ID through an ImageReceiverNative object.

Since: 10

Parameters

Name	Description
native	Pointer to an ImageReceiverNative object.
id	Pointer to the buffer that stores the ID string obtained.
len	Size of the buffer.