Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

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

!19690 mediaLibrary 文档格式修改 

Merge pull request !19690 from 胡伟奇/mediaLibrary
上级 ade8422b a3a03ba4
隐藏空白更改
内联 并排
Showing with 972 addition and 978 deletion
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ 4e7341eb
# @ohos.multimedia.medialibrary (媒体库管理) # @ohos.multimedia.medialibrary (媒体库管理)
> **说明：** > **说明：**
>
> - 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 > - 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
> - 从API Version 9开始废弃。保留至API Version 13版本。 > - 从API Version 9开始废弃。保留至API Version 13版本。
> - 部分功能变更为系统接口，仅供系统应用使用，请使用[@ohos.filemanagement.userFileManager](js-apis-userFileManager.md)相应接口替代。 > - 部分功能变更为系统接口，仅供系统应用使用，请使用[@ohos.filemanagement.userFileManager](js-apis-userFileManager.md)相应接口替代。
> - 媒体资源选择和保存功能仍开放给普通应用，请使用[@ohos.file.picker](js-apis-file-picker.md)相应接口替代。 > - 媒体资源选择和保存功能仍开放给普通应用，请使用[@ohos.file.picker](js-apis-file-picker.md)相应接口替代。
## 导入模块 ## 导入模块
```js ```js
import mediaLibrary from '@ohos.multimedia.mediaLibrary'; import mediaLibrary from '@ohos.multimedia.mediaLibrary';
``` ```
...@@ -21,7 +23,7 @@ getMediaLibrary(context: Context): MediaLibrary ...@@ -21,7 +23,7 @@ getMediaLibrary(context: Context): MediaLibrary
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -31,12 +33,12 @@ getMediaLibrary(context: Context): MediaLibrary ...@@ -31,12 +33,12 @@ getMediaLibrary(context: Context): MediaLibrary
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------- | :---- | | ----------------------------- | :---- |
| [MediaLibrary](#medialibrary) | 媒体库实例 | | [MediaLibrary](#medialibrary) | 媒体库实例。 |
**示例：（从API Version 9开始）** **示例：（从API Version 9开始）**
```ts ```ts
// 获取mediaLibrary实例，后续用到此实例均采用此处获取的实例 // 获取mediaLibrary实例，后续用到此实例均采用此处获取的实例。
const context = getContext(this); const context = getContext(this);
let media = mediaLibrary.getMediaLibrary(context); let media = mediaLibrary.getMediaLibrary(context);
``` ```
...@@ -64,7 +66,7 @@ getMediaLibrary(): MediaLibrary ...@@ -64,7 +66,7 @@ getMediaLibrary(): MediaLibrary
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------- | :--------- | | ----------------------------- | :--------- |
| [MediaLibrary](#medialibrary) | 媒体库实例 | | [MediaLibrary](#medialibrary) | 媒体库实例。 |
**示例：** **示例：**
...@@ -88,57 +90,57 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe ...@@ -88,57 +90,57 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | --------------------------------- | | -------- | --------------------------------------------------- | ---- | --------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件获取选项 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件检索选项。 |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步获取FetchFileResult之后的回调 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | callback返回文件检索结果集。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
// 创建文件获取选项，此处参数为获取image类型的文件资源 // 创建文件获取选项，此处参数为获取image类型的文件资源。
let imagesFetchOp = { let imagesFetchOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
}; };
// 获取文件资源，使用callback方式返回异步结果 // 获取文件资源，使用callback方式返回异步结果。
media.getFileAssets(imagesFetchOp, async (error, fetchFileResult) => { media.getFileAssets(imagesFetchOp, async (error, fetchFileResult) => {
// 判断获取的文件资源的检索结果集是否为undefined，若为undefined则接口调用失败 // 判断获取的文件资源的检索结果集是否为undefined，若为undefined则接口调用失败。
if (fetchFileResult == undefined) { if (fetchFileResult == undefined) {
console.error('get fetchFileResult failed with error: ' + error); console.error('get fetchFileResult failed with error: ' + error);
return; return;
} }
// 获取文件检索结果集中的总数 // 获取文件检索结果集中的总数。
const count = fetchFileResult.getCount(); const count = fetchFileResult.getCount();
// 判断结果集中的数量是否小于0，小于0时表示接口调用失败 // 判断结果集中的数量是否小于0，小于0时表示接口调用失败。
if (count < 0) { if (count < 0) {
console.error('get count from fetchFileResult failed, count: ' + count); console.error('get count from fetchFileResult failed, count: ' + count);
return; return;
} }
// 判断结果集中的数量是否等于0，等于0时表示接口调用成功，但是检索结果集为空，请检查文件获取选项参数配置是否有误和设备中是否存在相应文件 // 判断结果集中的数量是否等于0，等于0时表示接口调用成功，但是检索结果集为空，请检查文件获取选项参数配置是否有误和设备中是否存在相应文件。
if (count == 0) { if (count == 0) {
console.info('The count of fetchFileResult is zero'); console.info('The count of fetchFileResult is zero');
return; return;
} }
console.info('Get fetchFileResult successfully, count: ' + count); console.info('Get fetchFileResult successfully, count: ' + count);
// 获取文件检索结果集中的第一个资源，使用callback方式返回异步结果，文件数量较多时请使用getAllObject接口 // 获取文件检索结果集中的第一个资源，使用callback方式返回异步结果，文件数量较多时请使用getAllObject接口。
fetchFileResult.getFirstObject(async (error, fileAsset) => { fetchFileResult.getFirstObject(async (error, fileAsset) => {
// 检查获取的第一个资源是否为undefined，若为undefined则接口调用失败 // 检查获取的第一个资源是否为undefined，若为undefined则接口调用失败。
if (fileAsset == undefined) { if (fileAsset == undefined) {
console.error('get first object failed with error: ' + error); console.error('get first object failed with error: ' + error);
return; return;
} }
console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName); console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName);
// 调用 getNextObject 接口获取下一个资源，直到最后一个 // 调用 getNextObject 接口获取下一个资源，直到最后一个。
for (let i = 1; i < count; i++) { for (let i = 1; i < count; i++) {
let fileAsset = await fetchFileResult.getNextObject(); let fileAsset = await fetchFileResult.getNextObject();
console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName); console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName);
} }
// 释放FetchFileResult实例并使其失效。无法调用其他方法 // 释放FetchFileResult实例并使其失效。无法调用其他方法。
fetchFileResult.close(); fetchFileResult.close();
});
}); });
});
} }
``` ```
...@@ -156,58 +158,58 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt; ...@@ -156,58 +158,58 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------ | | ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件检索选项 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件检索选项。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------ | -------------- | | ------------------------------------ | -------------- |
| [FetchFileResult](#fetchfileresult7) | 文件数据结果集 | | Promise&lt;[FetchFileResult](#fetchfileresult7)&gt; | Promise对象，返回文件检索结果集。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
// 创建文件获取选项，此处参数为获取image类型的文件资源 // 创建文件获取选项，此处参数为获取image类型的文件资源。
let imagesFetchOp = { let imagesFetchOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
}; };
// 获取文件资源，使用Promise方式返回结果 // 获取文件资源，使用Promise方式返回结果。
media.getFileAssets(imagesFetchOp).then(async (fetchFileResult) => { media.getFileAssets(imagesFetchOp).then(async (fetchFileResult) => {
// 获取文件检索结果集中的总数 // 获取文件检索结果集中的总数。
const count = fetchFileResult.getCount(); const count = fetchFileResult.getCount();
// 判断结果集中的数量是否小于0，小于0时表示接口调用失败 // 判断结果集中的数量是否小于0，小于0时表示接口调用失败。
if (count < 0) { if (count < 0) {
console.error('get count from fetchFileResult failed, count: ' + count); console.error('get count from fetchFileResult failed, count: ' + count);
return; return;
} }
// 判断结果集中的数量是否等于0，等于0时表示接口调用成功，但是检索结果集为空，请检查文件获取选项参数配置是否有误和设备中是否存在相应文件 // 判断结果集中的数量是否等于0，等于0时表示接口调用成功，但是检索结果集为空，请检查文件获取选项参数配置是否有误和设备中是否存在相应文件。
if (count == 0) { if (count == 0) {
console.info('The count of fetchFileResult is zero'); console.info('The count of fetchFileResult is zero');
return; return;
} }
console.info('Get fetchFileResult successfully, count: ' + count); console.info('Get fetchFileResult successfully, count: ' + count);
// 获取文件检索结果集中的第一个资源，使用Promise方式返回异步结果，文件数量较多时请使用getAllObject接口 // 获取文件检索结果集中的第一个资源，使用Promise方式返回异步结果，文件数量较多时请使用getAllObject接口。
fetchFileResult.getFirstObject().then(async (fileAsset) => { fetchFileResult.getFirstObject().then(async (fileAsset) => {
console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName); console.info('fileAsset.displayName ' + '0 : ' + fileAsset.displayName);
// 调用 getNextObject 接口获取下一个资源，直到最后一个 // 调用 getNextObject 接口获取下一个资源，直到最后一个。
for (let i = 1; i < count; i++) { for (let i = 1; i < count; i++) {
let fileAsset = await fetchFileResult.getNextObject(); let fileAsset = await fetchFileResult.getNextObject();
console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName); console.info('fileAsset.displayName ' + i + ': ' + fileAsset.displayName);
} }
// 释放FetchFileResult实例并使其失效。无法调用其他方法 // 释放FetchFileResult实例并使其失效。无法调用其他方法。
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => {
// 调用getFirstObject接口失败
console.error('get first object failed with error: ' + error);
});
}).catch((error) => { }).catch((error) => {
// 调用getFileAssets接口失败 // 调用getFirstObject接口失败。
console.error('get file assets failed with error: ' + error); console.error('get first object failed with error: ' + error);
}); });
}).catch((error) => {
// 调用getFileAssets接口失败。
console.error('get file assets failed with error: ' + error);
});
} }
``` ```
...@@ -223,16 +225,17 @@ on(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange' ...@@ -223,16 +225,17 @@ on(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange'
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- | | -------- | -------------------- | ---- | ---------------------------------------- |
| type | 'deviceChange'&#124;<br/>'albumChange'&#124;<br/>'imageChange'&#124;<br/>'audioChange'&#124;<br/>'videoChange'&#124;<br/>'fileChange'&#124;<br/>'remoteFileChange' | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 | | type | 'deviceChange'&#124;<br/>'albumChange'&#124;<br/>'imageChange'&#124;<br/>'audioChange'&#124;<br/>'videoChange'&#124;<br/>'fileChange'&#124;<br/>'remoteFileChange' | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更。 |
| callback | Callback&lt;void&gt; | 是 | 回调返回空 | | callback | Callback&lt;void&gt; | 是 | callbac返回空。 |
**示例：** **示例：**
```js ```js
media.on('imageChange', () => { media.on('imageChange', () => {
// image file had changed, do something // image file had changed, do something.
}) });
``` ```
### off<sup>8+</sup> ### off<sup>8+</sup>
off(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange'&#124;'videoChange'&#124;'fileChange'&#124;'remoteFileChange', callback?: Callback&lt;void&gt;): void off(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange'&#124;'videoChange'&#124;'fileChange'&#124;'remoteFileChange', callback?: Callback&lt;void&gt;): void
...@@ -245,15 +248,15 @@ off(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange ...@@ -245,15 +248,15 @@ off(type: 'deviceChange'&#124;'albumChange'&#124;'imageChange'&#124;'audioChange
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- | | -------- | -------------------- | ---- | ---------------------------------------- |
| type | 'deviceChange'&#124;<br/>'albumChange'&#124;<br/>'imageChange'&#124;<br/>'audioChange'&#124;<br/>'videoChange'&#124;<br/>'fileChange'&#124;<br/>'remoteFileChange' | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更 | | type | 'deviceChange'&#124;<br/>'albumChange'&#124;<br/>'imageChange'&#124;<br/>'audioChange'&#124;<br/>'videoChange'&#124;<br/>'fileChange'&#124;<br/>'remoteFileChange' | 是 | 媒体类型 <br/>'deviceChange'：&nbsp;注册设备变更 <br/>'albumChange'：&nbsp;相册变更<br/>'imageChange'：&nbsp;图片文件变更<br/>'audioChange'： &nbsp;音频文件变更<br/>'videoChange'： &nbsp;视频文件变更<br/>'fileChange'： &nbsp;文件变更<br/>'remoteFileChange'：&nbsp;注册设备上文件变更。 |
| callback | Callback&lt;void&gt; | 否 | 回调返回空 | | callback | Callback&lt;void&gt; | 否 | callback返回空。 |
**示例：** **示例：**
```js ```js
media.off('imageChange', () => { media.off('imageChange', () => {
// stop listening successfully // stop listening successfully.
}) });
``` ```
### createAsset<sup>8+</sup> ### createAsset<sup>8+</sup>
...@@ -270,26 +273,26 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal ...@@ -270,26 +273,26 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | | ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ |
| mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 | | mediaType | [MediaType](#mediatype8) | 是 | 媒体类型。 |
| displayName | string | 是 | 展示文件名 | | displayName | string | 是 | 展示文件名。 |
| relativePath | string | 是 | 文件保存路径，可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 | | relativePath | string | 是 | 文件保存路径，可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径。 |
| callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步获取媒体数据FileAsset之后的回调 | | callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | callback返回创建的媒体资源FileAsset对象。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
// 使用Callback方式创建Image类型文件 // 使用Callback方式创建Image类型文件。
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
const path = await media.getPublicDirectory(DIR_IMAGE); const path = await media.getPublicDirectory(DIR_IMAGE);
media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (error, fileAsset) => { media.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (error, fileAsset) => {
if (fileAsset != undefined) { if (fileAsset != undefined) {
console.info('createAsset successfully, message'); console.info('createAsset successfully, message');
} else { } else {
console.error('createAsset failed with error: ' + error); console.error('createAsset failed with error: ' + error);
} }
}); });
} }
``` ```
...@@ -307,29 +310,29 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr ...@@ -307,29 +310,29 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | ------------------------------------------------------------ | | ------------ | ------------------------ | ---- | ------------------------------------------------------------ |
| mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 | | mediaType | [MediaType](#mediatype8) | 是 | 媒体类型。 |
| displayName | string | 是 | 展示文件名 | | displayName | string | 是 | 展示文件名。 |
| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | | relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path。 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | ----------------- | | ------------------------ | ----------------- |
| [FileAsset](#fileasset7) | 媒体数据FileAsset | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise对象，返回创建媒体数据的FileAsset。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
// 使用Promise方式创建Image类型文件 // 使用Promise方式创建Image类型文件。
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
const path = await media.getPublicDirectory(DIR_IMAGE); const path = await media.getPublicDirectory(DIR_IMAGE);
media.createAsset(mediaType, 'imagePromise.jpg', path + 'myPicture/').then((fileAsset) => { media.createAsset(mediaType, 'imagePromise.jpg', path + 'myPicture/').then((fileAsset) => {
console.info('createAsset successfully, message = ' + JSON.stringify(fileAsset)); console.info('createAsset successfully, message = ' + JSON.stringify(fileAsset));
}).catch((error) => { }).catch((error) => {
console.error('createAsset failed with error: ' + error); console.error('createAsset failed with error: ' + error);
}); });
} }
``` ```
...@@ -337,7 +340,7 @@ async function example() { ...@@ -337,7 +340,7 @@ async function example() {
deleteAsset(uri: string): Promise\<void> deleteAsset(uri: string): Promise\<void>
删除媒体文件资源 删除媒体文件资源。
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
...@@ -349,42 +352,44 @@ deleteAsset(uri: string): Promise\<void> ...@@ -349,42 +352,44 @@ deleteAsset(uri: string): Promise\<void>
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------- | | -------- | ---------------------------- | ---- | --------------- |
| uri | string | 是 | 需要删除的媒体文件资源的uri | | uri | string | 是 | 需要删除的媒体文件资源的uri。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Promise&lt;void&gt; | Promise回调返回删除的结果。 | | Promise&lt;void&gt; | Promise对象，返回删除的结果。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let fileType = mediaLibrary.MediaType.FILE; let fileType = mediaLibrary.MediaType.FILE;
let option = { let option = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [fileType.toString()], selectionArgs: [fileType.toString()],
}; };
const fetchFileResult = await media.getFileAssets(option); const fetchFileResult = await media.getFileAssets(option);
let asset = await fetchFileResult.getFirstObject(); let asset = await fetchFileResult.getFirstObject();
if (asset == undefined) { if (asset == undefined) {
console.error('asset not exist'); console.error('asset not exist');
return; return;
} }
media.deleteAsset(asset.uri).then(() => { media.deleteAsset(asset.uri).then(() => {
console.info('deleteAsset successfully'); console.info('deleteAsset successfully');
}).catch((error) => { }).catch((error) => {
console.error('deleteAsset failed with error: ' + error); console.error('deleteAsset failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
### deleteAsset<sup>8+</sup> ### deleteAsset<sup>8+</sup>
deleteAsset(uri: string, callback: AsyncCallback\<void>): void deleteAsset(uri: string, callback: AsyncCallback\<void>): void
删除媒体文件资源 删除媒体文件资源。
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
...@@ -397,32 +402,32 @@ deleteAsset(uri: string, callback: AsyncCallback\<void>): void ...@@ -397,32 +402,32 @@ deleteAsset(uri: string, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------- | | -------- | ---------------------------- | ---- | --------------- |
| uri | string | 是 | 需要删除的媒体文件资源的uri。 | | uri | string | 是 | 需要删除的媒体文件资源的uri。 |
|callback |AsyncCallback\<void>| 是 |回调函数，用于获取删除的结果。| |callback |AsyncCallback\<void>| 是 |callback返回空。|
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let fileType = mediaLibrary.MediaType.FILE; let fileType = mediaLibrary.MediaType.FILE;
let option = { let option = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [fileType.toString()], selectionArgs: [fileType.toString()],
}; };
const fetchFileResult = await media.getFileAssets(option); const fetchFileResult = await media.getFileAssets(option);
let asset = await fetchFileResult.getFirstObject(); let asset = await fetchFileResult.getFirstObject();
if (asset == undefined) { if (asset == undefined) {
console.error('asset not exist'); console.error('asset not exist');
return; return;
}
media.deleteAsset(asset.uri, (error) => {
if (error != undefined) {
console.error('deleteAsset failed with error: ' + error);
} else {
console.info('deleteAsset successfully');
} }
media.deleteAsset(asset.uri, (error) => { });
if (error != undefined) { fetchFileResult.close();
console.error('deleteAsset failed with error: ' + error);
} else {
console.info('deleteAsset successfully');
}
});
fetchFileResult.close();
} }
``` ```
...@@ -438,19 +443,19 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;): ...@@ -438,19 +443,19 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------- | ---- | ------------------------- | | -------- | -------------------------------- | ---- | ------------------------- |
| type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 | | type | [DirectoryType](#directorytype8) | 是 | 公共目录类型。 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback 返回公共目录路径 | | callback | AsyncCallback&lt;string&gt; | 是 | callback返回公共目录路径。 |
**示例：** **示例：**
```js ```js
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA, (error, dicResult) => { media.getPublicDirectory(DIR_CAMERA, (error, dicResult) => {
if (dicResult == 'Camera/') { if (dicResult == 'Camera/') {
console.info('getPublicDirectory DIR_CAMERA successfully'); console.info('getPublicDirectory DIR_CAMERA successfully');
} else { } else {
console.error('getPublicDirectory DIR_CAMERA failed with error: ' + error); console.error('getPublicDirectory DIR_CAMERA failed with error: ' + error);
} }
}); });
``` ```
...@@ -466,28 +471,28 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt; ...@@ -466,28 +471,28 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------- | ---- | ------------ | | ------ | -------------------------------- | ---- | ------------ |
| type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 | | type | [DirectoryType](#directorytype8) | 是 | 公共目录类型。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------- | ---------------- | | ---------------- | ---------------- |
| Promise\<string> | 返回公共目录路径 | | Promise\<string> | Promise对象，返回公共目录路径。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA;
media.getPublicDirectory(DIR_CAMERA).then((dicResult) => { media.getPublicDirectory(DIR_CAMERA).then((dicResult) => {
if (dicResult == 'Camera/') { if (dicResult == 'Camera/') {
console.info('getPublicDirectory DIR_CAMERA successfully'); console.info('getPublicDirectory DIR_CAMERA successfully');
} else { } else {
console.error('getPublicDirectory DIR_CAMERA failed'); console.error('getPublicDirectory DIR_CAMERA failed');
} }
}).catch((error) => { }).catch((error) => {
console.error('getPublicDirectory failed with error: ' + error); console.error('getPublicDirectory failed with error: ' + error);
}); });
} }
``` ```
...@@ -501,12 +506,12 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback&lt;Array&lt;Album& ...@@ -501,12 +506,12 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback&lt;Array&lt;Album&
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------------- | ---- | --------------------------- | | -------- | -------------------------------------------- | ---- | --------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册检索条件。 |
| callback | AsyncCallback&lt;Array<[Album](#album7)>&gt; | 是 | 异步获取Album列表之后的回调 | | callback | AsyncCallback&lt;Array<[Album](#album7)>&gt; | 是 | callback返回获取的Album结果集。 |
**示例：** **示例：**
...@@ -523,7 +528,7 @@ async function example() { ...@@ -523,7 +528,7 @@ async function example() {
} else { } else {
console.error('getAlbums failed with error: ' + error); console.error('getAlbums failed with error: ' + error);
} }
}) });
} }
``` ```
...@@ -541,19 +546,19 @@ getAlbums(options: MediaFetchOptions): Promise&lt;Array&lt;Album&gt;&gt; ...@@ -541,19 +546,19 @@ getAlbums(options: MediaFetchOptions): Promise&lt;Array&lt;Album&gt;&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------------ | | ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | ------------- | | -------------------------------- | ------------- |
| Promise<Array<[Album](#album7)>> | 返回Album列表 | | Promise<Array<[Album](#album7)>> | Promise对象，返回获取的Album结果集。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
// 获取相册需要先预置相册和资源，示例代码为预置的新建相册1。 // 获取相册需要先预置相册和资源，示例代码为预置的新建相册1。
let AlbumNoArgsfetchOp = { let AlbumNoArgsfetchOp = {
selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?', selections: mediaLibrary.FileKey.ALBUM_NAME + '= ?',
selectionArgs: ['新建相册1'], selectionArgs: ['新建相册1'],
...@@ -579,13 +584,13 @@ release(callback: AsyncCallback&lt;void&gt;): void ...@@ -579,13 +584,13 @@ release(callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 无返回值 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
media.release(() => { media.release(() => {
// do something // do something.
}); });
``` ```
...@@ -602,12 +607,12 @@ release(): Promise&lt;void&gt; ...@@ -602,12 +607,12 @@ release(): Promise&lt;void&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Promise&lt;void&gt; | Promise实例，用于获取异步返回结果 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例：** **示例：**
```js ```js
media.release() media.release();
``` ```
### storeMediaAsset ### storeMediaAsset
...@@ -625,27 +630,26 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;) ...@@ -625,27 +630,26 @@ storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;)
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | ----------------------- | | -------- | ------------------------------------- | ---- | ----------------------- |
| option | [MediaAssetOption](#mediaassetoption) | 是 | 媒体资源选项。 | | option | [MediaAssetOption](#mediaassetoption) | 是 | 媒体资源选项。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 媒体资源保存回调，返回保存成功后得到的URI。 | | callback | AsyncCallback&lt;string&gt; | 是 | callback返回保存媒体资源成功后得到的URI。 |
**示例：** **示例：**
```js ```js
let option = { let option = {
src : '/data/storage/el2/base/haps/entry/image.png', src : '/data/storage/el2/base/haps/entry/image.png',
mimeType : 'image/*', mimeType : 'image/*',
relativePath : 'Pictures/' relativePath : 'Pictures/'
}; };
mediaLibrary.getMediaLibrary().storeMediaAsset(option, (error, value) => { mediaLibrary.getMediaLibrary().storeMediaAsset(option, (error, value) => {
if (error) { if (error) {
console.error('storeMediaAsset failed with error: ' + error); console.error('storeMediaAsset failed with error: ' + error);
return; return;
} }
console.info('Media resources stored. '); console.info('Media resources stored. ');
// Obtain the URI that stores media resources. // Obtain the URI that stores media resources.
}); });
``` ```
### storeMediaAsset ### storeMediaAsset
storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt; storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
...@@ -666,32 +670,31 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt; ...@@ -666,32 +670,31 @@ storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------- | | --------------------- | ---------------------------- |
| Promise&lt;string&gt; | Promise实例，用于异步获取保存成功后得到的URI。 | | Promise&lt;string&gt; | Promise对象，返回保存媒体资源成功后得到的URI。 |
**示例：** **示例：**
```js ```js
let option = { let option = {
src : '/data/storage/el2/base/haps/entry/image.png', src : '/data/storage/el2/base/haps/entry/image.png',
mimeType : 'image/*', mimeType : 'image/*',
relativePath : 'Pictures/' relativePath : 'Pictures/'
}; };
mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => { mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {
console.info('Media resources stored.'); console.info('Media resources stored.');
// Obtain the URI that stores media resources. // Obtain the URI that stores media resources.
}).catch((error) => { }).catch((error) => {
console.error('storeMediaAsset failed with error: ' + error); console.error('storeMediaAsset failed with error: ' + error);
}); });
``` ```
### startImagePreview ### startImagePreview
startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCallback&lt;void&gt;): void startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCallback&lt;void&gt;): void
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。 启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用callback方式进行异步回调。
> **说明**： > **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。 > 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。 > 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
...@@ -703,32 +706,31 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal ...@@ -703,32 +706,31 @@ startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCal
| -------- | ------------------------- | ---- | ---------------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| images | Array&lt;string&gt; | 是 | 预览的图片URI（'https://'，'datashare://'）列表。 | | images | Array&lt;string&gt; | 是 | 预览的图片URI（'https://'，'datashare://'）列表。 |
| index | number | 是 | 开始显示的图片序号。 | | index | number | 是 | 开始显示的图片序号。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 图片预览回调，失败时返回错误信息。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
let images = [ let images = [
'file://media/xxxx/2', 'file://media/xxxx/2',
'file://media/xxxx/3' 'file://media/xxxx/3'
]; ];
/* 网络图片使用方式 /* 网络图片使用方式。
let images = [ let images = [
'https://media.xxxx.com/image1.jpg', 'https://media.xxxx.com/image1.jpg',
'https://media.xxxx.com/image2.jpg' 'https://media.xxxx.com/image2.jpg'
]; ];
*/ */
let index = 1; let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index, (error) => { mediaLibrary.getMediaLibrary().startImagePreview(images, index, (error) => {
if (error) { if (error) {
console.error('startImagePreview failed with error: ' + error); console.error('startImagePreview failed with error: ' + error);
return; return;
} }
console.info('Succeeded in previewing the images.'); console.info('Succeeded in previewing the images.');
}); });
``` ```
### startImagePreview ### startImagePreview
startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void
...@@ -746,38 +748,37 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g ...@@ -746,38 +748,37 @@ startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&g
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------------------------------------- | | -------- | ------------------------- | ---- | ---------------------------------------- |
| images | Array&lt;string&gt; | 是 | 预览的图片URI（'https://'，'datashare://'）列表。 | | images | Array&lt;string&gt; | 是 | 预览的图片URI（'https://'，'datashare://'）列表。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 图片预览回调，失败时返回错误信息。 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
let images = [ let images = [
'file://media/xxxx/2', 'file://media/xxxx/2',
'file://media/xxxx/3' 'file://media/xxxx/3'
]; ];
/* 网络图片使用方式 /* 网络图片使用方式。
let images = [ let images = [
'https://media.xxxx.com/image1.jpg', 'https://media.xxxx.com/image1.jpg',
'https://media.xxxx.com/image2.jpg' 'https://media.xxxx.com/image2.jpg'
]; ];
*/ */
mediaLibrary.getMediaLibrary().startImagePreview(images, (error) => { mediaLibrary.getMediaLibrary().startImagePreview(images, (error) => {
if (error) { if (error) {
console.error('startImagePreview failed with error: ' + error); console.error('startImagePreview failed with error: ' + error);
return; return;
} }
console.info('Succeeded in previewing the images.'); console.info('Succeeded in previewing the images.');
}); });
``` ```
### startImagePreview ### startImagePreview
startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&gt; startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&gt;
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用Promise方式进行异步回调。 启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片（datashare://），也可以预览列表中的所有网络图片（https://）。使用Promise方式进行异步回调。
> **说明**： > **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。 > 此接口为API Version 6开始支持，只支持FA模型使用。
> 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。 > 建议使用[Image组件](../arkui-ts/ts-basic-components-image.md)替代。<br/>Image组件，可用于本地图片和网络图片的渲染展示。
...@@ -794,37 +795,36 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void& ...@@ -794,37 +795,36 @@ startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------------------------- | | ------------------- | ------------------------------- |
| Promise&lt;void&gt; | Promise实例，用于异步获取预览结果，失败时返回错误信息。 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例：** **示例：**
```js ```js
let images = [ let images = [
'file://media/xxxx/2', 'file://media/xxxx/2',
'file://media/xxxx/3' 'file://media/xxxx/3'
]; ];
/* 网络图片使用方式 /* 网络图片使用方式。
let images = [ let images = [
'https://media.xxxx.com/image1.jpg', 'https://media.xxxx.com/image1.jpg',
'https://media.xxxx.com/image2.jpg' 'https://media.xxxx.com/image2.jpg'
]; ];
*/ */
let index = 1; let index = 1;
mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => { mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
console.info('Succeeded in previewing the images.'); console.info('Succeeded in previewing the images.');
}).catch((error) => { }).catch((error) => {
console.error('startImagePreview failed with error: ' + error); console.error('startImagePreview failed with error: ' + error);
}); });
``` ```
### startMediaSelect ### startMediaSelect
startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用callback形式返回结果。 启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用callback形式返回结果。
> **说明**： > **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。 > 此接口为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)。 > 建议使用系统应用图库替代。图库是系统内置的可视资源访问应用，提供图片和视频的管理、浏览等功能，使用方法请参考[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)。
...@@ -835,33 +835,32 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt; ...@@ -835,33 +835,32 @@ startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------------------ | | -------- | ---------------------------------------- | ---- | ------------------------------------ |
| option | [MediaSelectOption](#mediaselectoption) | 是 | 媒体选择选项。 | | option | [MediaSelectOption](#mediaselectoption) | 是 | 媒体选择选项。 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 媒体选择回调，返回选择的媒体URI（datashare://）列表。 | | callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | callback返回选择的媒体URI列表。 |
**示例：** **示例：**
```js ```js
let option : mediaLibrary.MediaSelectOption = { let option : mediaLibrary.MediaSelectOption = {
type : 'media', type : 'media',
count : 2 count : 2
}; };
mediaLibrary.getMediaLibrary().startMediaSelect(option, (error, value) => { mediaLibrary.getMediaLibrary().startMediaSelect(option, (error, value) => {
if (error) { if (error) {
console.error('startMediaSelect failed with error: ' + error); console.error('startMediaSelect failed with error: ' + error);
return; return;
} }
console.info('Media resources selected.'); console.info('Media resources selected.');
// Obtain the media selection value. // Obtain the media selection value.
}); });
``` ```
### startMediaSelect ### startMediaSelect
startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt; startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用Promise形式返回结果。 启动媒体选择界面，以异步方法获取选择的媒体URI列表，使用Promise形式返回结果。
> **说明**： > **说明**：
> 此接口为API Version 6开始支持，只支持FA模型使用。 > 此接口为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)。 > 建议使用系统应用图库替代。图库是系统内置的可视资源访问应用，提供图片和视频的管理、浏览等功能，使用方法请参考[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)。
...@@ -877,28 +876,28 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt; ...@@ -877,28 +876,28 @@ startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ---------------------------------------- | | ---------------------------------- | ---------------------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise实例，用于异步获取选择的媒体URI（datashare://）列表。 | | Promise&lt;Array&lt;string&gt;&gt; | Promise对象，返回选择的媒体URI列表。 |
**示例：** **示例：**
```js ```js
let option : mediaLibrary.MediaSelectOption = { let option : mediaLibrary.MediaSelectOption = {
type : 'media', type : 'media',
count : 2 count : 2
}; };
mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
console.info('Media resources selected.'); console.info('Media resources selected.');
// Obtain the media selection value. // Obtain the media selection value.
}).catch((error) => { }).catch((error) => {
console.error('startMediaSelect failed with error: ' + error); console.error('startMediaSelect failed with error: ' + error);
}); });
``` ```
### getActivePeers<sup>8+</sup> ### getActivePeers<sup>8+</sup>
getActivePeers(): Promise\<Array\<PeerInfo>>; getActivePeers(): Promise\<Array\<PeerInfo>>;
获取在线对端设备的信息，使用Promise方式返回异步结果 获取在线对端设备的信息，使用Promise方式返回异步结果。
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
...@@ -910,21 +909,21 @@ getActivePeers(): Promise\<Array\<PeerInfo>>; ...@@ -910,21 +909,21 @@ getActivePeers(): Promise\<Array\<PeerInfo>>;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Promise\<Array\<[PeerInfo](#peerinfo8)>> | 返回获取的所有在线对端设备的PeerInfo | | Promise\<Array\<[PeerInfo](#peerinfo8)>> | Promise对象，返回获取的所有在线对端设备的PeerInfo。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
media.getActivePeers().then((devicesInfo) => { media.getActivePeers().then((devicesInfo) => {
if (devicesInfo != undefined) { if (devicesInfo != undefined) {
console.info('get distributed info ' + JSON.stringify(devicesInfo)); console.info('get distributed info ' + JSON.stringify(devicesInfo));
} else { } else {
console.info('get distributed info is undefined!'); console.info('get distributed info is undefined!');
} }
}).catch((error) => { }).catch((error) => {
console.error('get distributed info failed with error: ' + error); console.error('get distributed info failed with error: ' + error);
}); });
} }
``` ```
...@@ -944,28 +943,27 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void; ...@@ -944,28 +943,27 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| callback: AsyncCallback\<Array\<[PeerInfo](#peerinfo8)>> | 返回获取的所有在线对端设备的PeerInfo | | callback: AsyncCallback\<Array\<[PeerInfo](#peerinfo8)>> | callback返回获取的所有在线对端设备的PeerInfo对象。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
media.getActivePeers((error, devicesInfo) => { media.getActivePeers((error, devicesInfo) => {
if (devicesInfo != undefined) { if (devicesInfo != undefined) {
console.info('get distributed info ' + JSON.stringify(devicesInfo)); console.info('get distributed info ' + JSON.stringify(devicesInfo));
} else { } else {
console.error('get distributed failed with error: ' + error); console.error('get distributed failed with error: ' + error);
} }
}); });
} }
``` ```
### getAllPeers<sup>8+</sup> ### getAllPeers<sup>8+</sup>
getAllPeers(): Promise\<Array\<PeerInfo>>; getAllPeers(): Promise\<Array\<PeerInfo>>;
获取所有对端设备的信息，使用Promise方式返回异步结果 获取所有对端设备的信息，使用Promise方式返回异步结果。
**系统接口**：此接口为系统接口。 **系统接口**：此接口为系统接口。
...@@ -977,21 +975,21 @@ getAllPeers(): Promise\<Array\<PeerInfo>>; ...@@ -977,21 +975,21 @@ getAllPeers(): Promise\<Array\<PeerInfo>>;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Promise\<Array\<[PeerInfo](#peerinfo8)>> | 返回获取的所有对端设备的PeerInfo | | Promise\<Array\<[PeerInfo](#peerinfo8)>> | Promise对象，返回获取的所有对端设备的PeerInfo。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
media.getAllPeers().then((devicesInfo) => { media.getAllPeers().then((devicesInfo) => {
if (devicesInfo != undefined) { if (devicesInfo != undefined) {
console.info('get distributed info ' + JSON.stringify(devicesInfo)); console.info('get distributed info ' + JSON.stringify(devicesInfo));
} else { } else {
console.info('get distributed info is undefined!'); console.info('get distributed info is undefined!');
} }
}).catch((error) => { }).catch((error) => {
console.error('get distributed info failed with error: ' + error); console.error('get distributed info failed with error: ' + error);
}); });
} }
``` ```
...@@ -1011,19 +1009,19 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void; ...@@ -1011,19 +1009,19 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| callback: AsyncCallback\<Array\<[PeerInfo](#peerinfo8)>> | 返回获取的所有对端设备的PeerInfo | | callback: AsyncCallback\<Array\<[PeerInfo](#peerinfo8)>> | callback返回获取的所有对端设备的PeerInfo对象。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
media.getAllPeers((error, devicesInfo) => { media.getAllPeers((error, devicesInfo) => {
if (devicesInfo != undefined) { if (devicesInfo != undefined) {
console.info('get distributed info ' + JSON.stringify(devicesInfo)); console.info('get distributed info ' + JSON.stringify(devicesInfo));
} else { } else {
console.error('get distributed failed with error: ' + error); console.error('get distributed failed with error: ' + error);
} }
}); });
} }
``` ```
...@@ -1032,6 +1030,7 @@ async function example() { ...@@ -1032,6 +1030,7 @@ async function example() {
提供封装文件属性的方法。 提供封装文件属性的方法。
> **说明：** > **说明：**
>
> 1. title字段默认为去掉后缀的文件名，音频和视频文件会尝试解析文件内容，部分设备写入后在触发扫描时会被还原。 > 1. title字段默认为去掉后缀的文件名，音频和视频文件会尝试解析文件内容，部分设备写入后在触发扫描时会被还原。
> 2. orientation字段部分设备可能不支持修改，建议使用image组件的[ModifyImageProperty](js-apis-image.md#modifyimageproperty9)接口。 > 2. orientation字段部分设备可能不支持修改，建议使用image组件的[ModifyImageProperty](js-apis-image.md#modifyimageproperty9)接口。
...@@ -1041,28 +1040,27 @@ async function example() { ...@@ -1041,28 +1040,27 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ | | ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
| id | number | 是 | 否 | 文件资源编号 | | id | number | 是 | 否 | 文件资源编号。 |
| uri | string | 是 | 否 | 文件资源uri（如：file://media/image/2) | | uri | string | 是 | 否 | 文件资源uri（如：file://media/image/2)。 |
| mimeType | string | 是 | 否 | 文件扩展属性 | | mimeType | string | 是 | 否 | 文件扩展属性。 |
| mediaType<sup>8+</sup> | [MediaType](#mediatype8) | 是 | 否 | 媒体类型 | | mediaType<sup>8+</sup> | [MediaType](#mediatype8) | 是 | 否 | 媒体类型。 |
| displayName | string | 是 | 是 | 显示文件名，包含后缀名 | | displayName | string | 是 | 是 | 显示文件名，包含后缀名。 |
| title | string | 是 | 是 | 文件标题 | | title | string | 是 | 是 | 文件标题。 |
| relativePath<sup>8+</sup> | string | 是 | 是 | 相对公共目录路径 | | relativePath<sup>8+</sup> | string | 是 | 是 | 相对公共目录路径。 |
| parent<sup>8+</sup> | number | 是 | 否 | 父目录id | | parent<sup>8+</sup> | number | 是 | 否 | 父目录id。 |
| size | number | 是 | 否 | 文件大小（单位：字节） | | size | number | 是 | 否 | 文件大小（单位：字节）。 |
| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | | dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值）。 |
| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新）| | dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新）。|
| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | | dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值）。 |
| artist<sup>8+</sup> | string | 是 | 否 | 作者 | | artist<sup>8+</sup> | string | 是 | 否 | 作者。 |
| audioAlbum<sup>8+</sup> | string | 是 | 否 | 专辑 | | audioAlbum<sup>8+</sup> | string | 是 | 否 | 专辑。 |
| width | number | 是 | 否 | 图片宽度（单位：像素） | | width | number | 是 | 否 | 图片宽度（单位：像素）。 |
| height | number | 是 | 否 | 图片高度（单位：像素） | | height | number | 是 | 否 | 图片高度（单位：像素）。 |
| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | | orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度）。 |
| duration<sup>8+</sup> | number | 是 | 否 | 持续时间（单位：毫秒） | | duration<sup>8+</sup> | number | 是 | 否 | 持续时间（单位：毫秒）。 |
| albumId | number | 是 | 否 | 文件所归属的相册编号 | | albumId | number | 是 | 否 | 文件所归属的相册编号。 |
| albumUri<sup>8+</sup> | string | 是 | 否 | 文件所归属相册uri | | albumUri<sup>8+</sup> | string | 是 | 否 | 文件所归属相册uri。 |
| albumName | string | 是 | 否 | 文件所归属相册名称 | | albumName | string | 是 | 否 | 文件所归属相册名称。 |
### isDirectory<sup>8+</sup> ### isDirectory<sup>8+</sup>
...@@ -1078,29 +1076,29 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1078,29 +1076,29 @@ isDirectory(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ------------------- | | -------- | ---------------------------- | ---- | ------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 当前FileAsset是否是目录的回调 | | callback | AsyncCallback&lt;boolean&gt; | 是 | callback返回boolean值，值为true则是目录，值为false则非目录。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isDirectory((error, isDirectory) => { asset.isDirectory((error, isDirectory) => {
if (error) { if (error) {
console.error('isDirectory failed with error: ' + error); console.error('isDirectory failed with error: ' + error);
} else { } else {
console.info('isDirectory result:' + isDirectory); console.info('isDirectory result:' + isDirectory);
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1118,27 +1116,27 @@ isDirectory():Promise&lt;boolean&gt; ...@@ -1118,27 +1116,27 @@ isDirectory():Promise&lt;boolean&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ---------------------------- | | ---------------------- | ---------------------------- |
| Promise&lt;boolean&gt; | Promise实例，返回当前FileAsset是否是目录 | | Promise&lt;boolean&gt; | Promise对象，返回boolean值，值为true则是目录，值为false则非目录。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isDirectory().then((isDirectory) => { asset.isDirectory().then((isDirectory) => {
console.info('isDirectory result:' + isDirectory); console.info('isDirectory result:' + isDirectory);
}).catch((error) => { }).catch((error) => {
console.error('isDirectory failed with error: ' + error); console.error('isDirectory failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1156,26 +1154,26 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void ...@@ -1156,26 +1154,26 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----- | | -------- | ------------------------- | ---- | ----- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.title = 'newtitle'; asset.title = 'newtitle';
asset.commitModify(() => { asset.commitModify(() => {
console.info('commitModify successfully'); console.info('commitModify successfully');
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1193,24 +1191,24 @@ commitModify(): Promise&lt;void&gt; ...@@ -1193,24 +1191,24 @@ commitModify(): Promise&lt;void&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---------- | | ------------------- | ---------- |
| Promise&lt;void&gt; | Promise返回空 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.title = 'newtitle'; asset.title = 'newtitle';
await asset.commitModify(); await asset.commitModify();
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1226,28 +1224,28 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -1226,28 +1224,28 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ----------------------------------- | | -------- | --------------------------- | ---- | ----------------------------------- |
| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） | | mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写）。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调返回文件描述符 | | callback | AsyncCallback&lt;number&gt; | 是 | callback返回文件描述符。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
const path = await media.getPublicDirectory(DIR_IMAGE); const path = await media.getPublicDirectory(DIR_IMAGE);
const asset = await media.createAsset(mediaType, 'image00003.jpg', path); const asset = await media.createAsset(mediaType, 'image00003.jpg', path);
asset.open('rw', (error, fd) => { asset.open('rw', (error, fd) => {
if (fd > 0) { if (fd > 0) {
asset.close(fd); asset.close(fd);
} else { } else {
console.error('File Open failed with error: ' + error); console.error('File Open failed with error: ' + error);
} }
}); });
} }
``` ```
...@@ -1267,27 +1265,27 @@ open(mode: string): Promise&lt;number&gt; ...@@ -1267,27 +1265,27 @@ open(mode: string): Promise&lt;number&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----------------------------------- | | ---- | ------ | ---- | ----------------------------------- |
| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） | | mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写）。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------- | | --------------------- | ------------- |
| Promise&lt;number&gt; | Promise返回文件描述符 | | Promise&lt;number&gt; | Promise对象，返回文件描述符。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let mediaType = mediaLibrary.MediaType.IMAGE; let mediaType = mediaLibrary.MediaType.IMAGE;
let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE;
const path = await media.getPublicDirectory(DIR_IMAGE); const path = await media.getPublicDirectory(DIR_IMAGE);
const asset = await media.createAsset(mediaType, 'image00003.jpg', path); const asset = await media.createAsset(mediaType, 'image00003.jpg', path);
asset.open('rw').then((fd) => { asset.open('rw').then((fd) => {
console.info('File open fd: ' + fd); console.info('File open fd: ' + fd);
}).catch((error) => { }).catch((error) => {
console.error('File open failed with error: ' + error); console.error('File open failed with error: ' + error);
}); });
} }
``` ```
...@@ -1305,35 +1303,35 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1305,35 +1303,35 @@ close(fd: number, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ----- | | -------- | ------------------------- | ---- | ----- |
| fd | number | 是 | 文件描述符 | | fd | number | 是 | 文件描述符。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.open('rw').then((fd) => { asset.open('rw').then((fd) => {
console.info('File open fd: ' + fd); console.info('File open fd: ' + fd);
asset.close(fd, (error) => { asset.close(fd, (error) => {
if (error) { if (error) {
console.error('asset.close failed with error: ' + error); console.error('asset.close failed with error: ' + error);
} else { } else {
console.info('asset.close successfully'); console.info('asset.close successfully');
} }
});
}).catch((error) => {
console.error('File open failed with error: ' + error);
}); });
fetchFileResult.close(); }).catch((error) => {
console.error('File open failed with error: ' + error);
});
fetchFileResult.close();
} }
``` ```
...@@ -1351,38 +1349,38 @@ close(fd: number): Promise&lt;void&gt; ...@@ -1351,38 +1349,38 @@ close(fd: number): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ----- | | ---- | ------ | ---- | ----- |
| fd | number | 是 | 文件描述符 | | fd | number | 是 | 文件描述符。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---------- | | ------------------- | ---------- |
| Promise&lt;void&gt; | Promise返回空 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.open('rw').then((fd) => { asset.open('rw').then((fd) => {
console.info('File fd!' + fd); console.info('File fd!' + fd);
asset.close(fd).then(() => { asset.close(fd).then(() => {
console.info('asset.close successfully'); console.info('asset.close successfully');
}).catch((closeErr) => { }).catch((closeErr) => {
console.error('asset.close fail, closeErr: ' + closeErr); console.error('asset.close fail, closeErr: ' + closeErr);
});
}).catch((error) => {
console.error('open File failed with error: ' + error);
}); });
fetchFileResult.close(); }).catch((error) => {
console.error('open File failed with error: ' + error);
});
fetchFileResult.close();
} }
``` ```
...@@ -1400,29 +1398,29 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void ...@@ -1400,29 +1398,29 @@ getThumbnail(callback: AsyncCallback&lt;image.PixelMap&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------- | | -------- | ----------------------------------- | ---- | ---------------- |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回缩略图的PixelMap | | callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | callback返回缩略图的PixelMap。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.getThumbnail((error, pixelmap) => { asset.getThumbnail((error, pixelmap) => {
if (error) { if (error) {
console.error('mediaLibrary getThumbnail failed with error: ' + error); console.error('mediaLibrary getThumbnail failed with error: ' + error);
} else { } else {
console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap)); console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1440,31 +1438,31 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void ...@@ -1440,31 +1438,31 @@ getThumbnail(size: Size, callback: AsyncCallback&lt;image.PixelMap&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ---------------- | | -------- | ----------------------------------- | ---- | ---------------- |
| size | [Size](#size8) | 是 | 缩略图尺寸 | | size | [Size](#size8) | 是 | 缩略图尺寸。 |
| callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | 回调返回缩略图的PixelMap | | callback | AsyncCallback&lt;image.PixelMap&gt; | 是 | callback返回缩略图的PixelMap。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let size = { width: 720, height: 720 }; let size = { width: 720, height: 720 };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.getThumbnail(size, (error, pixelmap) => { asset.getThumbnail(size, (error, pixelmap) => {
if (error) { if (error) {
console.error('mediaLibrary getThumbnail failed with error: ' + error); console.error('mediaLibrary getThumbnail failed with error: ' + error);
} else { } else {
console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap)); console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1482,34 +1480,34 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt; ...@@ -1482,34 +1480,34 @@ getThumbnail(size?: Size): Promise&lt;image.PixelMap&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | -------------- | ---- | ----- | | ---- | -------------- | ---- | ----- |
| size | [Size](#size8) | 否 | 缩略图尺寸 | | size | [Size](#size8) | 否 | 缩略图尺寸。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ----------------------------- | --------------------- | | ----------------------------- | --------------------- |
| Promise&lt;image.PixelMap&gt; | Promise返回缩略图的PixelMap | | Promise&lt;image.PixelMap&gt; | Promise对象，返回缩略图的PixelMap。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let size = { width: 720, height: 720 }; let size = { width: 720, height: 720 };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.getThumbnail(size).then((pixelmap) => { asset.getThumbnail(size).then((pixelmap) => {
console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap)); console.info('mediaLibrary getThumbnail Successful, pixelmap ' + JSON.stringify(pixelmap));
}).catch((error) => { }).catch((error) => {
console.error('mediaLibrary getThumbnail failed with error: ' + error); console.error('mediaLibrary getThumbnail failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1527,30 +1525,30 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1527,30 +1525,30 @@ favorite(isFavorite: boolean, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------- | ---- | ---------------------------------- | | ---------- | ------------------------- | ---- | ---------------------------------- |
| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 | | isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.favorite(true,(error) => { asset.favorite(true,(error) => {
if (error) { if (error) {
console.error('mediaLibrary favorite failed with error: ' + error); console.error('mediaLibrary favorite failed with error: ' + error);
} else { } else {
console.info('mediaLibrary favorite Successful'); console.info('mediaLibrary favorite Successful');
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1568,33 +1566,33 @@ favorite(isFavorite: boolean): Promise&lt;void&gt; ...@@ -1568,33 +1566,33 @@ favorite(isFavorite: boolean): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------- | ---- | ---------------------------------- | | ---------- | ------- | ---- | ---------------------------------- |
| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 | | isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---------- | | ------------------- | ---------- |
| Promise&lt;void&gt; | Promise返回空 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.favorite(true).then(() => { asset.favorite(true).then(() => {
console.info('mediaLibrary favorite Successful'); console.info('mediaLibrary favorite Successful');
}).catch((error) => { }).catch((error) => {
console.error('mediaLibrary favorite failed with error: ' + error); console.error('mediaLibrary favorite failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1612,29 +1610,29 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1612,29 +1610,29 @@ isFavorite(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ----------- | | -------- | ---------------------------- | ---- | ----------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调表示是否为收藏文件 | | callback | AsyncCallback&lt;boolean&gt; | 是 | callback返回boolean值，值为true则为已收藏，值为false则为未收藏。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isFavorite((error, isFavorite) => { asset.isFavorite((error, isFavorite) => {
if (error) { if (error) {
console.error('mediaLibrary favoriisFavoritete failed with error: ' + error); console.error('mediaLibrary favoriisFavoritete failed with error: ' + error);
} else { } else {
console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite); console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite);
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1652,27 +1650,27 @@ isFavorite():Promise&lt;boolean&gt; ...@@ -1652,27 +1650,27 @@ isFavorite():Promise&lt;boolean&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | ------------------ | | ---------------------- | ------------------ |
| Promise&lt;boolean&gt; | Promise回调表示是否是收藏文件 | | Promise&lt;boolean&gt; | Promise对象，返回boolean值，值为true则为已收藏，值为false则为未收藏。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isFavorite().then((isFavorite) => { asset.isFavorite().then((isFavorite) => {
console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite); console.info('mediaLibrary isFavorite Successful, isFavorite result: ' + isFavorite);
}).catch((error) => { }).catch((error) => {
console.error('mediaLibrary favoriisFavoritete failed with error: ' + error); console.error('mediaLibrary favoriisFavoritete failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1692,30 +1690,30 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void ...@@ -1692,30 +1690,30 @@ trash(isTrash: boolean, callback: AsyncCallback&lt;void&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | --------- | | -------- | ------------------------- | ---- | --------- |
| isTrash | boolean | 是 | 是否设置为垃圾文件 | | isTrash | boolean | 是 | 是否设置为垃圾文件。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.trash(true, (error) => { asset.trash(true, (error) => {
if (error) { if (error) {
console.error('mediaLibrary trash failed with error: ' + error); console.error('mediaLibrary trash failed with error: ' + error);
} else { } else {
console.info('mediaLibrary trash Successful'); console.info('mediaLibrary trash Successful');
} }
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1735,33 +1733,33 @@ trash(isTrash: boolean): Promise&lt;void&gt; ...@@ -1735,33 +1733,33 @@ trash(isTrash: boolean): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | --------- | | ------- | ------- | ---- | --------- |
| isTrash | boolean | 是 | 是否设置为垃圾文件 | | isTrash | boolean | 是 | 是否设置为垃圾文件。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---------- | | ------------------- | ---------- |
| Promise&lt;void&gt; | Promise返回空 | | Promise&lt;void&gt; | Promise对象，返回空 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.trash(true).then(() => { asset.trash(true).then(() => {
console.info('trash successfully'); console.info('trash successfully');
}).catch((error) => { }).catch((error) => {
console.error('trash failed with error: ' + error); console.error('trash failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1779,29 +1777,29 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void ...@@ -1779,29 +1777,29 @@ isTrash(callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | --------------- | | -------- | ---------------------------- | ---- | --------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调返回表示文件是否为垃圾文件 | | callback | AsyncCallback&lt;boolean&gt; | 是 | callback返回boolean值，值为true则为垃圾文件，值为false则为非垃圾文件。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isTrash((error, isTrash) => { asset.isTrash((error, isTrash) => {
if (error) { if (error) {
console.error('Failed to get trash state failed with error: ' + error); console.error('Failed to get trash state failed with error: ' + error);
return; return;
} }
console.info('Get trash state successfully, isTrash result: ' + isTrash); console.info('Get trash state successfully, isTrash result: ' + isTrash);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1819,27 +1817,27 @@ isTrash():Promise&lt;boolean&gt; ...@@ -1819,27 +1817,27 @@ isTrash():Promise&lt;boolean&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | -------------------- | | ------------------- | -------------------- |
| Promise&lt;void&gt; | Promise回调表示文件是否为垃圾文件 | | Promise&lt;void&gt; | Promise对象，返回boolean值，值为true则为垃圾文件，值为false则为非垃圾文件。 |
**示例：** **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
const fetchFileResult = await media.getFileAssets(getImageOp); const fetchFileResult = await media.getFileAssets(getImageOp);
const asset = await fetchFileResult.getFirstObject(); const asset = await fetchFileResult.getFirstObject();
asset.isTrash().then((isTrash) => { asset.isTrash().then((isTrash) => {
console.info('isTrash result: ' + isTrash); console.info('isTrash result: ' + isTrash);
}).catch((error) => { }).catch((error) => {
console.error('isTrash failed with error: ' + error); console.error('isTrash failed with error: ' + error);
}); });
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1855,27 +1853,27 @@ getCount(): number ...@@ -1855,27 +1853,27 @@ getCount(): number
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | -------- |
| number | 检索到的文件总数 | | number | 检索到的文件总数。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let fileType = mediaLibrary.MediaType.FILE; let fileType = mediaLibrary.MediaType.FILE;
let getFileCountOneOp = { let getFileCountOneOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [fileType.toString()], selectionArgs: [fileType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getFileCountOneOp); let fetchFileResult = await media.getFileAssets(getFileCountOneOp);
const fetchCount = fetchFileResult.getCount(); const fetchCount = fetchFileResult.getCount();
console.info('fetchCount result: ' + fetchCount); console.info('fetchCount result: ' + fetchCount);
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1887,35 +1885,35 @@ isAfterLast(): boolean ...@@ -1887,35 +1885,35 @@ isAfterLast(): boolean
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------- | | ------- | ---------------------------------- |
| boolean | 当读到最后一条记录后，后续没有记录返回true，否则返回false。 | | boolean | 当读到最后一条记录后，后续没有记录返回true，否则返回false。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
const fetchCount = fetchFileResult.getCount(); const fetchCount = fetchFileResult.getCount();
console.info('mediaLibrary fetchFileResult.getCount, count:' + fetchCount); console.info('mediaLibrary fetchFileResult.getCount, count:' + fetchCount);
let fileAsset = await fetchFileResult.getFirstObject(); let fileAsset = await fetchFileResult.getFirstObject();
for (var i = 1; i < fetchCount; i++) { for (var i = 1; i < fetchCount; i++) {
fileAsset = await fetchFileResult.getNextObject(); fileAsset = await fetchFileResult.getNextObject();
if(i == fetchCount - 1) { if(i == fetchCount - 1) {
var result = fetchFileResult.isAfterLast(); var result = fetchFileResult.isAfterLast();
console.info('mediaLibrary fileAsset isAfterLast result: ' + result); console.info('mediaLibrary fileAsset isAfterLast result: ' + result);
fetchFileResult.close(); fetchFileResult.close();
}
} }
}
} }
``` ```
...@@ -1927,19 +1925,19 @@ close(): void ...@@ -1927,19 +1925,19 @@ close(): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.close(); fetchFileResult.close();
} }
``` ```
...@@ -1951,32 +1949,32 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1951,32 +1949,32 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | ------------------------------------------- | | -------- | --------------------------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | callback返回文件检索结果集中第一个FileAsset对象。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getFirstObject((error, fileAsset) => { fetchFileResult.getFirstObject((error, fileAsset) => {
if (error) { if (error) {
console.error('fetchFileResult getFirstObject failed with error: ' + error); console.error('fetchFileResult getFirstObject failed with error: ' + error);
return; return;
} }
console.info('getFirstObject successfully, displayName : ' + fileAsset.displayName); console.info('getFirstObject successfully, displayName : ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}) })
} }
``` ```
...@@ -1988,30 +1986,30 @@ getFirstObject(): Promise&lt;FileAsset&gt; ...@@ -1988,30 +1986,30 @@ getFirstObject(): Promise&lt;FileAsset&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | -------------------------- | | --------------------------------------- | -------------------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | Promise方式返回FileAsset。 | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise对象，返回文件检索结果集中第一个FileAsset。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getFirstObject().then((fileAsset) => { fetchFileResult.getFirstObject().then((fileAsset) => {
console.info('getFirstObject successfully, displayName: ' + fileAsset.displayName); console.info('getFirstObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => { }).catch((error) => {
console.error('getFirstObject failed with error: ' + error); console.error('getFirstObject failed with error: ' + error);
}); });
} }
``` ```
...@@ -2025,36 +2023,36 @@ getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -2025,36 +2023,36 @@ getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | --------------------------------------------- | ---- | ----------------------------------------- | | --------- | --------------------------------------------- | ---- | ----------------------------------------- |
| callbacke | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回结果集中下一个FileAsset之后的回调 | | callbacke | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | callback返回文件检索结果集中下一个FileAsset对象。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
let fileAsset = await fetchFileResult.getFirstObject(); let fileAsset = await fetchFileResult.getFirstObject();
console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName); console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName);
if (!fetchFileResult.isAfterLast()) { if (!fetchFileResult.isAfterLast()) {
fetchFileResult.getNextObject((error, fileAsset) => { fetchFileResult.getNextObject((error, fileAsset) => {
if (error) { if (error) {
console.error('fetchFileResult getNextObject failed with error: ' + error); console.error('fetchFileResult getNextObject failed with error: ' + error);
return; return;
} }
console.log('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName); console.log('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}) })
} }
} }
``` ```
...@@ -2069,34 +2067,34 @@ getNextObject(): Promise&lt;FileAsset&gt; ...@@ -2069,34 +2067,34 @@ getNextObject(): Promise&lt;FileAsset&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise对象，返回文件检索结果集中下一个FileAsset。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
let fileAsset = await fetchFileResult.getFirstObject(); let fileAsset = await fetchFileResult.getFirstObject();
console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName); console.log('fetchFileResult getFirstObject successfully, displayName: ' + fileAsset.displayName);
if (!fetchFileResult.isAfterLast()) { if (!fetchFileResult.isAfterLast()) {
fetchFileResult.getNextObject().then((fileAsset) => { fetchFileResult.getNextObject().then((fileAsset) => {
console.info('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName); console.info('fetchFileResult getNextObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => { }).catch((error) => {
console.error('fetchFileResult getNextObject failed with error: ' + error); console.error('fetchFileResult getNextObject failed with error: ' + error);
}) })
} }
} }
``` ```
...@@ -2108,32 +2106,32 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -2108,32 +2106,32 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | --------------------------- | | -------- | --------------------------------------------- | ---- | --------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回FileAsset之后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | callback返回文件检索结果集中最后一个FileAsset对象。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getLastObject((error, fileAsset) => { fetchFileResult.getLastObject((error, fileAsset) => {
if (error) { if (error) {
console.error('getLastObject failed with error: ' + error); console.error('getLastObject failed with error: ' + error);
return; return;
} }
console.info('getLastObject successfully, displayName: ' + fileAsset.displayName); console.info('getLastObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}) })
} }
``` ```
...@@ -2145,30 +2143,30 @@ getLastObject(): Promise&lt;FileAsset&gt; ...@@ -2145,30 +2143,30 @@ getLastObject(): Promise&lt;FileAsset&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise对象，返回文件检索结果集中最后一个FileAsset。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getLastObject().then((fileAsset) => { fetchFileResult.getLastObject().then((fileAsset) => {
console.info('getLastObject successfully, displayName: ' + fileAsset.displayName); console.info('getLastObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => { }).catch((error) => {
console.error('getLastObject failed with error: ' + error); console.error('getLastObject failed with error: ' + error);
}); });
} }
``` ```
...@@ -2180,33 +2178,33 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -2180,33 +2178,33 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------ | | -------- | ---------------------------------------- | ---- | ------------------ |
| index | number | 是 | 要获取的文件的索引，从0开始(注意该值要小于文件检索集的count值) | | index | number | 是 | 要获取的文件的索引，从0开始(注意该值要小于文件检索集的count值)。 |
| callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回FileAsset之后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | callback返回文件检索结果集中指定索引处的FileAsset对象。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getPositionObject(0, (error, fileAsset) => { fetchFileResult.getPositionObject(0, (error, fileAsset) => {
if (error) { if (error) {
console.error('getPositionObject failed with error: ' + error); console.error('getPositionObject failed with error: ' + error);
return; return;
} }
console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName); console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}) })
} }
``` ```
...@@ -2218,36 +2216,36 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt; ...@@ -2218,36 +2216,36 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | -------------- | | ----- | ------ | ---- | -------------- |
| index | number | 是 | 要获取的文件的索引，从0开始(注意该值要小于文件检索集的count值) | | index | number | 是 | 要获取的文件的索引，从0开始(注意该值要小于文件检索集的count值)。 |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise对象，返回文件检索结果集中指定索引处的FileAsset。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getPositionObject(0).then((fileAsset) => { fetchFileResult.getPositionObject(0).then((fileAsset) => {
console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName); console.info('getPositionObject successfully, displayName: ' + fileAsset.displayName);
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => { }).catch((error) => {
console.error('getPositionObject failed with error: ' + error); console.error('getPositionObject failed with error: ' + error);
}); });
} }
``` ```
...@@ -2259,34 +2257,34 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void ...@@ -2259,34 +2257,34 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------- | | -------- | ---------------------------------------- | ---- | -------------------- |
| callback | AsyncCallback&lt;Array&lt;[FileAsset](#fileasset7)&gt;&gt; | 是 | 异步返回FileAsset列表之后的回调 | | callback | AsyncCallback&lt;Array&lt;[FileAsset](#fileasset7)&gt;&gt; | 是 | callback返回文件检索结果集中所有的FileAsset对象。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getAllObject((error, fileAssetList) => { fetchFileResult.getAllObject((error, fileAssetList) => {
if (error) { if (error) {
console.error('getAllObject failed with error: ' + error); console.error('getAllObject failed with error: ' + error);
return; return;
} }
for (let i = 0; i < fetchFileResult.getCount(); i++) { for (let i = 0; i < fetchFileResult.getCount(); i++) {
console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName); console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName);
} }
fetchFileResult.close(); fetchFileResult.close();
}) })
} }
``` ```
...@@ -2298,32 +2296,32 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt; ...@@ -2298,32 +2296,32 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------------- | | ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[FileAsset](#fileasset7)&gt;&gt; | 返回FileAsset对象列表 | | Promise&lt;Array&lt;[FileAsset](#fileasset7)&gt;&gt; | Promise对象，返回文件检索结果集中所有的FileAsset。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
let fileKeyObj = mediaLibrary.FileKey; let fileKeyObj = mediaLibrary.FileKey;
let imageType = mediaLibrary.MediaType.IMAGE; let imageType = mediaLibrary.MediaType.IMAGE;
let getImageOp = { let getImageOp = {
selections: fileKeyObj.MEDIA_TYPE + '= ?', selections: fileKeyObj.MEDIA_TYPE + '= ?',
selectionArgs: [imageType.toString()], selectionArgs: [imageType.toString()],
order: fileKeyObj.DATE_ADDED + ' DESC', order: fileKeyObj.DATE_ADDED + ' DESC',
}; };
let fetchFileResult = await media.getFileAssets(getImageOp); let fetchFileResult = await media.getFileAssets(getImageOp);
fetchFileResult.getAllObject().then((fileAssetList) => { fetchFileResult.getAllObject().then((fileAssetList) => {
for (let i = 0; i < fetchFileResult.getCount(); i++) { for (let i = 0; i < fetchFileResult.getCount(); i++) {
console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName); console.info('getAllObject fileAssetList ' + i + ' displayName: ' + fileAssetList[i].displayName);
} }
fetchFileResult.close(); fetchFileResult.close();
}).catch((error) => { }).catch((error) => {
console.error('getAllObject failed with error: ' + error); console.error('getAllObject failed with error: ' + error);
}); });
} }
``` ```
...@@ -2337,13 +2335,13 @@ async function example() { ...@@ -2337,13 +2335,13 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------- | | ------------ | ------ | ---- | ---- | ------- |
| albumId | number | 是 | 否 | 相册编号 | | albumId | number | 是 | 否 | 相册编号。 |
| albumName | string | 是 | 是 | 相册名称 | | albumName | string | 是 | 是 | 相册名称。 |
| albumUri<sup>8+</sup> | string | 是 | 否 | 相册Uri | | albumUri<sup>8+</sup> | string | 是 | 否 | 相册Uri。 |
| dateModified | number | 是 | 否 | 修改日期 | | dateModified | number | 是 | 否 | 修改日期。 |
| count<sup>8+</sup> | number | 是 | 否 | 相册中文件数量 | | count<sup>8+</sup> | number | 是 | 否 | 相册中文件数量。 |
| relativePath<sup>8+</sup> | string | 是 | 否 | 相对路径 | | relativePath<sup>8+</sup> | string | 是 | 否 | 相对路径。 |
| coverUri<sup>8+</sup> | string | 是 | 否 | 封面文件Uri | | coverUri<sup>8+</sup> | string | 是 | 否 | 封面文件Uri。 |
### commitModify<sup>8+</sup> ### commitModify<sup>8+</sup>
...@@ -2355,13 +2353,13 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void ...@@ -2355,13 +2353,13 @@ commitModify(callback: AsyncCallback&lt;void&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调返回空 | | callback | AsyncCallback&lt;void&gt; | 是 | callback返回空。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
...@@ -2379,7 +2377,7 @@ async function example() { ...@@ -2379,7 +2377,7 @@ async function example() {
return; return;
} }
console.info('commitModify successful.'); console.info('commitModify successful.');
}) });
} }
``` ```
...@@ -2393,13 +2391,13 @@ commitModify(): Promise&lt;void&gt; ...@@ -2393,13 +2391,13 @@ commitModify(): Promise&lt;void&gt;
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------ | | ------------------- | ------------ |
| Promise&lt;void&gt; | Promise调用返回空 | | Promise&lt;void&gt; | Promise对象，返回空。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
...@@ -2429,13 +2427,13 @@ getFileAssets(callback: AsyncCallback&lt;FetchFileResult&gt;): void ...@@ -2429,13 +2427,13 @@ getFileAssets(callback: AsyncCallback&lt;FetchFileResult&gt;): void
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ----------------------------------- | | -------- | --------------------------------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步返回FetchFileResult之后的回调。 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | callback返回相册中的文件检索结果集。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
...@@ -2470,14 +2468,14 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe ...@@ -2470,14 +2468,14 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ----------------------------------- | | -------- | --------------------------------------------------- | ---- | ----------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 媒体检索选项。 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 媒体检索选项。 |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步返回FetchFileResult之后的回调。 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | callback返回相册中的文件检索结果集。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
...@@ -2489,11 +2487,11 @@ async function example() { ...@@ -2489,11 +2487,11 @@ async function example() {
let fileNoArgsfetchOp = { let fileNoArgsfetchOp = {
selections: '', selections: '',
selectionArgs: [], selectionArgs: [],
} };
// 获取符合检索要求的相册，返回相册列表 // 获取符合检索要求的相册，返回相册列表。
const albumList = await media.getAlbums(AlbumNoArgsfetchOp); const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
const album = albumList[0]; const album = albumList[0];
// 取到相册列表中的一个相册，获取此相册中所有符合媒体检索选项的媒体资源 // 取到相册列表中的一个相册，获取此相册中所有符合媒体检索选项的媒体资源。
album.getFileAssets(fileNoArgsfetchOp, (error, fetchFileResult) => { album.getFileAssets(fileNoArgsfetchOp, (error, fetchFileResult) => {
if (error) { if (error) {
console.error('album getFileAssets failed with error: ' + error); console.error('album getFileAssets failed with error: ' + error);
...@@ -2516,19 +2514,19 @@ async function example() { ...@@ -2516,19 +2514,19 @@ async function example() {
**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core
**参数**： **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | -------------- | | ------- | ---------------------------------------- | ---- | -------------- |
| options | [MediaFetchOptions](#mediafetchoptions7) | 否 | 媒体检索选项。 | | options | [MediaFetchOptions](#mediafetchoptions7) | 否 | 媒体检索选项。 |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------------- | ------------------------- | | --------------------------------------------- | ------------------------- |
| Promise<[FetchFileResult](#fetchfileresult7)> | 返回FetchFileResult对象。 | | Promise<[FetchFileResult](#fetchfileresult7)> | Promise对象，返回相册中的文件检索结果集。 |
**示例**： **示例：**
```js ```js
async function example() { async function example() {
...@@ -2541,10 +2539,10 @@ async function example() { ...@@ -2541,10 +2539,10 @@ async function example() {
selections: '', selections: '',
selectionArgs: [], selectionArgs: [],
}; };
// 获取符合检索要求的相册，返回相册列表 // 获取符合检索要求的相册，返回相册列表。
const albumList = await media.getAlbums(AlbumNoArgsfetchOp); const albumList = await media.getAlbums(AlbumNoArgsfetchOp);
const album = albumList[0]; const album = albumList[0];
// 取到相册列表中的一个相册，获取此相册中所有符合媒体检索选项的媒体资源 // 取到相册列表中的一个相册，获取此相册中所有符合媒体检索选项的媒体资源。
album.getFileAssets(fileNoArgsfetchOp).then((fetchFileResult) => { album.getFileAssets(fileNoArgsfetchOp).then((fetchFileResult) => {
let count = fetchFileResult.getCount(); let count = fetchFileResult.getCount();
console.info('album getFileAssets successfully, count: ' + count); console.info('album getFileAssets successfully, count: ' + count);
...@@ -2565,12 +2563,10 @@ async function example() { ...@@ -2565,12 +2563,10 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | -------------------------- | ---- | ---- | ---------------- | | ---------- | -------------------------- | ---- | ---- | ---------------- |
| deviceName | string | 是 | 否 | 注册设备的名称 | | deviceName | string | 是 | 否 | 注册设备的名称。 |
| networkId | string | 是 | 否 | 注册设备的网络ID | | networkId | string | 是 | 否 | 注册设备的网络ID。 |
| deviceType | [DeviceType](#devicetype8) | 是 | 否 | 设备类型 | | deviceType | [DeviceType](#devicetype8) | 是 | 否 | 设备类型。 |
| isOnline | boolean | 是 | 否 | 是否在线 | | isOnline | boolean | 是 | 否 | 是否在线。 |
## MediaType<sup>8+</sup> ## MediaType<sup>8+</sup>
...@@ -2580,10 +2576,10 @@ async function example() { ...@@ -2580,10 +2576,10 @@ async function example() {
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ----- | ---- | ---- | | ----- | ---- | ---- |
| FILE | 0 | 文件 | | FILE | 0 | 文件。 |
| IMAGE | 1 | 图片 | | IMAGE | 1 | 图片。 |
| VIDEO | 2 | 视频 | | VIDEO | 2 | 视频。|
| AUDIO | 3 | 音频 | | AUDIO | 3 | 音频。 |
## FileKey<sup>8+</sup> ## FileKey<sup>8+</sup>
...@@ -2596,25 +2592,25 @@ async function example() { ...@@ -2596,25 +2592,25 @@ async function example() {
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | ------------------- | ---------------------------------------------------------- | | ------------- | ------------------- | ---------------------------------------------------------- |
| ID | 'file_id' | 文件编号 | | ID | 'file_id' | 文件编号。 |
| RELATIVE_PATH | 'relative_path' | 相对公共目录路径 | | RELATIVE_PATH | 'relative_path' | 相对公共目录路径。 |
| DISPLAY_NAME | 'display_name' | 显示名字 | | DISPLAY_NAME | 'display_name' | 显示名字。 |
| PARENT | 'parent' | 父目录id | | PARENT | 'parent' | 父目录id。 |
| MIME_TYPE | 'mime_type' | 文件扩展属性(如：image/*、video/*、file/*) | | MIME_TYPE | 'mime_type' | 文件扩展属性(如：image/*、video/*、file/*)。 |
| MEDIA_TYPE | 'media_type' | 媒体类型 | | MEDIA_TYPE | 'media_type' | 媒体类型。 |
| SIZE | 'size' | 文件大小（单位：字节） | | SIZE | 'size' | 文件大小（单位：字节）。 |
| DATE_ADDED | 'date_added' | 添加日期（添加文件时间到1970年1月1日的秒数值） | | DATE_ADDED | 'date_added' | 添加日期（添加文件时间到1970年1月1日的秒数值）。 |
| DATE_MODIFIED | 'date_modified' | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新） | | DATE_MODIFIED | 'date_modified' | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新）。 |
| DATE_TAKEN | 'date_taken' | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | | DATE_TAKEN | 'date_taken' | 拍摄日期（文件拍照时间到1970年1月1日的秒数值）。 |
| TITLE | 'title' | 文件标题 | | TITLE | 'title' | 文件标题。 |
| ARTIST | 'artist' | 作者 | | ARTIST | 'artist' | 作者。 |
| AUDIOALBUM | 'audio_album' | 专辑 | | AUDIOALBUM | 'audio_album' | 专辑。 |
| DURATION | 'duration' | 持续时间（单位：毫秒） | | DURATION | 'duration' | 持续时间（单位：毫秒）。 |
| WIDTH | 'width' | 图片宽度（单位：像素） | | WIDTH | 'width' | 图片宽度（单位：像素）。 |
| HEIGHT | 'height' | 图片高度（单位：像素） | | HEIGHT | 'height' | 图片高度（单位：像素）。 |
| ORIENTATION | 'orientation' | 图片显示方向，即顺时针旋转角度，如0，90，180。（单位：度） | | ORIENTATION | 'orientation' | 图片显示方向，即顺时针旋转角度，如0，90，180。（单位：度）。 |
| ALBUM_ID | 'bucket_id' | 文件所归属的相册编号 | | ALBUM_ID | 'bucket_id' | 文件所归属的相册编号。 |
| ALBUM_NAME | 'bucket_display_name' | 文件所归属相册名称 | | ALBUM_NAME | 'bucket_display_name' | 文件所归属相册名称。 |
## DirectoryType<sup>8+</sup> ## DirectoryType<sup>8+</sup>
...@@ -2624,12 +2620,12 @@ async function example() { ...@@ -2624,12 +2620,12 @@ async function example() {
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------- | --- | ------------------ | | ------------- | --- | ------------------ |
| DIR_CAMERA | 0 | 表示Camera文件路径 | | DIR_CAMERA | 0 | 表示Camera文件路径。 |
| DIR_VIDEO | 1 | 表示视频路径 | | DIR_VIDEO | 1 | 表示视频路径。 |
| DIR_IMAGE | 2 | 表示图片路径 | | DIR_IMAGE | 2 | 表示图片路径。 |
| DIR_AUDIO | 3 | 表示音频路径 | | DIR_AUDIO | 3 | 表示音频路径。 |
| DIR_DOCUMENTS | 4 | 表示文档路径 | | DIR_DOCUMENTS | 4 | 表示文档路径。 |
| DIR_DOWNLOAD | 5 | 表示下载路径 | | DIR_DOWNLOAD | 5 | 表示下载路径。 |
## DeviceType<sup>8+</sup> ## DeviceType<sup>8+</sup>
...@@ -2641,13 +2637,13 @@ async function example() { ...@@ -2641,13 +2637,13 @@ async function example() {
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------ | --- | ---------- | | ------------ | --- | ---------- |
| TYPE_UNKNOWN | 0 | 未识别设备 | | TYPE_UNKNOWN | 0 | 未识别设备。 |
| TYPE_LAPTOP | 1 | 笔记本电脑 | | TYPE_LAPTOP | 1 | 笔记本电脑。 |
| TYPE_PHONE | 2 | 手机 | | TYPE_PHONE | 2 | 手机。 |
| TYPE_TABLET | 3 | 平板电脑 | | TYPE_TABLET | 3 | 平板电脑。 |
| TYPE_WATCH | 4 | 智能手表 | | TYPE_WATCH | 4 | 智能手表。 |
| TYPE_CAR | 5 | 车载设备 | | TYPE_CAR | 5 | 车载设备。 |
| TYPE_TV | 6 | 电视设备 | | TYPE_TV | 6 | 电视设备。 |
## MediaFetchOptions<sup>7+</sup> ## MediaFetchOptions<sup>7+</sup>
...@@ -2660,9 +2656,9 @@ async function example() { ...@@ -2660,9 +2656,9 @@ async function example() {
| selections | string | 是 | 是 | 检索条件，使用[FileKey](#filekey8)中的枚举值作为检索条件的列名。示例：<br/>selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' + mediaLibrary.FileKey.MEDIA_TYPE + '= ?', | | selections | string | 是 | 是 | 检索条件，使用[FileKey](#filekey8)中的枚举值作为检索条件的列名。示例：<br/>selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' + mediaLibrary.FileKey.MEDIA_TYPE + '= ?', |
| selectionArgs | Array&lt;string&gt; | 是 | 是 | 检索条件的值，对应selections中检索条件列的值。<br/>示例：<br/>selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], | | selectionArgs | Array&lt;string&gt; | 是 | 是 | 检索条件的值，对应selections中检索条件列的值。<br/>示例：<br/>selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| order | string | 是 | 是 | 检索结果排序方式，使用[FileKey](#filekey8)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：<br/>升序排列：order: mediaLibrary.FileKey.DATE_ADDED + ' ASC'<br/>降序排列：order: mediaLibrary.FileKey.DATE_ADDED + ' DESC' | | order | string | 是 | 是 | 检索结果排序方式，使用[FileKey](#filekey8)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：<br/>升序排列：order: mediaLibrary.FileKey.DATE_ADDED + ' ASC'<br/>降序排列：order: mediaLibrary.FileKey.DATE_ADDED + ' DESC' |
| uri<sup>8+</sup> | string | 是 | 是 | 文件URI | | uri<sup>8+</sup> | string | 是 | 是 | 文件URI。 |
| networkId<sup>8+</sup> | string | 是 | 是 | 注册设备网络ID | | networkId<sup>8+</sup> | string | 是 | 是 | 注册设备网络ID。 |
| extendArgs<sup>8+</sup> | string | 是 | 是 | 扩展的检索参数，目前没有扩展检索参数 | | extendArgs<sup>8+</sup> | string | 是 | 是 | 扩展的检索参数，目前没有扩展检索参数。 |
## Size<sup>8+</sup> ## Size<sup>8+</sup>
...@@ -2672,8 +2668,8 @@ async function example() { ...@@ -2672,8 +2668,8 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | -------- | | ------ | ------ | ---- | ---- | -------- |
| width | number | 是 | 是 | 宽（单位：像素） | | width | number | 是 | 是 | 宽（单位：像素）。 |
| height | number | 是 | 是 | 高（单位：像素） | | height | number | 是 | 是 | 高（单位：像素）。 |
## MediaAssetOption ## MediaAssetOption
...@@ -2681,7 +2677,6 @@ async function example() { ...@@ -2681,7 +2677,6 @@ async function example() {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------ | ---- | ---- | ------------------------------------------------------------ | | ------------ | ------ | ---- | ---- | ------------------------------------------------------------ |
| src | string | 是 | 是 | 本地文件应用沙箱路径。 | | src | string | 是 | 是 | 本地文件应用沙箱路径。 |
...@@ -2696,6 +2691,5 @@ async function example() { ...@@ -2696,6 +2691,5 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | -------------------- | | ----- | ------ | ---- | ---- | -------------------- |
| type | 'image' &#124; 'video' &#124; 'media' | 是 | 是 | 媒体类型，包括：image, video, media，当前仅支持media类型 | | type | 'image' &#124; 'video' &#124; 'media' | 是 | 是 | 媒体类型，包括：image, video, media，当前仅支持media类型。 |
| count | number | 是 | 是 | 可以选择媒体数量的最大值，count = 1表示单选，count大于1表示多选。 | | count | number | 是 | 是 | 可以选择媒体数量的最大值，count = 1表示单选，count大于1表示多选。 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或