From e643dda45d690e9ceeb4ee5deab27688f11f5ac5 Mon Sep 17 00:00:00 2001 From: wen Date: Fri, 27 Jun 2025 07:59:15 +0000 Subject: [PATCH 1/5] add api doc of GetIndexConstructProgress&GetDataAnalysisProgress Signed-off-by: wen --- .../js-apis-photoAccessHelper-sys.md | 120 ++++++++++++++++++ 1 file changed, 120 insertions(+) diff --git a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md index ee7935da6a2..118b221111f 100644 --- a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md +++ b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md @@ -1722,6 +1722,125 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { } ``` +### GetIndexConstructProgress + +GetIndexConstructProgress(): Promise<string> + +获取索引构建进度，使用Promise方式返回结果。 + +**系统接口**：此接口为系统接口。 + +**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core + +**需要权限**：ohos.permission.READ_IMAGEVIDEO + + +**返回值：** + +| 类型 | 说明 | +| --------------------------- | -------------- | +| Promise<string> | Promise对象，返回一个json格式的字符串。表示已经完成智慧分析的图片的数量，图片总数；已经完成智慧分析的视频的数量，视频总数。 | + +**错误码：** + +接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 + + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 201 | Permission denied. | +| 202 | Called by non-system application. | +| 14000011 | Internal system error. | + +**示例：** + +phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](arkts-apis-photoAccessHelper-f.md)的示例使用。 + +```ts +async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { + + class indexProgress { + finishedImageCount: number = 0; + totalImageCount: number = 0; + finishedVideoCount: number = 0; + totalVideoCount: number = 0; + } + + try { + console.info('getIndexConstructProgress test start'); + let photoType: photoAccessHelper.PhotoType = photoAccessHelper.PhotoType.IMAGE; + let extension: string = 'jpg'; + let options: photoAccessHelper.CreateOptions = { + title: 'testPhoto'； + } + + let uri: string = await phAccessHelper.createAsset(photoType, extension, options); + console.info('getAssets' + uri); + + let result: string = await phAccessHelper.getIndexConstructProgress(); + console.info('getIndexProgress:' + result); + + let jsonObj: indexProgress = JSON.parse(result); + // ...使用获取到的索引构建进度数据 + } catch (err) { + console.error(`getIndexConstructProgress failed, error: ${err.code}, ${err.message}`); + } +} +``` + +### GetDataAnalysisProgress12+ + +GetDataAnalysisProgress(analysisType: AnalysisType): Promise<string> + +获取资产的分析进度，使用Promise方式返回结果。 + +**系统接口**：此接口为系统接口。 + +**系统能力**：SystemCapability.FileManagement.PhotoAccessHelper.Core + +**需要权限**：ohos.permission.READ_IMAGEVIDEO + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---- | -------------- | ---- | ----- | +| analysisType | [AnalysisType](#analysistype11) | 是 | 需要获取的智慧分析类型。 | + +**返回值：** + +| 类型 | 说明 | +| --------------------------- | -------------- | +| Promise<string> | Promise对象，返回一个json格式的字符串。表示资产分析的进度。 | + +**错误码：** + +接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 201 | Permission denied. | +| 202 | Called by non-system application. | +| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | +| 14000011 | Internal system error. | + +**示例：** + +phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](arkts-apis-photoAccessHelper-f.md)的示例使用。 + +```ts +async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { + try { + console.info('GetDataAnalysisProgress test start'); + + let result: string = await phAccessHelper.GetDataAnalysisProgress(AnalysisType.ANALYSIS_HIGHLIGHT); + console.info('GetDataAnalysisProgress:' + result); + + } catch (err) { + console.error(`GetDataAnalysisProgress failed, error: ${err.code}, ${err.message}`); + } +} +``` + ### getSharedPhotoAssets13+ getSharedPhotoAssets(options: FetchOptions): Array\ @@ -8352,6 +8471,7 @@ async function example(context: Context) { | ANALYSIS\_HEAD\_POSITION12+ | 11 | 人头、宠物头位置分析类别。**系统接口**：此接口为系统接口。 | | ANALYSIS\_BONE\_POSE12+ | 12 | 人体骨骼点信息分析类别。**系统接口**：此接口为系统接口。 | | ANALYSIS\_VIDEO\_LABEL12+ | 13 | 视频标签。**系统接口**：此接口为系统接口。 | +| ANALYSIS\_HIGHLIGHT12+ | 14 | 时刻标签。**系统接口**：此接口为系统接口。 | ## HighlightAlbumInfoType12+ -- Gitee From 7cbef5e4a745fdd567a50a99a366009ed2febe55 Mon Sep 17 00:00:00 2001 From: wen Date: Tue, 1 Jul 2025 09:05:27 +0000 Subject: [PATCH 2/5] =?UTF-8?q?update=20zh-cn/application-dev/reference/ap?= =?UTF-8?q?is-media-library-kit/js-apis-=E2=80=A6=20Signed-off-by:=20wen?= =?UTF-8?q?=20?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../js-apis-photoAccessHelper-sys.md | 25 ++++++------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md index 118b221111f..3cc59c1a520 100644 --- a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md +++ b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md @@ -1722,11 +1722,11 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { } ``` -### GetIndexConstructProgress +### GetIndexConstructProgress12+ GetIndexConstructProgress(): Promise<string> -获取索引构建进度，使用Promise方式返回结果。 +获取索引构建进度。使用Promise异步回调。 **系统接口**：此接口为系统接口。 @@ -1739,11 +1739,11 @@ GetIndexConstructProgress(): Promise<string> | 类型 | 说明 | | --------------------------- | -------------- | -| Promise<string> | Promise对象，返回一个json格式的字符串。表示已经完成智慧分析的图片的数量，图片总数；已经完成智慧分析的视频的数量，视频总数。 | +| Promise<string> | Promise对象，返回一个json格式的字符串。表示已完成智慧分析的图片数量、总数和已经完成智慧分析的视频数量、总数。 | **错误码：** -接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 | 错误码ID | 错误信息 | @@ -1768,20 +1768,11 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { try { console.info('getIndexConstructProgress test start'); - let photoType: photoAccessHelper.PhotoType = photoAccessHelper.PhotoType.IMAGE; - let extension: string = 'jpg'; - let options: photoAccessHelper.CreateOptions = { - title: 'testPhoto'； - } - - let uri: string = await phAccessHelper.createAsset(photoType, extension, options); - console.info('getAssets' + uri); - let result: string = await phAccessHelper.getIndexConstructProgress(); console.info('getIndexProgress:' + result); let jsonObj: indexProgress = JSON.parse(result); - // ...使用获取到的索引构建进度数据 + // ...使用获取到的索引构建进度数据。 } catch (err) { console.error(`getIndexConstructProgress failed, error: ${err.code}, ${err.message}`); } @@ -1792,7 +1783,7 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { GetDataAnalysisProgress(analysisType: AnalysisType): Promise<string> -获取资产的分析进度，使用Promise方式返回结果。 +获取资产的分析进度。使用Promise异步回调。 **系统接口**：此接口为系统接口。 @@ -1814,7 +1805,7 @@ GetDataAnalysisProgress(analysisType: AnalysisType): Promise<string> **错误码：** -接口抛出错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 +以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[文件管理错误码](../apis-core-file-kit/errorcode-filemanagement.md)。 | 错误码ID | 错误信息 | | -------- | ---------------------------------------- | @@ -1832,7 +1823,7 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { try { console.info('GetDataAnalysisProgress test start'); - let result: string = await phAccessHelper.GetDataAnalysisProgress(AnalysisType.ANALYSIS_HIGHLIGHT); + let result: string = await phAccessHelper.GetDataAnalysisProgress(photoAccessHelper.AnalysisType.ANALYSIS_FACE); console.info('GetDataAnalysisProgress:' + result); } catch (err) { -- Gitee From cc9334be9002814e4fc5861e87c2831f2a1f78a1 Mon Sep 17 00:00:00 2001 From: wen Date: Tue, 1 Jul 2025 09:30:48 +0000 Subject: [PATCH 3/5] =?UTF-8?q?update=20zh-cn/application-dev/reference/ap?= =?UTF-8?q?is-media-library-kit/js-apis-=E2=80=A6=20Signed-off-by:=20wen?= =?UTF-8?q?=20?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../apis-media-library-kit/js-apis-photoAccessHelper-sys.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md index 3cc59c1a520..a90e3c28ab3 100644 --- a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md +++ b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md @@ -1754,7 +1754,7 @@ GetIndexConstructProgress(): Promise<string> **示例：** -phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](arkts-apis-photoAccessHelper-f.md)的示例使用。 +phAccessHelper的创建请参考[photoAccessHelper.getPhotoAccessHelper](arkts-apis-photoAccessHelper-f.md#photoaccesshelpergetphotoaccesshelper)的示例使用。 ```ts async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { @@ -1816,7 +1816,7 @@ GetDataAnalysisProgress(analysisType: AnalysisType): Promise<string> **示例：** -phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](arkts-apis-photoAccessHelper-f.md)的示例使用。 +phAccessHelper的创建请参考[photoAccessHelper.getPhotoAccessHelper](arkts-apis-photoAccessHelper-f.md#photoaccesshelpergetphotoaccesshelper)的示例使用。 ```ts async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { -- Gitee From ed8da4db7ea1633661dab8554ce49e73bb5cb823 Mon Sep 17 00:00:00 2001 From: wen Date: Wed, 2 Jul 2025 07:47:04 +0000 Subject: [PATCH 4/5] =?UTF-8?q?update=20zh-cn/application-dev/reference/ap?= =?UTF-8?q?is-media-library-kit/js-apis-=E2=80=A6=20Signed-off-by:=20wen?= =?UTF-8?q?=20?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../js-apis-photoAccessHelper-sys.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md index a90e3c28ab3..0e7108d80d5 100644 --- a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md +++ b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md @@ -1722,9 +1722,9 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { } ``` -### GetIndexConstructProgress12+ +### getIndexConstructProgress12+ -GetIndexConstructProgress(): Promise<string> +getIndexConstructProgress(): Promise<string> 获取索引构建进度。使用Promise异步回调。 @@ -1779,9 +1779,9 @@ async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { } ``` -### GetDataAnalysisProgress12+ +### getDataAnalysisProgress12+ -GetDataAnalysisProgress(analysisType: AnalysisType): Promise<string> +getDataAnalysisProgress(analysisType: AnalysisType): Promise<string> 获取资产的分析进度。使用Promise异步回调。 @@ -1821,13 +1821,13 @@ phAccessHelper的创建请参考[photoAccessHelper.getPhotoAccessHelper](arkts-a ```ts async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { try { - console.info('GetDataAnalysisProgress test start'); + console.info('getDataAnalysisProgress test start'); - let result: string = await phAccessHelper.GetDataAnalysisProgress(photoAccessHelper.AnalysisType.ANALYSIS_FACE); - console.info('GetDataAnalysisProgress:' + result); + let result: string = await phAccessHelper.getDataAnalysisProgress(photoAccessHelper.AnalysisType.ANALYSIS_FACE); + console.info('getDataAnalysisProgress:' + result); } catch (err) { - console.error(`GetDataAnalysisProgress failed, error: ${err.code}, ${err.message}`); + console.error(`getDataAnalysisProgress failed, error: ${err.code}, ${err.message}`); } } ``` -- Gitee From 3795b4b84e103a2ae467dbdccdf27e82fe4b309c Mon Sep 17 00:00:00 2001 From: wen Date: Thu, 3 Jul 2025 04:38:02 +0000 Subject: [PATCH 5/5] update zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md. Signed-off-by: wen --- .../apis-media-library-kit/js-apis-photoAccessHelper-sys.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md index 0e7108d80d5..6862a4ee52c 100644 --- a/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md +++ b/zh-cn/application-dev/reference/apis-media-library-kit/js-apis-photoAccessHelper-sys.md @@ -1754,7 +1754,7 @@ getIndexConstructProgress(): Promise<string> **示例：** -phAccessHelper的创建请参考[photoAccessHelper.getPhotoAccessHelper](arkts-apis-photoAccessHelper-f.md#photoaccesshelpergetphotoaccesshelper)的示例使用。 +phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](js-apis-photoAccessHelper.md)的示例使用。 ```ts async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { @@ -1816,7 +1816,7 @@ getDataAnalysisProgress(analysisType: AnalysisType): Promise<string> **示例：** -phAccessHelper的创建请参考[photoAccessHelper.getPhotoAccessHelper](arkts-apis-photoAccessHelper-f.md#photoaccesshelpergetphotoaccesshelper)的示例使用。 +phAccessHelper的创建请参考[@ohos.file.photoAccessHelper (相册管理模块)](js-apis-photoAccessHelper.md)的示例使用。 ```ts async function example(phAccessHelper: photoAccessHelper.PhotoAccessHelper) { -- Gitee