Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 bb673af4 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!21108 媒体库接口一致性和示例代码修改 

Merge pull request !21108 from 胡伟奇/demo_update
上级 ac1b3ee3 4a91ab20
隐藏空白更改
内联 并排
Showing with 254 addition and 49 deletion
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ bb673af4
......@@ -3,9 +3,7 @@
> **说明：**
>
> - 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 从API Version 9开始废弃。保留至API Version 13版本。
> - 部分功能变更为系统接口，仅供系统应用使用，请使用[@ohos.filemanagement.userFileManager](js-apis-userFileManager.md)相应接口替代。
> - 媒体资源选择和保存功能仍开放给普通应用，请使用[@ohos.file.picker](js-apis-file-picker.md)相应接口替代。
> - 本模块从API version 9开始废弃。对应的替代接口请参考具体接口说明。
## 导入模块
......@@ -21,6 +19,9 @@ getMediaLibrary(context: Context): MediaLibrary
此接口仅可在Stage模型下使用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getPhotoAccessHelper](js-apis-photoAccessHelper.md#photoaccesshelpergetphotoaccesshelper)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -60,6 +61,9 @@ getMediaLibrary(): MediaLibrary
此接口仅可在FA模型下使用。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -83,7 +87,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
获取文件资源，使用callback方式返回异步结果。
> **说明：**
> 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
> - 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -154,7 +160,9 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>
获取文件资源，使用Promise方式返回结果。
> **说明：**
> 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
> - 在API version 10上，摒弃了物理目录作为相册的设计，采用了逻辑相册的设计，一个相册中可以添加多个文件，一个文件也可以在多个相册中呈现。新的设计将带来parent、albumId、albumUri和albumName属性使用上的不兼容，无法作为MediaFetchOptions的参数在getFileAssets接口中使用。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -225,6 +233,9 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'
打开媒体库变更通知，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[registerChange](js-apis-photoAccessHelper.md#registerchange)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -248,6 +259,9 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange
关闭媒体库变更通知，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[unRegisterChange](js-apis-photoAccessHelper.md#unregisterchange)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -272,7 +286,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal
创建媒体资源，使用callback方式返回结果。
> **说明：**
> 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -312,7 +328,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr
创建媒体资源，使用Promise方式返回结果。
> **说明：**
> 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[createAsset](js-apis-photoAccessHelper.md#createasset-1)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，文件创建成功后，relativePath的最后一级目录不会作为相册呈现。变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -354,6 +372,9 @@ deleteAsset(uri: string): Promise\<void>
删除媒体文件资源。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-3)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA 和 ohos.permission.WRITE_MEDIA
......@@ -403,6 +424,9 @@ deleteAsset(uri: string, callback: AsyncCallback\<void>): void
删除媒体文件资源。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteassets-2)替代。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA 和 ohos.permission.WRITE_MEDIA
......@@ -449,6 +473,9 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;):
获取公共目录路径，使用callback方式返回结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -477,6 +504,9 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt;
获取公共目录路径，使用Promise方式返回结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -515,7 +545,9 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback&lt;Array&lt;Album&
获取相册列表，使用callback 方式返回结果。
> **说明：**
> 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件，当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件，当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -553,7 +585,9 @@ getAlbums(options: MediaFetchOptions): Promise&lt;Array&lt;Album&gt;&gt;
获取相册列表，使用 promise 方式返回结果。
> **说明：**
> 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件.当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[getAlbums](js-apis-photoAccessHelper.md#getalbums-2)替代。
> - 由于API version 10的SDK上relativePath和相册没有关联关系，在使用getAlbums时不支持relativePath作为查询条件.当前仅支持“Camera”和“ScreenShots”两类相册，变更详情请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -594,6 +628,9 @@ release(callback: AsyncCallback&lt;void&gt;): void
释放MediaLibrary实例。
当后续不需要使用MediaLibrary实例中的方法时调用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -617,6 +654,9 @@ release(): Promise&lt;void&gt;
释放MediaLibrary实例。
当后续不需要使用MediaLibrary实例中的方法时调用。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[release](js-apis-photoAccessHelper.md#release-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -637,7 +677,10 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;)
保存媒体资源，以异步方法获取保存成功的URI，使用callback形式返回结果。
> **说明**：此接口为API Version 6开始支持，只支持FA模型使用。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[save](js-apis-file-picker.md#save-1)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -672,7 +715,10 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
保存媒体资源，以异步方法获取保存成功的URI，使用Promise形式返回结果。
> **说明**：此接口为API Version 6开始支持，只支持FA模型使用。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[save](js-apis-file-picker.md#save)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -710,9 +756,10 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。
> **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -753,9 +800,10 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g
启动图片预览界面，可以预览列表中首张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。
> **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -794,9 +842,10 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用Promise方式进行异步回调。
> **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -840,9 +889,10 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;
启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用callback形式返回结果。
> **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用系统应用图库替代。图库是系统内置的可视资源访问应用，提供图片和视频的管理、浏览等功能，使用方法请参考[OpenHarmony/applications_photos](https://gitee.com/openharmony/applications_photos#4-%E5%85%B8%E5%9E%8B%E6%8E%A5%E5%8F%A3%E7%9A%84%E4%BD%BF%E7%94%A8)。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[select](js-apis-file-picker.md#select-1)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -876,9 +926,10 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用Promise形式返回结果。
> **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用系统应用图库替代。图库是系统内置的可视资源访问应用，提供图片和视频的管理、浏览等功能，使用方法请参考[OpenHarmony/applications_photos](https://gitee.com/openharmony/applications_photos#4-%E5%85%B8%E5%9E%8B%E6%8E%A5%E5%8F%A3%E7%9A%84%E4%BD%BF%E7%94%A8)。
> **说明：**
>
> - 此接口为API Version 6开始支持，只支持FA模型使用。
> - 此接口从API Version 9开始废弃。请使用[select](js-apis-file-picker.md#select)接口替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -915,6 +966,9 @@ getActivePeers(): Promise\<Array\<PeerInfo>>;
获取在线对端设备的信息，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -949,6 +1003,9 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
获取在线对端设备的信息，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -981,6 +1038,9 @@ getAllPeers(): Promise\<Array\<PeerInfo>>;
获取所有对端设备的信息，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1015,6 +1075,9 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
获取所有对端设备的信息，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**需要权限**：ohos.permission.READ_MEDIA
......@@ -1047,8 +1110,9 @@ async function example() {
> **说明：**
>
> 1. title字段默认为去掉后缀的文件名，音频和视频文件会尝试解析文件内容，部分设备写入后在触发扫描时会被还原。
> 2. orientation字段部分设备可能不支持修改，建议使用image组件的[ModifyImageProperty](js-apis-image.md#modifyimageproperty9)接口。
> - title字段默认为去掉后缀的文件名，音频和视频文件会尝试解析文件内容，部分设备写入后在触发扫描时会被还原。
> - orientation字段部分设备可能不支持修改，建议使用image组件的[ModifyImageProperty](js-apis-image.md#modifyimageproperty9)接口。
> - 此接口从API Version 9开始废弃。请使用[PhotoAsset](js-apis-photoAccessHelper.md#photoasset)替代。
### 属性
......@@ -1084,6 +1148,9 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void
判断fileAsset是否为目录，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1124,6 +1191,9 @@ isDirectory():Promise&lt;boolean&gt;
判断fileAsset是否为目录，使用Promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1163,7 +1233,9 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
修改文件的元数据，使用callback方式返回异步结果。
> **说明：**
> 由于API version 10的SDK上audio没有orientation属性，在使用commitModify接口时将无法对audio资源的orientation属性进行修改。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
>
> - 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify)替代。
> - 由于API version 10的SDK上audio没有orientation属性，在使用commitModify接口时将无法对audio资源的orientation属性进行修改。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1203,6 +1275,8 @@ commitModify(): Promise&lt;void&gt;
修改文件的元数据，使用promise方式返回异步结果。
> **说明：**
>
> - 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-1)替代。
> 由于API version 10的SDK上audio没有orientation属性，在使用commitModify接口时将无法对audio资源的orientation属性进行修改。请参考[changelogs-mediaLibrary.md](../../../release-notes/changelogs/OpenHarmony_4.0.8.2/changelogs-mediaLibrary.md)。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
......@@ -1240,6 +1314,9 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
打开当前文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open)替代。
**注意**：以 'w' 模式打开文件时，返回的fd无法进行读取。但由于不同文件系统实现上的差异，部分用户态文件系统在 'w' 模式打开时会允许用fd读取。若有针对fd的读写行为，建议使用 'rw' 模式打开文件。当前写操作是互斥的操作，写操作完成后需要调用close进行释放。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
......@@ -1277,6 +1354,9 @@ open(mode: string): Promise&lt;number&gt;
打开当前文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[open](js-apis-photoAccessHelper.md#open-1)替代。
**注意**：以 'w' 模式打开文件时，返回的fd无法进行读取。但由于不同文件系统实现上的差异，部分用户态文件系统在 'w' 模式打开时会允许用fd读取。若有针对fd的读写行为，建议使用 'rw' 模式打开文件。当前写操作是互斥的操作，写操作完成后需要调用close进行释放。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
......@@ -1317,6 +1397,9 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void
关闭当前文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1363,6 +1446,9 @@ close(fd: number): Promise&lt;void&gt;
关闭当前文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close-1)替代。
**需要权限**：ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1412,6 +1498,9 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void
获取文件的缩略图，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1452,6 +1541,9 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-1)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1494,6 +1586,9 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;
获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#getThumbnail-2)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1539,6 +1634,9 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
将文件设置为收藏文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1580,6 +1678,9 @@ favorite(isFavorite: boolean): Promise&lt;void&gt;
将文件设置为收藏文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[setFavorite](js-apis-photoAccessHelper.md#setfavorite-1)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1624,6 +1725,9 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void
判断该文件是否为收藏文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1664,6 +1768,9 @@ isFavorite():Promise&lt;boolean&gt;
判断该文件是否为收藏文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1704,6 +1811,9 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void
放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1747,6 +1857,9 @@ trash(isTrash: boolean): Promise&lt;void&gt;
放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[deleteAssets](js-apis-photoAccessHelper.md#deleteAssets-1)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1791,6 +1904,9 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void
当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1831,6 +1947,9 @@ isTrash():Promise&lt;boolean&gt;
当文件被定位，判断文件是否为垃圾文件，使用promise方式返回异步结果。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -1867,12 +1986,18 @@ async function example() {
文件检索结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[FetchResult](js-apis-photoAccessHelper.md#fetchresult)替代。
### getCount<sup>7+</sup>
getCount(): number
获取文件检索结果中的文件总数。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getCount](js-apis-photoAccessHelper.md#getcount)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -1905,6 +2030,9 @@ isAfterLast(): boolean
检查结果集是否指向最后一行。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[isAfterLast](js-apis-photoAccessHelper.md#isafterlast)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -1945,6 +2073,9 @@ close(): void
释放 FetchFileResult 实例并使其失效。无法调用其他方法。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[close](js-apis-photoAccessHelper.md#close)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**示例：**
......@@ -1969,6 +2100,9 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -2006,6 +2140,9 @@ getFirstObject(): Promise&lt;FileAsset&gt;
获取文件检索结果中的第一个文件资产。此方法使用Promise方式返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getFirstObject](js-apis-photoAccessHelper.md#getfirstobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -2041,7 +2178,10 @@ getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中的下一个文件资产，此方法使用callback形式返回结果。
> **说明**： 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> **说明：**
>
> - 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> - 此接口从API Version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2085,7 +2225,10 @@ getNextObject(): Promise&lt;FileAsset&gt;
获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。
> **说明**： 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> **说明：**
>
> - 在使用前需要先使用[getFirstObject](#getfirstobject7)接口获取第一个文件资产，然后使用[isAfterLast](#isafterlast7)确认文件检索集当前不是指向最后一个时方可使用此接口。
> - 此接口从API Version 9开始废弃。请使用[getNextObject](js-apis-photoAccessHelper.md#getnextobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2126,6 +2269,9 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -2163,6 +2309,9 @@ getLastObject(): Promise&lt;FileAsset&gt;
获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getLastObject](js-apis-photoAccessHelper.md#getlastobject-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -2198,6 +2347,9 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -2236,6 +2388,9 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getObjectByPosition](js-apis-photoAccessHelper.md#getobjectbyposition-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -2277,6 +2432,9 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：**
......@@ -2316,6 +2474,9 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAllObjects](js-apis-photoAccessHelper.md#getallobjects-1)替代。
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值：**
......@@ -2351,6 +2512,9 @@ async function example() {
实体相册
> **说明：**
> 此接口从API Version 9开始废弃。请使用[Album](js-apis-photoAccessHelper.md#album)替代。
### 属性
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2371,6 +2535,9 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
更新相册属性修改到数据库中。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-2)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2409,6 +2576,9 @@ commitModify(): Promise&lt;void&gt;
更新相册属性修改到数据库中。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[commitModify](js-apis-photoAccessHelper.md#commitmodify-3)替代。
**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2445,6 +2615,9 @@ getFileAssets(callback: AsyncCallback&lt;FetchFileResult&gt;): void
按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2486,6 +2659,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2532,6 +2708,9 @@ async function example() {
按照检索条件获取相册中的文件。此方法使用异步Promise来返回文件结果集。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[getAssets](js-apis-photoAccessHelper.md#getassets-1)替代。
**需要权限**：ohos.permission.READ_MEDIA
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2579,6 +2758,9 @@ async function example() {
注册设备的信息。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
......@@ -2594,6 +2776,9 @@ async function example() {
枚举，媒体类型。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[PhotoType](js-apis-photoAccessHelper.md#phototype)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 值 | 说明 |
......@@ -2608,7 +2793,9 @@ async function example() {
枚举，文件关键信息。
> **说明：**
> bucket_id字段在文件重命名或移动后可能会发生变化，开发者使用前需要重新获取。
>
> - bucket_id字段在文件重命名或移动后可能会发生变化，开发者使用前需要重新获取。
> - 此接口从API Version 9开始废弃。请使用[PhotoKeys](js-apis-photoAccessHelper.md#photokeys)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
......@@ -2638,6 +2825,9 @@ async function example() {
枚举，目录类型。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 值 | 说明 |
......@@ -2653,6 +2843,9 @@ async function example() {
枚举，设备类型。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统接口**：此接口为系统接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
......@@ -2671,6 +2864,9 @@ async function example() {
检索条件。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[FetchOptions](js-apis-photoAccessHelper.md#fetchoptions)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......@@ -2686,6 +2882,9 @@ async function example() {
图片尺寸。
> **说明：**
> 此接口从API Version 9开始废弃。请使用[image.Size](js-apis-image.md#size)替代。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......@@ -2697,6 +2896,9 @@ async function example() {
媒体资源选项。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......@@ -2709,6 +2911,9 @@ async function example() {
媒体资源类型选项。
> **说明：**
> 此接口从API Version 9开始废弃。无替代接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-photoAccessHelper.md
浏览文件 @ bb673af4
......@@ -401,9 +401,9 @@ async function example() {
let options = {
title: 'testPhoto'
}
phAccessHelper.createAsset(photoType, extension, options, (err, photoAsset) => {
if (photoAsset != undefined) {
console.info('createAsset file displayName' + photoAsset.displayName);
phAccessHelper.createAsset(photoType, extension, options, (err, uri) => {
if (uri != undefined) {
console.info('createAsset uri' + uri);
console.info('createAsset successfully');
} else {
console.error('createAsset failed, message = ', err);
......@@ -445,9 +445,9 @@ async function example() {
console.info('createAssetDemo');
let photoType = photoAccessHelper.PhotoType.IMAGE;
let extension = 'jpg';
phAccessHelper.createAsset(photoType, extension, (err, photoAsset) => {
phAccessHelper.createAsset(photoType, extension, (err, uri) => {
if (photoAsset != undefined) {
console.info('createAsset file displayName' + photoAsset.displayName);
console.info('createAsset uri' + uri);
console.info('createAsset successfully');
} else {
console.error('createAsset failed, message = ', err);
......@@ -499,8 +499,8 @@ async function example() {
let options = {
title: 'testPhoto'
}
let photoAsset = await phAccessHelper.createAsset(photoType,extension, options);
console.info('createAsset file displayName' + photoAsset.displayName);
let uri = await phAccessHelper.createAsset(photoType, extension, options);
console.info('createAsset uri' + uri);
console.info('createAsset successfully');
} catch (err) {
console.error('createAsset failed, message = ', err);
......@@ -1081,11 +1081,11 @@ async function example() {
// 注册onCallback2监听
phAccessHelper.registerChange(photoAsset.uri, false, onCallback2);
photoAsset.favorite(true, (err) => {
photoAsset.setFavorite(true, (err) => {
if (err == undefined) {
console.info('favorite successfully');
console.info('setFavorite successfully');
} else {
console.error('favorite failed with error:' + err);
console.error('setFavorite failed with error:' + err);
}
});
}
......@@ -1145,11 +1145,11 @@ async function example() {
phAccessHelper.registerChange(photoAsset.uri, false, onCallback2);
// 关闭onCallback1监听，onCallback2 继续监听
phAccessHelper.unRegisterChange(photoAsset.uri, onCallback1);
photoAsset.favorite(true, (err) => {
photoAsset.setFavorite(true, (err) => {
if (err == undefined) {
console.info('favorite successfully');
console.info('setFavorite successfully');
} else {
console.error('favorite failed with error:' + err);
console.error('setFavorite failed with error:' + err);
}
});
}
......@@ -2866,7 +2866,7 @@ async function example() {
fetchColumns: [],
predicates: predicates
};
const albumList = await phAccessHelper.getAlbums(albumFetchOptions);
const albumList = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
const album = await albumList.getFirstObject();
album.getAssets(fetchOption, (err, albumFetchResult) => {
if (albumFetchResult != undefined) {
......@@ -2924,7 +2924,7 @@ async function example() {
fetchColumns: [],
predicates: predicates
};
const albumList = await phAccessHelper.getAlbums(albumFetchOptions);
const albumList = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
const album = await albumList.getFirstObject();
album.getAssets(fetchOption).then((albumFetchResult) => {
console.info('album getPhotoAssets successfully, getCount: ' + albumFetchResult.getCount());
......@@ -2969,7 +2969,7 @@ async function example() {
let albumFetchOptions = {
predicates: predicates
};
const albumList = await phAccessHelper.getAlbums(albumFetchOptions);
const albumList = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
const album = await albumList.getFirstObject();
album.albumName = 'hello';
album.commitModify((err) => {
......@@ -3017,7 +3017,7 @@ async function example() {
let albumFetchOptions = {
predicates: predicates
};
const albumList = await phAccessHelper.getAlbums(albumFetchOptions);
const albumList = await phAccessHelper.getAlbums(photoAccessHelper.AlbumType.USER, photoAccessHelper.AlbumSubtype.USER_GENERIC, albumFetchOptions);
const album = await albumList.getFirstObject();
album.albumName = 'hello';
album.commitModify().then(() => {
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或