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