From 753bf696ce66f1c9060b134eff59016affad9b8e Mon Sep 17 00:00:00 2001 From: "zhubingwei@huawei.com" Date: Mon, 20 May 2024 18:07:24 +0800 Subject: [PATCH] modify error list Signed-off-by: zhubingwei@huawei.com --- .../media/image/image_packer_native.h | 64 ++++++++----- .../media/image/image_source_native.h | 89 +++++++++++++------ .../native_sdk/media/image/pixelmap_native.h | 87 ++++++++++++------ 3 files changed, 160 insertions(+), 80 deletions(-) diff --git a/zh-cn/native_sdk/media/image/image_packer_native.h b/zh-cn/native_sdk/media/image/image_packer_native.h index 7d591266..f1bf8aea 100644 --- a/zh-cn/native_sdk/media/image/image_packer_native.h +++ b/zh-cn/native_sdk/media/image/image_packer_native.h @@ -78,7 +78,8 @@ typedef enum { * @brief 创建PackingOptions结构体的指针。 * * @param options 用于操作的PackingOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_Create(OH_PackingOptions **options); @@ -88,7 +89,8 @@ Image_ErrorCode OH_PackingOptions_Create(OH_PackingOptions **options); * * @param options 被操作的OH_PackingOptions指针。 * @param format 图像格式。可传入一个空指针和零大小，系统将分配内存，但必须在使用后释放内存。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_GetMimeType(OH_PackingOptions *options, @@ -99,7 +101,8 @@ Image_ErrorCode OH_PackingOptions_GetMimeType(OH_PackingOptions *options, * * @param options 被操作的OH_PackingOptions指针。 * @param format 图像格式。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_SetMimeType(OH_PackingOptions *options, @@ -110,7 +113,8 @@ Image_ErrorCode OH_PackingOptions_SetMimeType(OH_PackingOptions *options, * * @param options 被操作的OH_PackingOptions指针。 * @param quality 编码质量。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_GetQuality(OH_PackingOptions *options, @@ -121,7 +125,8 @@ Image_ErrorCode OH_PackingOptions_GetQuality(OH_PackingOptions *options, * * @param options 被操作的OH_PackingOptions指针。 * @param quality 编码质量。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_SetQuality(OH_PackingOptions *options, @@ -151,7 +156,8 @@ Image_ErrorCode OH_PackingOptions_SetDesiredDynamicRange(OH_PackingOptions *opti * @brief 释放OH_PackingOptions指针。 * * @param options 被操作的OH_PackingOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PackingOptions_Release(OH_PackingOptions *options); @@ -160,7 +166,8 @@ Image_ErrorCode OH_PackingOptions_Release(OH_PackingOptions *options); * @brief 创建OH_ImagePackerNative指针。 * * @param options 被操作的OH_ImagePackerNative指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImagePackerNative_Create(OH_ImagePackerNative **imagePacker); @@ -173,7 +180,10 @@ Image_ErrorCode OH_ImagePackerNative_Create(OH_ImagePackerNative **imagePacker); * @param imageSource 用于编码的image source指针。 * @param outData 用于存储打包图像输出数据的缓冲区。 * @param size 用于存储打包图像输出数据的缓冲区大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码失败返回 IMAGE_DECODE_FAILED，如果申请内存失败返回 IMAGE_ALLOC_FAILED， + * 如果数据或图片过大返回 IMAGE_TOO_LARGE，如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImagePackerNative_PackToDataFromImageSource(OH_ImagePackerNative *imagePacker, @@ -187,7 +197,10 @@ Image_ErrorCode OH_ImagePackerNative_PackToDataFromImageSource(OH_ImagePackerNat * @param pixelmap 用于编码的Pixelmap指针。 * @param outData 用于存储打包图像输出数据的缓冲区。 * @param size 用于存储打包图像输出数据的缓冲区大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码失败返回 IMAGE_DECODE_FAILED，如果申请内存失败返回 IMAGE_ALLOC_FAILED， + * 如果数据或图片过大返回 IMAGE_TOO_LARGE，如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImagePackerNative_PackToDataFromPixelmap(OH_ImagePackerNative *imagePacker, @@ -200,31 +213,36 @@ Image_ErrorCode OH_ImagePackerNative_PackToDataFromPixelmap(OH_ImagePackerNative * @param options 打包选项参数 {@link OH_PackingOptions}。 * @param imageSource 用于编码的image source指针。 * @param fd 可写的文件描述符。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码失败返回 IMAGE_DECODE_FAILED，如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImagePackerNative_PackToFileFromImageSource(OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_ImageSourceNative *imageSource, int32_t fd); /** - * @brief 将一个Pixelmap编码到文件中。 - * - * @param imagePacker 被操作的OH_ImagePackerNative指针。 - * @param options 打包选项参数 {@link OH_PackingOptions}。 - * @param pixelmap 用于编码的pixelmap指针。 - * @param fd 可写的文件描述符。 - * @return Returns {@link Image_ErrorCode}。 - * @since 12 + * @brief 将一个Pixelmap编码到文件中。 + * + * @param imagePacker 被操作的OH_ImagePackerNative指针。 + * @param options 打包选项参数 {@link OH_PackingOptions}。 + * @param pixelmap 用于编码的pixelmap指针。 + * @param fd 可写的文件描述符。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码失败返回 IMAGE_DECODE_FAILED，如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 + * @since 12 */ Image_ErrorCode OH_ImagePackerNative_PackToFileFromPixelmap(OH_ImagePackerNative *imagePacker, OH_PackingOptions *options, OH_PixelmapNative *pixelmap, int32_t fd); /** - * @brief 释放OH_ImagePackerNative指针。 - * - * @param imagePacker 被操作的OH_ImagePackerNative指针。 - * @return Returns {@link Image_ErrorCode}。 - * @since 12 + * @brief 释放OH_ImagePackerNative指针。 + * + * @param imagePacker 被操作的OH_ImagePackerNative指针。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 + * @since 12 */ Image_ErrorCode OH_ImagePackerNative_Release(OH_ImagePackerNative *imagePacker); diff --git a/zh-cn/native_sdk/media/image/image_source_native.h b/zh-cn/native_sdk/media/image/image_source_native.h index 75c8e203..36152cb8 100644 --- a/zh-cn/native_sdk/media/image/image_source_native.h +++ b/zh-cn/native_sdk/media/image/image_source_native.h @@ -84,7 +84,8 @@ typedef enum { * @brief 创建OH_ImageSource_Info指针。 * * @param info 被操作的OH_ImageSource_Info指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceInfo_Create(OH_ImageSource_Info **info); @@ -94,7 +95,8 @@ Image_ErrorCode OH_ImageSourceInfo_Create(OH_ImageSource_Info **info); * * @param info 被操作的OH_ImageSource_Info指针。 * @param width 图片的宽，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceInfo_GetWidth(OH_ImageSource_Info *info, uint32_t *width); @@ -104,7 +106,8 @@ Image_ErrorCode OH_ImageSourceInfo_GetWidth(OH_ImageSource_Info *info, uint32_t * * @param info 被操作的OH_ImageSource_Info指针。 * @param height 图片的高，单位：像素高 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceInfo_GetHeight(OH_ImageSource_Info *info, uint32_t *height); @@ -123,7 +126,8 @@ Image_ErrorCode OH_ImageSourceInfo_GetDynamicRange(OH_ImageSource_Info *info, bo * @brief 释放OH_ImageSource_Info指针。 * * @param info 被操作的OH_ImageSource_Info指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceInfo_Release(OH_ImageSource_Info *info); @@ -140,7 +144,8 @@ typedef struct OH_DecodingOptions OH_DecodingOptions; * @brief 创建OH_DecodingOptions指针。 * * @param options 被操作的OH_DecodingOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_Create(OH_DecodingOptions **options); @@ -150,7 +155,8 @@ Image_ErrorCode OH_DecodingOptions_Create(OH_DecodingOptions **options); * * @param options 被操作的OH_DecodingOptions指针。 * @param pixelFormat pixel格式{@link PIXEL_FORMAT}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_GetPixelFormat(OH_DecodingOptions *options, @@ -161,7 +167,8 @@ Image_ErrorCode OH_DecodingOptions_GetPixelFormat(OH_DecodingOptions *options, * * @param options 被操作的OH_DecodingOptions指针。 * @param pixelFormat pixel格式{@link PIXEL_FORMAT}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_SetPixelFormat(OH_DecodingOptions *options, @@ -172,7 +179,8 @@ Image_ErrorCode OH_DecodingOptions_SetPixelFormat(OH_DecodingOptions *options, * * @param options 被操作的OH_DecodingOptions指针。 * @param index 解码图片序号。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_GetIndex(OH_DecodingOptions *options, uint32_t *index); @@ -181,8 +189,9 @@ Image_ErrorCode OH_DecodingOptions_GetIndex(OH_DecodingOptions *options, uint32_ * @brief 设置解码图片序号。 * * @param options 被操作的OH_DecodingOptions指针。 - * @param index 解码图片序号 - * @return Returns {@link Image_ErrorCode}。 + * @param index 解码图片序号。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_SetIndex(OH_DecodingOptions *options, uint32_t index); @@ -192,7 +201,8 @@ Image_ErrorCode OH_DecodingOptions_SetIndex(OH_DecodingOptions *options, uint32_ * * @param options 被操作的OH_DecodingOptions指针。 * @param rotate 旋转角度，单位为deg。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_GetRotate(OH_DecodingOptions *options, float *rotate); @@ -202,7 +212,8 @@ Image_ErrorCode OH_DecodingOptions_GetRotate(OH_DecodingOptions *options, float * * @param options 被操作的OH_DecodingOptions指针。 * @param rotate 旋转角度，单位为deg。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_SetRotate(OH_DecodingOptions *options, float rotate); @@ -212,7 +223,8 @@ Image_ErrorCode OH_DecodingOptions_SetRotate(OH_DecodingOptions *options, float * * @param options 被操作的OH_DecodingOptions指针。 * @param desiredSize 期望输出大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_GetDesiredSize(OH_DecodingOptions *options, @@ -223,7 +235,8 @@ Image_ErrorCode OH_DecodingOptions_GetDesiredSize(OH_DecodingOptions *options, * * @param options 被操作的OH_DecodingOptions指针。 * @param desiredSize 期望输出大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_SetDesiredSize(OH_DecodingOptions *options, @@ -234,7 +247,8 @@ Image_ErrorCode OH_DecodingOptions_SetDesiredSize(OH_DecodingOptions *options, * * @param options 被操作的OH_DecodingOptions指针。 * @param desiredRegion 解码区域。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_GetDesiredRegion(OH_DecodingOptions *options, @@ -245,7 +259,8 @@ Image_ErrorCode OH_DecodingOptions_GetDesiredRegion(OH_DecodingOptions *options, * * @param options 被操作的OH_DecodingOptions指针。 * @param desiredRegion 解码区域。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_SetDesiredRegion(OH_DecodingOptions *options, @@ -277,7 +292,8 @@ Image_ErrorCode OH_DecodingOptions_SetDesiredDynamicRange(OH_DecodingOptions *op * @brief 释放OH_DecodingOptions指针。 * * @param options 被操作的OH_DecodingOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_DecodingOptions_Release(OH_DecodingOptions *options); @@ -288,7 +304,9 @@ Image_ErrorCode OH_DecodingOptions_Release(OH_DecodingOptions *options); * @param uri 指向图像源URI的指针。只接受文件URI或Base64 URI。 * @param uriSize URI长度。 * @param res 指向c++本地层创建的OH_ImageSourceNative对象的指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码数据源异常返回 IMAGE_BAD_SOURCE， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreateFromUri(char *uri, size_t uriSize, OH_ImageSourceNative **res); @@ -298,7 +316,8 @@ Image_ErrorCode OH_ImageSourceNative_CreateFromUri(char *uri, size_t uriSize, OH * * @param fd 文件描述符fd。 * @param res 指向c++本地层创建的OH_ImageSourceNative对象的指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreateFromFd(int32_t fd, OH_ImageSourceNative **res); @@ -309,7 +328,9 @@ Image_ErrorCode OH_ImageSourceNative_CreateFromFd(int32_t fd, OH_ImageSourceNati * @param data 图像缓冲区数据。 * @param dataSize 图像缓冲区数据长度。 * @param res 指向c++本地层创建的OH_ImageSourceNative对象的指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果解码数据源异常返回 IMAGE_BAD_SOURCE， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreateFromData(uint8_t *data, size_t dataSize, OH_ImageSourceNative **res); @@ -319,7 +340,8 @@ Image_ErrorCode OH_ImageSourceNative_CreateFromData(uint8_t *data, size_t dataSi * * @param rawFile 指示raw文件的文件描述符。 * @param res 指向c++本地层创建的OH_ImageSourceNative对象的指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreateFromRawFile(RawFileDescriptor *rawFile, OH_ImageSourceNative **res); @@ -330,7 +352,8 @@ Image_ErrorCode OH_ImageSourceNative_CreateFromRawFile(RawFileDescriptor *rawFil * @param source 被操作的OH_ImageSourceNative指针。 * @param options 解码参数。 * @param resPixMap 指向c++本地层创建的OH_PixelmapNative对象的指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreatePixelmap(OH_ImageSourceNative *source, OH_DecodingOptions *options, @@ -343,7 +366,9 @@ Image_ErrorCode OH_ImageSourceNative_CreatePixelmap(OH_ImageSourceNative *source * @param options 解码参数。 * @param resVecPixMap 指向c++本地层创建的OH_PixelmapNative对象的指针数组。 * @param size 数组长度。 用户可以使用{@link OH_ImageSourceNative_GetFrameCount}获取。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果不支持的操作返回 IMAGE_UNSUPPORTED_OPERATION， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_CreatePixelmapList(OH_ImageSourceNative *source, OH_DecodingOptions *options, @@ -355,7 +380,8 @@ Image_ErrorCode OH_ImageSourceNative_CreatePixelmapList(OH_ImageSourceNative *so * @param source 被操作的OH_ImageSourceNative指针。 * @param delayTimeList 指向获得的延迟时间列表的指针。它不能是空指针。 * @param size delayTimeList的大小。用户可以从{@link OH_ImageSourceNative_GetFrameCount}获得大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_GetDelayTimeList(OH_ImageSourceNative *source, int32_t *delayTimeList, size_t size); @@ -366,7 +392,8 @@ Image_ErrorCode OH_ImageSourceNative_GetDelayTimeList(OH_ImageSourceNative *sour * @param source 被操作的OH_ImageSourceNative指针。 * @param index 图片序号。对GIF图片可传入[0,N-1],N表示GIF的帧数。对只有一帧数据的图片格式，可传入0。 * @param info 指向获取的图像源信息的OH_ImageSource_Info指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_GetImageInfo(OH_ImageSourceNative *source, int32_t index, @@ -380,7 +407,8 @@ Image_ErrorCode OH_ImageSourceNative_GetImageInfo(OH_ImageSourceNative *source, * 使用ImageSource后释放，参见{@link OH_ImageSourceNative_Release}。 * @param value 指向获取的值的指针。用户可以传入一个空指针和零大小， * 我们将分配内存，但用户必须在使用后释放内存。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_GetImageProperty(OH_ImageSourceNative *source, Image_String *key, @@ -392,7 +420,8 @@ Image_ErrorCode OH_ImageSourceNative_GetImageProperty(OH_ImageSourceNative *sour * @param key 指向属性键的指针，详情请参见{@link Image_String}，key是一个exif常数。 * 使用ImageSource后释放，参见{@link OH_ImageSourceNative_Release}。 * @param value 需要修改的属性值。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_ModifyImageProperty(OH_ImageSourceNative *source, Image_String *key, @@ -403,7 +432,8 @@ Image_ErrorCode OH_ImageSourceNative_ModifyImageProperty(OH_ImageSourceNative *s * * @param source 被操作的OH_ImageSourceNative指针。 * @param frameCount 图像帧数。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_GetFrameCount(OH_ImageSourceNative *source, uint32_t *frameCount); @@ -412,7 +442,8 @@ Image_ErrorCode OH_ImageSourceNative_GetFrameCount(OH_ImageSourceNative *source, * @brief 释放OH_ImageSourceNative指针。 * * @param source 要释放的OH_ImageSourceNative指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_ImageSourceNative_Release(OH_ImageSourceNative *source); diff --git a/zh-cn/native_sdk/media/image/pixelmap_native.h b/zh-cn/native_sdk/media/image/pixelmap_native.h index cd1c288a..eea255c3 100644 --- a/zh-cn/native_sdk/media/image/pixelmap_native.h +++ b/zh-cn/native_sdk/media/image/pixelmap_native.h @@ -119,7 +119,8 @@ typedef struct OH_Pixelmap_InitializationOptions OH_Pixelmap_InitializationOptio * @brief 创建OH_Pixelmap_InitializationOptions指针。 * * @param options 被创建的OH_Pixelmap_InitializationOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_Create(OH_Pixelmap_InitializationOptions **options); @@ -129,7 +130,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_Create(OH_Pixelmap_Initializati * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param width 图片的宽，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_GetWidth(OH_Pixelmap_InitializationOptions *options, @@ -140,7 +142,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetWidth(OH_Pixelmap_Initializa * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param width 图片的宽，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_SetWidth(OH_Pixelmap_InitializationOptions *options, @@ -151,7 +154,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetWidth(OH_Pixelmap_Initializa * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param height 图片的高，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_GetHeight(OH_Pixelmap_InitializationOptions *options, @@ -162,7 +166,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetHeight(OH_Pixelmap_Initializ * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param height 图片的高，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_SetHeight(OH_Pixelmap_InitializationOptions *options, @@ -173,7 +178,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetHeight(OH_Pixelmap_Initializ * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_GetPixelFormat(OH_Pixelmap_InitializationOptions *options, @@ -184,7 +190,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetPixelFormat(OH_Pixelmap_Init * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param pixelFormat 像素格式{@link PIXEL_FORMAT}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_SetPixelFormat(OH_Pixelmap_InitializationOptions *options, @@ -195,7 +202,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetPixelFormat(OH_Pixelmap_Init * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_GetAlphaType(OH_Pixelmap_InitializationOptions *options, @@ -206,7 +214,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_GetAlphaType(OH_Pixelmap_Initia * * @param options 被操作的OH_Pixelmap_InitializationOptions指针。 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_SetAlphaType(OH_Pixelmap_InitializationOptions *options, @@ -216,7 +225,8 @@ Image_ErrorCode OH_PixelmapInitializationOptions_SetAlphaType(OH_Pixelmap_Initia * @brief 释放OH_Pixelmap_InitializationOptions指针。 * * @param options 被释放的OH_Pixelmap_InitializationOptions指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapInitializationOptions_Release(OH_Pixelmap_InitializationOptions *options); @@ -233,7 +243,8 @@ typedef struct OH_Pixelmap_ImageInfo OH_Pixelmap_ImageInfo; * @brief 创建OH_Pixelmap_ImageInfo指针。 * * @param info 被创建的OH_Pixelmap_ImageInfo指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_Create(OH_Pixelmap_ImageInfo **info); @@ -243,7 +254,8 @@ Image_ErrorCode OH_PixelmapImageInfo_Create(OH_Pixelmap_ImageInfo **info); * * @param info 被操作的OH_Pixelmap_ImageInfo指针。 * @param width 图片宽，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_GetWidth(OH_Pixelmap_ImageInfo *info, uint32_t *width); @@ -253,7 +265,8 @@ Image_ErrorCode OH_PixelmapImageInfo_GetWidth(OH_Pixelmap_ImageInfo *info, uint3 * * @param info 被操作的OH_Pixelmap_ImageInfo指针。 * @param height 图片高，单位：像素。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_GetHeight(OH_Pixelmap_ImageInfo *info, uint32_t *height); @@ -263,7 +276,8 @@ Image_ErrorCode OH_PixelmapImageInfo_GetHeight(OH_Pixelmap_ImageInfo *info, uint * * @param info 被操作的OH_Pixelmap_ImageInfo指针。 * @param rowStride 跨距，内存中每行像素所占的空间。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_GetRowStride(OH_Pixelmap_ImageInfo *info, uint32_t *rowStride); @@ -273,7 +287,8 @@ Image_ErrorCode OH_PixelmapImageInfo_GetRowStride(OH_Pixelmap_ImageInfo *info, u * * @param info 被操作的OH_Pixelmap_ImageInfo指针。 * @param pixelFormat 像素格式。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_GetPixelFormat(OH_Pixelmap_ImageInfo *info, int32_t *pixelFormat); @@ -283,7 +298,8 @@ Image_ErrorCode OH_PixelmapImageInfo_GetPixelFormat(OH_Pixelmap_ImageInfo *info, * * @param info 被操作的OH_Pixelmap_ImageInfo指针。 * @param alphaType 透明度类型{@link PIXELMAP_ALPHA_TYPE}。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_GetAlphaType(OH_Pixelmap_ImageInfo *info, int32_t *alphaType); @@ -302,7 +318,8 @@ Image_ErrorCode OH_PixelmapImageInfo_GetDynamicRange(OH_Pixelmap_ImageInfo *info * @brief 释放OH_Pixelmap_ImageInfo指针。 * * @param info 被释放的OH_Pixelmap_ImageInfo指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapImageInfo_Release(OH_Pixelmap_ImageInfo *info); @@ -314,7 +331,9 @@ Image_ErrorCode OH_PixelmapImageInfo_Release(OH_Pixelmap_ImageInfo *info); * @param dataLength 数组长度。 * @param options 创建像素的属性。 * @param pixelmap 被创建的OH_PixelmapNative对象指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果不支持的操作返回 IMAGE_UNSUPPORTED_OPERATION， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_CreatePixelmap(uint8_t *data, size_t dataLength, @@ -327,7 +346,9 @@ Image_ErrorCode OH_PixelmapNative_CreatePixelmap(uint8_t *data, size_t dataLengt * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param destination 缓冲区，获取的图像像素数据写入到该内存区域内。 * @param bufferSize 缓冲区大小。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_ReadPixels(OH_PixelmapNative *pixelmap, uint8_t *destination, size_t *bufferSize); @@ -338,7 +359,9 @@ Image_ErrorCode OH_PixelmapNative_ReadPixels(OH_PixelmapNative *pixelmap, uint8_ * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param source 图像像素数据。 * @param bufferSize 图像像素数据长度。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 如果不支持的操作返回 IMAGE_UNSUPPORTED_OPERATION，如果未知错误返回 IMAGE_UNKNOWN_ERROR， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_WritePixels(OH_PixelmapNative *pixelmap, uint8_t *source, size_t bufferSize); @@ -348,7 +371,8 @@ Image_ErrorCode OH_PixelmapNative_WritePixels(OH_PixelmapNative *pixelmap, uint8 * * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param imageInfo 图像像素信息。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_GetImageInfo(OH_PixelmapNative *pixelmap, OH_Pixelmap_ImageInfo *imageInfo); @@ -358,7 +382,8 @@ Image_ErrorCode OH_PixelmapNative_GetImageInfo(OH_PixelmapNative *pixelmap, OH_P * * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param rate 透明比率的值。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Opacity(OH_PixelmapNative *pixelmap, float rate); @@ -369,7 +394,8 @@ Image_ErrorCode OH_PixelmapNative_Opacity(OH_PixelmapNative *pixelmap, float rat * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param scaleX 宽度的缩放比例。 * @param scaleY 高度的缩放比例。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Scale(OH_PixelmapNative *pixelmap, float scaleX, float scaleY); @@ -380,7 +406,8 @@ Image_ErrorCode OH_PixelmapNative_Scale(OH_PixelmapNative *pixelmap, float scale * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param x 区域横坐标。 * @param y 区域纵坐标。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Translate(OH_PixelmapNative *pixelmap, float x, float y); @@ -390,7 +417,8 @@ Image_ErrorCode OH_PixelmapNative_Translate(OH_PixelmapNative *pixelmap, float x * * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param angle 图片旋转的角度，单位为deg。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Rotate(OH_PixelmapNative *pixelmap, float angle); @@ -401,7 +429,8 @@ Image_ErrorCode OH_PixelmapNative_Rotate(OH_PixelmapNative *pixelmap, float angl * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param shouldFilpHorizontally 是否水平翻转图像。 * @param shouldFilpVertically 是否垂直翻转图像。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Flip(OH_PixelmapNative *pixelmap, bool shouldFilpHorizontally, bool shouldFilpVertically); @@ -411,7 +440,8 @@ Image_ErrorCode OH_PixelmapNative_Flip(OH_PixelmapNative *pixelmap, bool shouldF * * @param pixelmap 被操作的OH_PixelmapNative指针。 * @param region 裁剪的尺寸。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Crop(OH_PixelmapNative *pixelmap, Image_Region *region); @@ -420,7 +450,8 @@ Image_ErrorCode OH_PixelmapNative_Crop(OH_PixelmapNative *pixelmap, Image_Region * @brief 释放OH_PixelmapNative指针。 * * @param pixelmap 被释放的OH_PixelmapNative指针。 - * @return Returns {@link Image_ErrorCode}。 + * @return 如果操作成功返回 IMAGE_SUCCESS，如果参数错误返回 IMAGE_BAD_PARAMETER， + * 具体请参考 {@link Image_ErrorCode}。 * @since 12 */ Image_ErrorCode OH_PixelmapNative_Release(OH_PixelmapNative *pixelmap); -- Gitee