From 1d15a82c85b745aabc98c41e7f111b191a7c5b48 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 24 Feb 2022 20:34:26 +0800 Subject: [PATCH 01/25] add medialibrary Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 1385 +++++++++++++++++ 1 file changed, 1385 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-medialibrary.md diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md new file mode 100644 index 00000000000..26e3b530eaf --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -0,0 +1,1385 @@ +媒体库管理 +========== + + 导入模块 +--------- + +``` +import medialibrary from '@ohos.multimedia.medialibrary'; +``` + +权限 +---- + +- ohos.permission.MEDIA_LOCATION +- ohos.permission.MEDIA_READ +- ohos.permission.MEDIA_WRITE + + +## getMediaLibrary +--------------- + +function getMediaLibrary(context: Context): MediaLibrary; + +获取媒体库。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | -------------------- | +| context | Context | 是 | API 8接口此参数是必填参数，传入context，获取媒体库 | + +**返回值：** + +| 类型 | 说明 | +| ------------ | :----- | +| MediaLibrary | 媒体库实例 | + +**示例：** + +``` +var media = mediaLibrary.getMediaLibrary(context); +``` + +## medialibrary.getFileAssets + + +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; + +获取文件资源，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- | +| options | MediaFetchOptions | 是 | 媒体获取选项。 | +| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步获取FetchFileResult之后的回调。 | + +**示例：** + +``` +medialibrary.getFileAssets(fetchOp, (error, data) => { + // do something + }); +``` +## medialibrary.getFileAssets + +getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; + +获取文件资源，使用Promise方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | -------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项。 | + +**返回值** + +| 类型 | 说明 | +| -------------------------------------------- | ---------------- | +| [FetchFileResult](#FetchFileResult.getCount) | 媒体数据结果集。 | + +**示例：** + +``` +let fetchFileResult = await medialibrary.getFileAssets(fileNoArgsfetchOp); +``` + +## medialibrary.on + +on(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback: () => {}): void; + +打开媒体文件变更和上线通知，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------- | +| type | type | 是 | 媒体类型。 | +| callback | AsyncCallback<void> | 是 | 回调返回空。 | + +**示例：** + +``` +medialibrary.on(['image','video','audio'], () => { + this.sendNotify('image'); +}) +``` +## medialibrary.off + +off(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback?: () => {}): void; + +关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------- | ---- | ------------------- | +| type | type | 是 | 媒体类型。 | +| callback | AsyncCallback<void> | 是 | 回调返回空。 | + +**示例：** + +``` +medialibrary.off(['image','video','audio'], () => { + this.sendNotify('image'); +}) +``` + +## medialibrary.createAsset + +createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void; + +创建媒体资源，使用callback方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | -------------------------------------- | ---- | ------------------------------------- | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型。 | +| displayName | string | 是 | 展示文件名。 | +| relativePath | string | 是 | 相对路径。 | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调。 | + +**示例：** + +``` +medialibrary.createAsset(mediaType, displayName, rp, (createAssetErr, fileObj) => { + // do something + }); +``` + +## medialibrary.createAsset + +createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset>; + +创建媒体资源，使用Promise方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ----------------------- | ---- | ------------ | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型。 | +| displayName | string | 是 | 展示文件名。 | +| relativePath | string | 是 | 相对路径。 | + +**返回值** + +| 类型 | 说明 | +| ----------------------- | ----------------- | +| [FileAsset](#FileAsset) | 媒体数据FileAsset | + +**示例：** + +``` +asset = await medialibrary.createAsset(mediaType, "image01.jpg", path); +``` + +## medialibrary.deleteAsset + +deleteAsset(uri: string, callback: AsyncCallback<void>): void; + +删除媒体资源，使用callback方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------- | ---- | ---------------------- | +| uri | string | 是 | 文件uri。 | +| callback | AsyncCallback<void> | 是 | 回调返回空。 | + +**示例：** + +``` +medialibrary.deleteAsset(fileAsset.uri, (deleteAssetErr, deleteRows) => { + // do something + }); +``` + +## medialibrary.deleteAsset + +deleteAsset(uri: string): Promise<void>; + +删除媒体资源，使用promise方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | --------- | +| uri | string | 是 | 文件uri。 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ------------------------------------------------- | +| Promise<void> | Promise实例，用于异步获取结果。本调用将返回空值。 | + +**示例：** + +``` +await medialibrary.deleteAsset(asset.uri); +``` + +## medialibrary.getAlbums + +getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void; + +获取实体相册，使用callback 方式返回结果。 + +**参数** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ----------------------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件。 | +| callback | AsyncCallback<Array<[Album](#Album)>> | 是 | 异步获取Album列表之后的回调。 | + +**示例：** + +``` +medialibrary.getAlbums(AlbumNoArgsfetchOp, getAlbumsCallBack); +``` + +## medialibrary.getAlbums + +getAlbums(options: MediaFetchOptions): Promise; + +获取实体相册，使用 promise 方式返回结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------------------ | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件。 | + +**返回值：** + +| 类型 | 说明 | +| ------------------------------- | ------------- | +| Promise> | 返回Album列表 | + +**示例：** + +``` +let albumList = await medialibrary.getAlbums(AlbumNoArgsfetchOp); +``` + +## medialibrary.getActivePeers + +getActivePeers(callback: AsyncCallback): void; + +获取活动对端设备 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------ | ---- | ---------------------- | +| callback | AsyncCallback> | 是 | 回调表示成功还是失败。 | + +**示例：** + +``` +medialibrary.getActivePeers((err, data) => { + // do something + }); +``` + +## medialibrary.getActivePeers + +getActivePeers(): Promise; + +获取活动对端设备 + +**参数：** + +返回值： + +| 类型 | 说明 | +| ------------------------------------- | ----------------------------------- | +| Promise> | Promise实例，用于获取异步返回结果。 | + +**示例：** + +``` +peerInfoList = medialibrary.getActivePeers(); +``` + +## medialibrary.getAllPeers + +getAllPeers(callback: AsyncCallback): void; + +获取所有对端设备 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------ | ---- | ---------------------- | +| callback | AsyncCallback> | 是 | 回调表示成功还是失败。 | + +**示例：** + +``` +medialibrary.getAllPeers((err, data) => { + // do something + }); +``` + +## medialibrary.getAllPeers + +getAllPeers(): Promise; + +获取所有对端设备 + +**返回值：** + +| 类型 | 说明 | +| ------------------------------------- | ----------------------------------- | +| Promise> | Promise实例，用于获取异步返回结果。 | + +**示例：** + +peerInfoList = media.getAllPeers(); + +## medialibrary.release + +release(callback: AsyncCallback<void>): void; + +释放MediaLibrary实例 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------- | ---- | ---------------------- | +| callback | AsyncCallback<void> | 是 | 回调表示成功还是失败。 | + +**示例：** + +``` +medialibrary.release((err, data) => { + // do something + }); +``` + +## medialibrary.release + +release(): Promise<void>; + +释放MediaLibrary实例 + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------------- | +| Promise<void> | Promise实例，用于获取异步返回结果。 | + +**示例：** + +``` +medialibrary.release() +``` + + + + + +## FileAsset.isDirectory + +isDirectory(callback: AsyncCallback<boolean>): void; + +判断fileAsset是否为目录，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ----------------------------- | +| callback | AsyncCallback<boolean> | 是 | 当前FileAsset是否是目录的回调 | + +**示例：** + +``` +asset.isDirectory((err, isDirectory) => { + // do something + }); +``` + +## FileAsset.isDirectory + +isDirectory():Promise<boolean>; + +判断fileAsset是否为目录，使用Promise方式返回异步结果。 + +**返回值：** + +| 类型 | 说明 | +| ---------------- | ------------------------------------------ | +| Promise<boolean> | Promise实例，返回当前FileAsset是否是目录。 | + +**示例：** + +``` +let isDirectory = await asset.isDirectory(); +``` + +## FileAsset.commitModify + +commitModify(callback: AsyncCallback<void>): void; + +修改文件的元数据，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| callback | AsyncCallback<void> | 是 | 回调返回空 | + +**示例：** + +``` +await asset.commitModify(); +``` + +## FileAsset.commitModify + +commitModify(): Promise<void>; + +修改文件的元数据，使用promise方式返回异步结果。 + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<void> | Promise返回空。 | + +**示例：** + +``` +asset.commitModify(commitModifyCallBack); +function commitModifyCallBack(err, commitModify) { + // do something + + } +``` + +## FileAsset.open + +open(mode: string, callback: AsyncCallback<number>): void; + +打开当前文件，使用callback方式返回异步结果。 + +**参数** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| mode | string | 是 | 打开文件方式 | +| callback | AsyncCallback<number> | 是 | 回调返回文件句柄 | + +**示例：** + +``` +asset.open('Rw').then((openError, fd) => { + // do something + } +``` + +## FileAsset.open + +open(mode: string): Promise<number>; + +打开当前文件，使用promise方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------ | +| mode | string | 是 | 打开文件方式 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<number> | Promise返回文件句柄。 | + +**示例：** + +``` +asset.open('Rw').then((openError, fd) => { + // do something + } +``` + +## FileAsset.close + +close(fd: number, callback: AsyncCallback<void>): void; + +关闭当前文件，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| fd | number | 是 | 文件描述符 | +| callback | AsyncCallback<void> | 是 | 回调返回空 | + +**示例：** + +``` +fileAsset.close(fd).then((closeErr) => { + // do something + } +``` + +## FileAsset.close + +close(fd: number): Promise<void>; + +关闭当前文件，使用promise方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ---------- | +| fd | number | 是 | 文件描述符 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<void> | Promise返回空。 | + +**示例：** + +``` +fileAsset.close(fd).then((closeErr) => { + // do something + } +``` + +## FileAsset.getThumbnail + +getThumbnail(callback: AsyncCallback<image.PixelMap>): void; + +获取文件的缩略图，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| callback | AsyncCallback<image.PixelMap> | 是 | 回调返回缩略图的PixelMap | + +**示例：** + +``` +data1.getThumbnail(size, (err2, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +``` + +## FileAsset.getThumbnail + +getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; + +获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| size | [Size](#Size) | 是 | 缩略图尺寸 | +| callback | AsyncCallback<image.PixelMap> | 是 | 回调返回缩略图的PixelMap | + +**示例：** + +``` +data1.getThumbnail(size, (err2, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +``` + +## FileAsset.getThumbnail + +getThumbnail(size?: Size): Promise<image.PixelMap>; + +获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------- | ---- | ---------- | +| size | [Size](#Size) | 否 | 缩略图尺寸 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<image.PixelMap> | Promise返回缩略图的PixelMap。 | + +**示例：** + +``` +data1.getThumbnail(size, (err2, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +``` + +## FileAsset.favorite + +favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; + +将文件设置为收藏文件，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------------------- | ---- | -------------- | +| isFavorite | boolean | 是 | 是否为收藏文件 | +| callback | AsyncCallback<void> | 是 | 回调返回空 | + +**示例：** + +``` +await asset.favorite(true); +``` + +## FileAsset.favorite + +favorite(isFavorite: boolean): Promise<void>; + +将文件设置为收藏文件，使用promise方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | -------------- | +| isFavorite | boolean | 是 | 是否为收藏文件 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<void> | Promise返回空。 | + +**示例：** + +``` +await asset.favorite(true); +``` + +## FileAsset.isFavorite + +isFavorite(callback: AsyncCallback<boolean>): void; + +判断该文件是否为收藏文件，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | ---------------------- | +| callback | AsyncCallback<boolean> | 是 | 回调表示是否为收藏文件 | + +**示例：** + +``` +asset.favorite(true, (err) => { + // do something + }); +``` + +## FileAsset.isFavorite + +isFavorite():Promise<boolean>; + +判断该文件是否为收藏文件，使用promise方式返回异步结果。 + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<boolean> | Promise回调表示是否是收藏文件。 | + +**示例：** + +``` +let isFavorite = await asset.isFavorite(); +``` + +## FileAsset.trash + +trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; + +当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| isTrash | boolean | 是 | 是否为收藏文件 | +| callback | AsyncCallback<void> | 是 | 回调返回空 | + +**示例：** + +``` +asset.trash(true, (err) => { + // do something + }); +``` + +## FileAsset.trash + +trash(isTrash: boolean,): Promise<void>; + +当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | -------------- | +| isTrash | boolean | 是 | 是否放入回收站 | + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<void> | Promise返回空。 | + +**示例：** + +``` +await asset.trash(true); +``` + +## FileAsset.isTrash + +isTrash(callback: AsyncCallback<boolean>): void; + +当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------- | ---- | -------------------- | +| callback | AsyncCallback<boolean> | 是 | 回调返回表示文件是否为垃圾文件 | + +**示例：** + +``` +asset.isTrash((err, isTrash) => { + // do something + }); +``` + +## FileAsset.isTrash + +isTrash():Promise<boolean>; + +当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 + +**返回值：** + +| 类型 | 说明 | +| ------------- | ----------------------------- | +| Promise<void> | Promise回调表示文件是否为垃圾文件。 | + +**示例：** + +``` +let isTrash = await asset.isTrash(); +``` + +**FetchFileResult** + +文件检索结果集。 + +## FetchFileResult.getCount + +getCount(): number; + +获取文件检索结果中的文件总数。 + +**返回值**： + +| 类型 | 说明 | +| ------ | ------------------ | +| number | 检索到的文件总数。 | + +**示例**： + +``` +var resultnum = FetchFileResult.getCount(); +``` + +## FetchFileResult.isAfterLast + +isAfterLast(): boolean; + +检查结果集是否指向最后一行。 + +**返回值**： + +| 类型 | 说明 | +| ------- | ------------------------------------------------------------ | +| boolean | 当读到最后一条记录后，再继续读就到结果集尾了，没有记录了，执行isAfterLast()方法就返回true，否则返回false。 | + +**示例**： + +``` +var result = FetchFileResult.isAfterLast(); +``` + +## FetchFileResult.close + +close(): void; + +释放 FetchFileResult 实例并使其失效。无法调用其他方法。 + +**示例**： + +``` +var result = FetchFileResult.close(); +``` + +## FetchFileResult.getFirstObject + +getFirstObject(callback: AsyncCallback<FileAsset>): void; + +获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | --------------------------------------------- | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调。 | + +**示例**： + +``` +data.getFirstObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## FetchFileResult.getFirstObject + +getFirstObject(): Promise<FileAsset>; + +获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 + +**返回值**： + +| 类型 | 说明 | +| ------------------ | -------------------------------------- | +| Promise<[FileAsset](#FileAsset)> | Promise方式返回FileAsset | + + +**示例**： + +``` +const fileAsset = await queryResultSet_.getFirstObject(); +}) +``` + +## FetchFileResult.getNextObject + + getNextObject(callback: AsyncCallback<FileAsset>): void; + +获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 + +**参数**： + +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------------------------- | ---- | ------------------------------------------- | +| callbacke | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回结果集中下一个FileAsset之后的回调。 | + +**示例**： + +``` +data.getNextObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## FetchFileResult.getNextObject + + getNextObject(): Promise<FileAsset>; + +获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 + +**返回值**： + +| 类型 | 说明 | +| -------------------------------- | ------------------- | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | + +**示例**： + +``` +var result = FetchFileResult.getNextObject +``` + +## FetchFileResult.getLastObject + +getLastObject(callback: AsyncCallback<FileAsset>): void; + +获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ----------------------------- | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调。 | + +**示例**： + +``` +data.getLastObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + + + +## FetchFileResult.getLastObject + +getLastObject(): Promise<FileAsset>; + +获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 + +**返回值**： + +| 类型 | 说明 | +| -------------------------------- | ------------------- | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | + +**示例**： + +``` +var result = FetchFileResult.getLastObject() +``` + +## FetchFileResult.getPositionObject + +getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void; + +获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------- | ---- | ----------------------------- | +| index | number | 是 | 要获取的文件的索引。 | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调。 | + +**示例**： + +``` +data. getPositionObject(1，(err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## FetchFileResult.getPositionObject + +getPositionObject(index: number): Promise<FileAsset>; + +获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | -------------------- | +| index | number | 是 | 要获取的文件在结果集中的位置。 | + +**返回值**： + +| 类型 | 说明 | +| -------------------------------- | ------------------- | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | + +**示例**： + +``` +data.getPositionObject(1，(err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## FetchFileResult.getAllObject + +getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; + +获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | --------------------------------- | +| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调。 | + +**示例**： + +``` +data.getAllObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## FetchFileResult.getAllObject + +getAllObject(): Promise<Array<FileAsset>>; + +获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 + +**返回值**： + +| 类型 | 说明 | +| --------------------------------------- | ----------------------- | +| Promise> | 返回FileAsset对象列表。 | + +**示例**： + +``` +var data = FetchFileResult.getAllObject(); +``` + + + + + +## Album.commitModify + +commitModify(callback: AsyncCallback<void>): void; + +更新相册属性修改到数据库中。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ------------------- | ---- | ----------------------------- | +| callback | AsyncCallback<void> | 是 | 回调返回空 | + +**示例**： + +``` +album.albumName = 'hello'; +album.commitModify((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); +}) +``` + +## Album.commitModify + +commitModify(): Promise<void>; + +更新相册属性修改到数据库中。 + +**返回值**： + +| 类型 | 说明 | +| ------------- | ---------------------------------------------------- | +| Promise<void> | Promise调用返回空 | + +**示例**： + +``` +album.albumName = 'hello'; +await album.commitModify(); +``` + +## Album.getFileAssets + +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; + +按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项。 | +| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调。 | + +**示例**： + +``` +album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack); +}) +function getFileAssetsCallBack(err, fetchFileResult) { + // do something +} +``` + +## Album.getFileAssets + + getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult>; + +按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | -------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 否 | 媒体检索选项。 | + +**返回值**： + +| 类型 | 说明 | +| ----------------------------------------------------- | ------------------------- | +| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象。 | + +**示例**： + +``` +let albumFetchFileResult = await album.getFileAssets(fileNoArgsfetchOp); +``` + + + + + +## SmartAlbum.getFileAssets + +getFileAssets(callback: AsyncCallback<FetchFileResult>): void; + +获取智能相册中的文件资源 + +**参数**： + +| 参数 | 类型 | 必填 | 说明 | +| ------- | ----------------- | ---- | -------------- | +| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调。 | + +**示例**： + +``` +favSmartAlbum.getFileAssets(getFileAssetsCallBack); +function getFileAssetsCallBack(err, fSmartFetchFileResult) { + // do something + } +``` + +## SmartAlbum.getFileAssets + +getFileAssets(): Promise<FetchFileResult>; + +获取智能相册中的文件资源 + +**返回值**： + +| 类型 | 说明 | +| ----------------------------------------------------- | ----------------------- | +| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象 | + +**示例**： + +``` + let fSmartFetchFileResult = await favSmartAlbum.getFileAssets(); +``` + + + +FileAsset +--------- + +**属性：** + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------ | --------- | ---- | ---- | ------------ | +| id | number | 是 | 否 | 文件资源编号 | +| uri | string | 是 | 否 | 文件资源uri | +| mimeType | string | 是 | 否 | 文件扩展 | +| mediaType | MediaType | 是 | 否 | 媒体类型 | +| displayName | string | 是 | 是 | 显示文件名 | +| title | string | 是 | 是 | 文件标题 | +| relativePath | string | 是 | 是 | 相对路径 | +| parent | number | 是 | 否 | 父目录id | +| size | number | 是 | 否 | 文件大小 | +| dateAdded | number | 是 | 否 | 添加日期 | +| dateModified | number | 是 | 否 | 修改日期 | +| dateTaken | number | 是 | 否 | 拍摄日期 | +| artist | string | 是 | 否 | 创建者 | +| audioAlbum | string | 是 | 否 | 音频相册 | +| width | number | 是 | 否 | 图片宽度 | +| height | number | 是 | 否 | 图片高度 | +| orientation | number | 是 | 是 | 图片方向 | +| duration | number | 是 | 否 | 持续时间 | +| albumId | number | 是 | 否 | 相册编号 | +| albumUri | string | 是 | 否 | 相册uri | +| albumName | string | 是 | 否 | 相册名称 | + +Album +--------- +实体相册。 + +**属性** + +| 名称 | 参数型 | 可读 | 可写 | 说明 | +| ------------ | ------ | ---- | ---- | -------------- | +| albumId | number | 是 | 否 | 相册ID | +| albumName | string | 是 | 是 | 相册名 | +| albumUri | string | 是 | 否 | 相册Uri | +| dateModified | number | 是 | 否 | 修改日期 | +| count | number | 是 | 否 | 相册中文件数量 | +| relativePath | string | 是 | 否 | 相对路径 | +| coverUri | string | 是 | 否 | 封面文件Uri | + +SmartAlbum +--------- + +智能相册 + +**属性：** + +| 名称 | 参数型 | 可读 | 可写 | 说明 | +| ------------- | ------ | ---- | ---- | ------------- | +| albumName | string | 是 | 是 | 相册名。 | +| albumUri | string | 是 | 否 | 相册目录。 | +| albumTag | string | 是 | 是 | 相册标签。 | +| albumCapacity | number | 是 | 否 | 相册容量。 | +| categoryId | number | 是 | 否 | 相册分类ID。 | +| categoryName | strign | 是 | 否 | 相册分类名。 | +| coverUri | string | 是 | 否 | 封面文件uri。 | + + + +MediaType +--------- + +枚举，媒体类型。 + +| 名称 | 默认值 | 描述 | +| ----- | ------ | ------ | +| FILE | 0 | 文件。 | +| IMAGE | 1 | 图片。 | +| VIDEO | 2 | 视频。 | +| AUDIO | 3 | 音频。 | + +FileKey +------- + +枚举，文件关键信息。 + +| 名称 | 默认值 | 可读 | 可写 | 描述 | +| ------------- | ------------------- | ---- | ---- | -------------------- | +| ID | file_id | 是 | 否 | 文件编号。 | +| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径。 | +| DISPLAY_NAME | display_name | 是 | 是 | 显示名字。 | +| PARENT | parent | 是 | 否 | 父目录。 | +| MIME_TYPE | mime_type | 是 | 否 | 该资源的媒体类型。 | +| MEDIA_TYPE | media_type | 是 | 否 | 媒体类型。 | +| SIZE | size | 是 | 否 | 文件大小。 | +| DATE_ADDED | date_added | 是 | 否 | 添加日期。 | +| DATE_MODIFIED | date_modified | 是 | 否 | 修改日期。 | +| DATE_TAKEN | date_taken | 是 | 否 | 表示拍摄日期 | +| TITLE | title | 是 | 是 | 表示标题 | +| ARTIST | artist | 是 | 否 | 创建者。 | +| AUDIOALBUM | audio_album | 是 | 否 | 表示音频相册。 | +| DURATION | duration | 是 | 否 | 表示媒体文件时长 | +| WIDTH | width | 是 | 否 | 表示图片宽。 | +| HEIGHT | height | 是 | 否 | 表示图片高。 | +| ORIENTATION | orientation | 是 | 否 | 图片显示方向。 | +| ALBUM_ID | bucket_id | 是 | 否 | 媒体文件所在相册ID。 | +| ALBUM_NAME | bucket_display_name | 是 | 否 | 媒体文件所在相册名。 | + +DirectoryType +------------- + +枚举，目录类型。 + +| 名称 | 默认值 | 描述 | +| ---------------------- | ------ | ------------------ | +| DIR_CDSA | 0 | 表示CDSA规范路径。 | +| DIR_VIDEO | 1 | 表示视频路径。 | +| DIR_IMAGE | 2 | 表示图片路径。 | +| DIR_AUDIO | 3 | 表示音频路径。 | +| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径。 | +| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径。 | +| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径。 | +| DIR_DOCUMENTS | 7 | 表示文档路径。 | +| DIR_DOWNLOAD | 8 | 表示下载路径。 | +| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径。 | + +PrivateAlbumType +----------------- + +枚举，智能相册类型。 + +| 名称 | 默认值 | 描述 | +| ------------- | ------ | -------------------- | +| TYPE_FAVORITE | 0 | 表示收藏文件类型。 | +| TYPE_TRASH | 1 | 表示回收站文件类型。 | + +DeviceType +----------- + +枚举，设备类型。 + +| 名称 | 默认值 | 描述 | +| ------------ | ------ | ------------ | +| TYPE_UNKNOWN | 0 | 未识别设备。 | +| TYPE_LAPTOP | 1 | 笔记本电脑。 | +| TYPE_PHONE | 2 | 手机。 | +| TYPE_TABLET | 3 | 平板电脑。 | +| TYPE_WATCH | 4 | 智能手表。 | +| TYPE_CAR | 5 | 车载设备。 | +| TYPE_TV | 6 | 电视设备。 | + +## MediaFetchOptions + +检索条件。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------- | ------------- | ---- | ---- | ---------------- | +| selections | string | 是 | 是 | 检索条件 | +| selectionArgs | Array | 是 | 是 | 检索条件的值 | +| order | string | 是 | 是 | 检索结果排序方式 | +| uri | string | 是 | 是 | 文件URI | +| networkId | string | 是 | 是 | 对端设备网络ID | +| extendArgs | string | 是 | 是 | 扩展的检索参数 | + + + +## PeerInfo + +对端设备信息。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------- | ---------- | ---- | ---- | -------------- | +| deviceName | string | 是 | 否 | 设备名称 | +| networkId | string | 是 | 否 | 对端设备网络ID | +| deviceType | DeviceType | 是 | 否 | 设备类型 | +| isOnline | boolean | 是 | 否 | 是否在线 | + + + +## Size + +图片尺寸。 + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------ | ------ | ---- | ---- | ---- | +| width | number | 是 | 是 | 宽 | +| height | number | 是 | 是 | 高 | -- Gitee From f460308844cb471b0a9a1da258e6282043d15044 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 28 Feb 2022 19:20:17 +0800 Subject: [PATCH 02/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 101 ++++++++++++++---- 1 file changed, 79 insertions(+), 22 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 26e3b530eaf..a0f63fb29de 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -83,12 +83,16 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; **示例：** ``` -let fetchFileResult = await medialibrary.getFileAssets(fileNoArgsfetchOp); +medialibrary.getFileAssets(fileNoArgsfetchOp).then(function(fetchFileResult){ + console.info("getFileAssets successfully:"+ JSON.stringify(dir)); +}).catch(function(err){ + console.info("getFileAssets failed with error:"+ err); +}); ``` ## medialibrary.on -on(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback: () => {}): void; +on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; 打开媒体文件变更和上线通知，使用callback方式返回异步结果。 @@ -97,18 +101,18 @@ on(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | | type | type | 是 | 媒体类型。 | -| callback | AsyncCallback<void> | 是 | 回调返回空。 | +| callback | callback<void> | 是 | 回调返回空。 | **示例：** ``` -medialibrary.on(['image','video','audio'], () => { +medialibrary.on('imageChange', () => { this.sendNotify('image'); }) ``` ## medialibrary.off -off(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote file', callback?: () => {}): void; +off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; 关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 @@ -117,12 +121,12 @@ off(type: 'Device'|'Album'| 'SmartAlbum'|'Image'|'Audio'|'Video'|'File'| 'Remote | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | | type | type | 是 | 媒体类型。 | -| callback | AsyncCallback<void> | 是 | 回调返回空。 | +| callback | callback<void> | 是 | 回调返回空。 | **示例：** ``` -medialibrary.off(['image','video','audio'], () => { +medialibrary.off('imageChange', () => { this.sendNotify('image'); }) ``` @@ -173,7 +177,11 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr **示例：** ``` -asset = await medialibrary.createAsset(mediaType, "image01.jpg", path); +medialibrary.createAsset(mediaType, "image01.jpg", path).then(function(asset){ + console.info("createAsset successfully:"+ JSON.stringify(asset)); +}).catch(function(err){ + console.info("createAsset failed with error:"+ err); +}); ``` ## medialibrary.deleteAsset @@ -218,7 +226,11 @@ deleteAsset(uri: string): Promise<void>; **示例：** ``` -await medialibrary.deleteAsset(asset.uri); +medialibrary.deleteAsset(asset.uri).then(()=>{ + console.info("deleteAsset successfully"); +}).catch(function(err){ + console.info("deleteAsset failed with error:"+ err); +}); ``` ## medialibrary.getAlbums @@ -261,7 +273,11 @@ getAlbums(options: MediaFetchOptions): Promise; **示例：** ``` -let albumList = await medialibrary.getAlbums(AlbumNoArgsfetchOp); +medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ + console.info("getAlbums successfully:"+ JSON.stringify(albumList)); +}).catch(function(err){ + console.info("getAlbums failed with error:"+ err); +}); ``` ## medialibrary.getActivePeers @@ -417,7 +433,11 @@ isDirectory():Promise<boolean>; **示例：** ``` -let isDirectory = await asset.isDirectory(); +asset.isDirectory().then(function(isDirectory){ + console.info("isDirectory result:"+ isDirectory); +}).catch(function(err){ + console.info("isDirectory failed with error:"+ err); +}); ``` ## FileAsset.commitModify @@ -435,7 +455,9 @@ commitModify(callback: AsyncCallback<void>): void; **示例：** ``` -await asset.commitModify(); +asset.commitModify(function(err){ + // do something +}); ``` ## FileAsset.commitModify @@ -634,7 +656,9 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; **示例：** ``` -await asset.favorite(true); +asset.favorite(true,function(err){ + // do something +}); ``` ## FileAsset.favorite @@ -658,7 +682,11 @@ favorite(isFavorite: boolean): Promise<void>; **示例：** ``` -await asset.favorite(true); +asset.favorite(true).then(function() { + console.info("favorite successfully"); +}).catch(function(err){ + console.info("favorite failed with error:"+ err); +}); ``` ## FileAsset.isFavorite @@ -696,7 +724,11 @@ isFavorite():Promise<boolean>; **示例：** ``` -let isFavorite = await asset.isFavorite(); +asset.isFavorite().then(function(isFavorite){ + console.info("isFavorite result:"+ isFavorite); +}).catch(function(err){ + console.info("isFavorite failed with error:"+ err); +}); ``` ## FileAsset.trash @@ -741,7 +773,11 @@ trash(isTrash: boolean,): Promise<void>; **示例：** ``` -await asset.trash(true); +asset.trash(true).then(function() { + console.info("trash successfully"); +}).catch(function(err){ + console.info("trash failed with error:"+ err); +}); ``` ## FileAsset.isTrash @@ -779,7 +815,11 @@ isTrash():Promise<boolean>; **示例：** ``` -let isTrash = await asset.isTrash(); +asset.isTrash().then(function(isTrash){ + console.info("isTrash result:"+ isTrash); +}).catch(function(err){ + console.info("isTrash failed with error:"+ err); +}); ``` **FetchFileResult** @@ -874,8 +914,11 @@ getFirstObject(): Promise<FileAsset>; **示例**： ``` -const fileAsset = await queryResultSet_.getFirstObject(); -}) +queryResultSet_.getFirstObject().then(function(fileAsset){ + console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset)); +}).catch(function(err){ + console.info("getFirstObject failed with error:"+ err); +}); ``` ## FetchFileResult.getNextObject @@ -1106,7 +1149,11 @@ commitModify(): Promise<void>; ``` album.albumName = 'hello'; -await album.commitModify(); +album.commitModify().then(function() { + console.info("commitModify successfully"); +}).catch(function(err){ + console.info("commitModify failed with error:"+ err); +}); ``` ## Album.getFileAssets @@ -1153,7 +1200,11 @@ function getFileAssetsCallBack(err, fetchFileResult) { **示例**： ``` -let albumFetchFileResult = await album.getFileAssets(fileNoArgsfetchOp); +album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ + console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); +}).catch(function(err){ + console.info("getFileAssets failed with error:"+ err); +}); ``` @@ -1196,7 +1247,11 @@ getFileAssets(): Promise<FetchFileResult>; **示例**： ``` - let fSmartFetchFileResult = await favSmartAlbum.getFileAssets(); +favSmartAlbum.getFileAssets().then(function(fSmartFetchFileResult){ + console.info("getFileAssets successfully:"+ JSON.stringify(fSmartFetchFileResult)); +}).catch(function(err){ + console.info("getFileAssets failed with error:"+ err); +}); ``` @@ -1383,3 +1438,5 @@ DeviceType | ------ | ------ | ---- | ---- | ---- | | width | number | 是 | 是 | 宽 | | height | number | 是 | 是 | 高 | + + -- Gitee From 041cd9fe4dd89833c1a28351c49a2f5e3102cbf2 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 28 Feb 2022 20:32:09 +0800 Subject: [PATCH 03/25] fix code issue Signed-off-by: panqiangbiao --- .../application-dev/reference/apis/js-apis-medialibrary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 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 a0f63fb29de..fefa0009c91 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -92,7 +92,7 @@ medialibrary.getFileAssets(fileNoArgsfetchOp).then(function(fetchFileResult){ ## medialibrary.on -on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; +on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; 打开媒体文件变更和上线通知，使用callback方式返回异步结果。 @@ -112,7 +112,7 @@ medialibrary.on('imageChange', () => { ``` ## medialibrary.off -off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; +off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void; 关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 @@ -121,7 +121,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | | type | type | 是 | 媒体类型。 | -| callback | callback<void> | 是 | 回调返回空。 | +| callback | callback<void> | 否 | 回调返回空。 | **示例：** -- Gitee From 1b65d5352a9d5616f6294e7f987e69001334c53f Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 1 Mar 2022 14:15:22 +0800 Subject: [PATCH 04/25] add permission Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 604 +++++++++++------- 1 file changed, 359 insertions(+), 245 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 fefa0009c91..8f7785f12ae 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -8,13 +8,6 @@ import medialibrary from '@ohos.multimedia.medialibrary'; ``` -权限 ----- - -- ohos.permission.MEDIA_LOCATION -- ohos.permission.MEDIA_READ -- ohos.permission.MEDIA_WRITE - ## getMediaLibrary --------------- @@ -23,6 +16,10 @@ function getMediaLibrary(context: Context): MediaLibrary; 获取媒体库。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -48,12 +45,16 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 获取文件资源，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- | -| options | MediaFetchOptions | 是 | 媒体获取选项。 | -| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步获取FetchFileResult之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | --------------------------------- | +| options | MediaFetchOptions | 是 | 媒体获取选项 | +| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步获取FetchFileResult之后的回调 | **示例：** @@ -68,17 +69,21 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; 获取文件资源，使用Promise方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | -------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项 | **返回值** -| 类型 | 说明 | -| -------------------------------------------- | ---------------- | -| [FetchFileResult](#FetchFileResult.getCount) | 媒体数据结果集。 | +| 类型 | 说明 | +| -------------------------------------------- | -------------- | +| [FetchFileResult](#FetchFileResult.getCount) | 媒体数据结果集 | **示例：** @@ -96,12 +101,16 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| 打开媒体文件变更和上线通知，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型。 | -| callback | callback<void> | 是 | 回调返回空。 | +| type | type | 是 | 媒体类型 | +| callback | callback<void> | 是 | 回调返回空 | **示例：** @@ -116,12 +125,16 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' 关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型。 | -| callback | callback<void> | 否 | 回调返回空。 | +| type | type | 是 | 媒体类型 | +| callback | callback<void> | 否 | 回调返回空 | **示例：** @@ -137,14 +150,18 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | -------------------------------------- | ---- | ------------------------------------- | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型。 | -| displayName | string | 是 | 展示文件名。 | -| relativePath | string | 是 | 相对路径。 | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | -------------------------------------- | ---- | ----------------------------------- | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对路径 | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** @@ -160,13 +177,17 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ----------------------- | ---- | ------------ | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型。 | -| displayName | string | 是 | 展示文件名。 | -| relativePath | string | 是 | 相对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ----------------------- | ---- | ---------- | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对路径 | **返回值** @@ -190,12 +211,16 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; 删除媒体资源，使用callback方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------- | ---- | ---------------------- | -| uri | string | 是 | 文件uri。 | -| callback | AsyncCallback<void> | 是 | 回调返回空。 | +| uri | string | 是 | 文件uri | +| callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -211,17 +236,21 @@ deleteAsset(uri: string): Promise<void>; 删除媒体资源，使用promise方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | --------- | -| uri | string | 是 | 文件uri。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------- | +| uri | string | 是 | 文件uri | **返回值：** | 类型 | 说明 | | ------------- | ------------------------------------------------- | -| Promise<void> | Promise实例，用于异步获取结果。本调用将返回空值。 | +| Promise<void> | Promise实例，用于异步获取结果。本调用将返回空值 | **示例：** @@ -239,12 +268,16 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback> | 是 | 异步获取Album列表之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------------------- | ---- | --------------------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件 | +| callback | AsyncCallback<Array<[Album](#Album)>> | 是 | 异步获取Album列表之后的回调 | **示例：** @@ -258,11 +291,15 @@ getAlbums(options: MediaFetchOptions): Promise; 获取实体相册，使用 promise 方式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------------------ | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ---------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件 | **返回值：** @@ -286,11 +323,15 @@ getActivePeers(callback: AsyncCallback): void; 获取活动对端设备 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback> | 是 | 回调表示成功还是失败。 | +| callback | AsyncCallback> | 是 | 回调表示成功还是失败 | **示例：** @@ -306,13 +347,17 @@ getActivePeers(): Promise; 获取活动对端设备 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore + **参数：** 返回值： -| 类型 | 说明 | -| ------------------------------------- | ----------------------------------- | -| Promise> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------------------------- | --------------------------------- | +| Promise> | Promise实例，用于获取异步返回结果 | **示例：** @@ -326,11 +371,15 @@ getAllPeers(callback: AsyncCallback): void; 获取所有对端设备 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback> | 是 | 回调表示成功还是失败。 | +| callback | AsyncCallback> | 是 | 回调表示成功还是失败 | **示例：** @@ -346,11 +395,15 @@ getAllPeers(): Promise; 获取所有对端设备 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore + **返回值：** -| 类型 | 说明 | -| ------------------------------------- | ----------------------------------- | -| Promise> | Promise实例，用于获取异步返回结果。 | +| 类型 | 说明 | +| ------------------------------------- | --------------------------------- | +| Promise> | Promise实例，用于获取异步返回结果 | **示例：** @@ -362,11 +415,15 @@ release(callback: AsyncCallback<void>): void; 释放MediaLibrary实例 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------- | ---- | ---------------------- | -| callback | AsyncCallback<void> | 是 | 回调表示成功还是失败。 | +| callback | AsyncCallback<void> | 是 | 回调表示成功还是失败 | **示例：** @@ -382,11 +439,15 @@ release(): Promise<void>; 释放MediaLibrary实例 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值：** | 类型 | 说明 | | ------------- | ----------------------------------- | -| Promise<void> | Promise实例，用于获取异步返回结果。 | +| Promise<void> | Promise实例，用于获取异步返回结果 | **示例：** @@ -404,6 +465,10 @@ isDirectory(callback: AsyncCallback<boolean>): void; 判断fileAsset是否为目录，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -424,11 +489,15 @@ isDirectory():Promise<boolean>; 判断fileAsset是否为目录，使用Promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值：** | 类型 | 说明 | | ---------------- | ------------------------------------------ | -| Promise<boolean> | Promise实例，返回当前FileAsset是否是目录。 | +| Promise<boolean> | Promise实例，返回当前FileAsset是否是目录 | **示例：** @@ -446,6 +515,10 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -466,11 +539,15 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值：** | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<void> | Promise返回空。 | +| Promise<void> | Promise返回空 | **示例：** @@ -488,11 +565,15 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| mode | string | 是 | 打开文件方式 | +| mode | string | 是 | 打开文件方式 | | callback | AsyncCallback<number> | 是 | 回调返回文件句柄 | **示例：** @@ -509,6 +590,10 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -519,7 +604,7 @@ open(mode: string): Promise<number>; | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<number> | Promise返回文件句柄。 | +| Promise<number> | Promise返回文件句柄 | **示例：** @@ -535,11 +620,15 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| fd | number | 是 | 文件描述符 | +| fd | number | 是 | 文件描述符 | | callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -556,6 +645,10 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -566,7 +659,7 @@ close(fd: number): Promise<void>; | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<void> | Promise返回空。 | +| Promise<void> | Promise返回空 | **示例：** @@ -582,6 +675,10 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -601,11 +698,15 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| size | [Size](#Size) | 是 | 缩略图尺寸 | +| size | [Size](#Size) | 是 | 缩略图尺寸 | | callback | AsyncCallback<image.PixelMap> | 是 | 回调返回缩略图的PixelMap | **示例：** @@ -621,6 +722,10 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -631,7 +736,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<image.PixelMap> | Promise返回缩略图的PixelMap。 | +| Promise<image.PixelMap> | Promise返回缩略图的PixelMap | **示例：** @@ -646,12 +751,16 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------- | ---- | -------------- | | isFavorite | boolean | 是 | 是否为收藏文件 | -| callback | AsyncCallback<void> | 是 | 回调返回空 | +| callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -667,6 +776,10 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -677,7 +790,7 @@ favorite(isFavorite: boolean): Promise<void>; | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<void> | Promise返回空。 | +| Promise<void> | Promise返回空 | **示例：** @@ -695,6 +808,10 @@ isFavorite(callback: AsyncCallback<boolean>): void; 判断该文件是否为收藏文件，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -715,11 +832,15 @@ isFavorite():Promise<boolean>; 判断该文件是否为收藏文件，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值：** | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<boolean> | Promise回调表示是否是收藏文件。 | +| Promise<boolean> | Promise回调表示是否是收藏文件 | **示例：** @@ -737,11 +858,15 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| isTrash | boolean | 是 | 是否为收藏文件 | +| isTrash | boolean | 是 | 是否为收藏文件 | | callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -758,6 +883,10 @@ trash(isTrash: boolean,): Promise<void>; 当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -768,7 +897,7 @@ trash(isTrash: boolean,): Promise<void>; | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<void> | Promise返回空。 | +| Promise<void> | Promise返回空 | **示例：** @@ -786,6 +915,10 @@ isTrash(callback: AsyncCallback<boolean>): void; 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数：** | 参数名 | 类型 | 必填 | 说明 | @@ -806,11 +939,15 @@ isTrash():Promise<boolean>; 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值：** | 类型 | 说明 | | ------------- | ----------------------------- | -| Promise<void> | Promise回调表示文件是否为垃圾文件。 | +| Promise<void> | Promise回调表示文件是否为垃圾文件 | **示例：** @@ -832,11 +969,15 @@ getCount(): number; 获取文件检索结果中的文件总数。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： -| 类型 | 说明 | -| ------ | ------------------ | -| number | 检索到的文件总数。 | +| 类型 | 说明 | +| ------ | ---------------- | +| number | 检索到的文件总数 | **示例**： @@ -850,11 +991,15 @@ isAfterLast(): boolean; 检查结果集是否指向最后一行。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： | 类型 | 说明 | | ------- | ------------------------------------------------------------ | -| boolean | 当读到最后一条记录后，再继续读就到结果集尾了，没有记录了，执行isAfterLast()方法就返回true，否则返回false。 | +| boolean | 当读到最后一条记录后，再继续读就到结果集尾了，没有记录了，执行isAfterLast()方法就返回true，否则返回false | **示例**： @@ -868,6 +1013,10 @@ close(): void; 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **示例**： ``` @@ -880,11 +1029,15 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | --------------------------------------------- | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | ------------------------------------------- | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | **示例**： @@ -904,11 +1057,15 @@ getFirstObject(): Promise<FileAsset>; 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： | 类型 | 说明 | | ------------------ | -------------------------------------- | -| Promise<[FileAsset](#FileAsset)> | Promise方式返回FileAsset | +| Promise<[FileAsset](#FileAsset)> | Promise方式返回FileAsset | **示例**： @@ -927,11 +1084,15 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| --------- | -------------------------------------- | ---- | ------------------------------------------- | -| callbacke | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回结果集中下一个FileAsset之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | -------------------------------------------- | ---- | ----------------------------------------- | +| callbacke | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回结果集中下一个FileAsset之后的回调 | **示例**： @@ -951,11 +1112,15 @@ data.getNextObject((err, value) => { 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | **示例**： @@ -969,11 +1134,15 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | ----------------------------- | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调。 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------- | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -995,11 +1164,15 @@ getLastObject(): Promise<FileAsset>; 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | **示例**： @@ -1013,12 +1186,16 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------- | ---- | ----------------------------- | -| index | number | 是 | 要获取的文件的索引。 | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调。 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------- | +| index | number | 是 | 要获取的文件的索引 | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1038,17 +1215,21 @@ getPositionObject(index: number): Promise<FileAsset>; 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： | 参数 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | -------------------- | -| index | number | 是 | 要获取的文件在结果集中的位置。 | +| index | number | 是 | 要获取的文件在结果集中的位置 | **返回值**： | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象。 | +| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | **示例**： @@ -1068,11 +1249,15 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------- | ---- | --------------------------------- | -| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调。 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | ------------------------------- | +| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调 | **示例**： @@ -1092,11 +1277,15 @@ getAllObject(): Promise<Array<FileAsset>>; 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： -| 类型 | 说明 | -| --------------------------------------- | ----------------------- | -| Promise> | 返回FileAsset对象列表。 | +| 类型 | 说明 | +| --------------------------------------- | --------------------- | +| Promise> | 返回FileAsset对象列表 | **示例**： @@ -1114,11 +1303,15 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： | 参数 | 类型 | 必填 | 说明 | | -------- | ------------------- | ---- | ----------------------------- | -| callback | AsyncCallback<void> | 是 | 回调返回空 | +| callback | AsyncCallback<void> | 是 | 回调返回空 | **示例**： @@ -1139,6 +1332,10 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **返回值**： | 类型 | 说明 | @@ -1162,12 +1359,16 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE + +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core + **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | ----------------------------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项。 | -| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调。 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | ----------------------------------------------------------- | ---- | --------------------------------- | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项 | +| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调 | **示例**： @@ -1185,58 +1386,15 @@ function getFileAssetsCallBack(err, fetchFileResult) { 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 -**参数**： +**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -| 参数 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | -------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 否 | 媒体检索选项。 | - -**返回值**： - -| 类型 | 说明 | -| ----------------------------------------------------- | ------------------------- | -| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象。 | - -**示例**： - -``` -album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ - console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); -}).catch(function(err){ - console.info("getFileAssets failed with error:"+ err); -}); -``` - - - - - -## SmartAlbum.getFileAssets - -getFileAssets(callback: AsyncCallback<FetchFileResult>): void; - -获取智能相册中的文件资源 +**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core **参数**： -| 参数 | 类型 | 必填 | 说明 | -| ------- | ----------------- | ---- | -------------- | -| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调。 | - -**示例**： - -``` -favSmartAlbum.getFileAssets(getFileAssetsCallBack); -function getFileAssetsCallBack(err, fSmartFetchFileResult) { - // do something - } -``` - -## SmartAlbum.getFileAssets - -getFileAssets(): Promise<FetchFileResult>; - -获取智能相册中的文件资源 +| 参数 | 类型 | 必填 | 说明 | +| ------- | --------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#MediaFetchOptions) | 否 | 媒体检索选项 | **返回值**： @@ -1247,8 +1405,8 @@ getFileAssets(): Promise<FetchFileResult>; **示例**： ``` -favSmartAlbum.getFileAssets().then(function(fSmartFetchFileResult){ - console.info("getFileAssets successfully:"+ JSON.stringify(fSmartFetchFileResult)); +album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ + console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); }).catch(function(err){ console.info("getFileAssets failed with error:"+ err); }); @@ -1287,6 +1445,7 @@ FileAsset Album --------- + 实体相册。 **属性** @@ -1301,106 +1460,77 @@ Album | relativePath | string | 是 | 否 | 相对路径 | | coverUri | string | 是 | 否 | 封面文件Uri | -SmartAlbum ---------- - -智能相册 - -**属性：** - -| 名称 | 参数型 | 可读 | 可写 | 说明 | -| ------------- | ------ | ---- | ---- | ------------- | -| albumName | string | 是 | 是 | 相册名。 | -| albumUri | string | 是 | 否 | 相册目录。 | -| albumTag | string | 是 | 是 | 相册标签。 | -| albumCapacity | number | 是 | 否 | 相册容量。 | -| categoryId | number | 是 | 否 | 相册分类ID。 | -| categoryName | strign | 是 | 否 | 相册分类名。 | -| coverUri | string | 是 | 否 | 封面文件uri。 | - - - MediaType --------- 枚举，媒体类型。 -| 名称 | 默认值 | 描述 | -| ----- | ------ | ------ | -| FILE | 0 | 文件。 | -| IMAGE | 1 | 图片。 | -| VIDEO | 2 | 视频。 | -| AUDIO | 3 | 音频。 | +| 名称 | 默认值 | 描述 | +| ----- | ------ | ---- | +| FILE | 0 | 文件 | +| IMAGE | 1 | 图片 | +| VIDEO | 2 | 视频 | +| AUDIO | 3 | 音频 | FileKey ------- 枚举，文件关键信息。 -| 名称 | 默认值 | 可读 | 可写 | 描述 | -| ------------- | ------------------- | ---- | ---- | -------------------- | -| ID | file_id | 是 | 否 | 文件编号。 | -| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径。 | -| DISPLAY_NAME | display_name | 是 | 是 | 显示名字。 | -| PARENT | parent | 是 | 否 | 父目录。 | -| MIME_TYPE | mime_type | 是 | 否 | 该资源的媒体类型。 | -| MEDIA_TYPE | media_type | 是 | 否 | 媒体类型。 | -| SIZE | size | 是 | 否 | 文件大小。 | -| DATE_ADDED | date_added | 是 | 否 | 添加日期。 | -| DATE_MODIFIED | date_modified | 是 | 否 | 修改日期。 | -| DATE_TAKEN | date_taken | 是 | 否 | 表示拍摄日期 | -| TITLE | title | 是 | 是 | 表示标题 | -| ARTIST | artist | 是 | 否 | 创建者。 | -| AUDIOALBUM | audio_album | 是 | 否 | 表示音频相册。 | -| DURATION | duration | 是 | 否 | 表示媒体文件时长 | -| WIDTH | width | 是 | 否 | 表示图片宽。 | -| HEIGHT | height | 是 | 否 | 表示图片高。 | -| ORIENTATION | orientation | 是 | 否 | 图片显示方向。 | -| ALBUM_ID | bucket_id | 是 | 否 | 媒体文件所在相册ID。 | -| ALBUM_NAME | bucket_display_name | 是 | 否 | 媒体文件所在相册名。 | +| 名称 | 默认值 | 可读 | 可写 | 描述 | +| ------------- | ------------------- | ---- | ---- | ------------------ | +| ID | file_id | 是 | 否 | 文件编号 | +| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径 | +| DISPLAY_NAME | display_name | 是 | 是 | 显示名字 | +| PARENT | parent | 是 | 否 | 父目录 | +| MIME_TYPE | mime_type | 是 | 否 | 该资源的媒体类型 | +| MEDIA_TYPE | media_type | 是 | 否 | 媒体类型 | +| SIZE | size | 是 | 否 | 文件大小 | +| DATE_ADDED | date_added | 是 | 否 | 添加日期 | +| DATE_MODIFIED | date_modified | 是 | 否 | 修改日期 | +| DATE_TAKEN | date_taken | 是 | 否 | 表示拍摄日期 | +| TITLE | title | 是 | 是 | 表示标题 | +| ARTIST | artist | 是 | 否 | 创建者 | +| AUDIOALBUM | audio_album | 是 | 否 | 表示音频相册 | +| DURATION | duration | 是 | 否 | 表示媒体文件时长 | +| WIDTH | width | 是 | 否 | 表示图片宽 | +| HEIGHT | height | 是 | 否 | 表示图片高 | +| ORIENTATION | orientation | 是 | 否 | 图片显示方向 | +| ALBUM_ID | bucket_id | 是 | 否 | 媒体文件所在相册ID | +| ALBUM_NAME | bucket_display_name | 是 | 否 | 媒体文件所在相册名 | DirectoryType ------------- 枚举，目录类型。 -| 名称 | 默认值 | 描述 | -| ---------------------- | ------ | ------------------ | -| DIR_CDSA | 0 | 表示CDSA规范路径。 | -| DIR_VIDEO | 1 | 表示视频路径。 | -| DIR_IMAGE | 2 | 表示图片路径。 | -| DIR_AUDIO | 3 | 表示音频路径。 | -| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径。 | -| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径。 | -| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径。 | -| DIR_DOCUMENTS | 7 | 表示文档路径。 | -| DIR_DOWNLOAD | 8 | 表示下载路径。 | -| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径。 | - -PrivateAlbumType ------------------ - -枚举，智能相册类型。 - -| 名称 | 默认值 | 描述 | -| ------------- | ------ | -------------------- | -| TYPE_FAVORITE | 0 | 表示收藏文件类型。 | -| TYPE_TRASH | 1 | 表示回收站文件类型。 | +| 名称 | 默认值 | 描述 | +| ---------------------- | ------ | ---------------- | +| DIR_CDSA | 0 | 表示CDSA规范路径 | +| DIR_VIDEO | 1 | 表示视频路径 | +| DIR_IMAGE | 2 | 表示图片路径 | +| DIR_AUDIO | 3 | 表示音频路径 | +| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径 | +| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径 | +| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径 | +| DIR_DOCUMENTS | 7 | 表示文档路径 | +| DIR_DOWNLOAD | 8 | 表示下载路径 | +| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径 | DeviceType ----------- 枚举，设备类型。 -| 名称 | 默认值 | 描述 | -| ------------ | ------ | ------------ | -| 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 | 电视设备 | ## MediaFetchOptions @@ -1415,21 +1545,6 @@ DeviceType | networkId | string | 是 | 是 | 对端设备网络ID | | extendArgs | string | 是 | 是 | 扩展的检索参数 | - - -## PeerInfo - -对端设备信息。 - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ---------- | ---------- | ---- | ---- | -------------- | -| deviceName | string | 是 | 否 | 设备名称 | -| networkId | string | 是 | 否 | 对端设备网络ID | -| deviceType | DeviceType | 是 | 否 | 设备类型 | -| isOnline | boolean | 是 | 否 | 是否在线 | - - - ## Size 图片尺寸。 @@ -1439,4 +1554,3 @@ DeviceType | width | number | 是 | 是 | 宽 | | height | number | 是 | 是 | 高 | - -- Gitee From 6f73e5365974c924d49a37653fd511fbd9231f42 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 1 Mar 2022 14:40:48 +0800 Subject: [PATCH 05/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 62 ++++++++++--------- 1 file changed, 32 insertions(+), 30 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 8f7785f12ae..83ef26bc388 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -10,7 +10,6 @@ import medialibrary from '@ohos.multimedia.medialibrary'; ## getMediaLibrary ---------------- function getMediaLibrary(context: Context): MediaLibrary; @@ -35,6 +34,8 @@ function getMediaLibrary(context: Context): MediaLibrary; **示例：** ``` +import featureAbility from '@ohos.ability.featureAbility'; +var context = featureAbility.getContext() var media = mediaLibrary.getMediaLibrary(context); ``` @@ -61,7 +62,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe ``` medialibrary.getFileAssets(fetchOp, (error, data) => { // do something - }); +}); ``` ## medialibrary.getFileAssets @@ -168,7 +169,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal ``` medialibrary.createAsset(mediaType, displayName, rp, (createAssetErr, fileObj) => { // do something - }); +}); ``` ## medialibrary.createAsset @@ -227,7 +228,7 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; ``` medialibrary.deleteAsset(fileAsset.uri, (deleteAssetErr, deleteRows) => { // do something - }); +}); ``` ## medialibrary.deleteAsset @@ -338,7 +339,7 @@ getActivePeers(callback: AsyncCallback): void; ``` medialibrary.getActivePeers((err, data) => { // do something - }); +}); ``` ## medialibrary.getActivePeers @@ -386,7 +387,7 @@ getAllPeers(callback: AsyncCallback): void; ``` medialibrary.getAllPeers((err, data) => { // do something - }); +}); ``` ## medialibrary.getAllPeers @@ -430,7 +431,7 @@ release(callback: AsyncCallback<void>): void; ``` medialibrary.release((err, data) => { // do something - }); +}); ``` ## medialibrary.release @@ -455,10 +456,6 @@ release(): Promise<void>; medialibrary.release() ``` - - - - ## FileAsset.isDirectory isDirectory(callback: AsyncCallback<boolean>): void; @@ -480,7 +477,7 @@ isDirectory(callback: AsyncCallback<boolean>): void; ``` asset.isDirectory((err, isDirectory) => { // do something - }); +}); ``` ## FileAsset.isDirectory @@ -555,8 +552,7 @@ commitModify(): Promise<void>; asset.commitModify(commitModifyCallBack); function commitModifyCallBack(err, commitModify) { // do something - - } +} ``` ## FileAsset.open @@ -581,7 +577,7 @@ open(mode: string, callback: AsyncCallback<number>): void; ``` asset.open('Rw').then((openError, fd) => { // do something - } +}); ``` ## FileAsset.open @@ -611,7 +607,7 @@ open(mode: string): Promise<number>; ``` asset.open('Rw').then((openError, fd) => { // do something - } +}); ``` ## FileAsset.close @@ -636,7 +632,7 @@ close(fd: number, callback: AsyncCallback<void>): void; ``` fileAsset.close(fd).then((closeErr) => { // do something - } +}); ``` ## FileAsset.close @@ -666,7 +662,7 @@ close(fd: number): Promise<void>; ``` fileAsset.close(fd).then((closeErr) => { // do something - } +}); ``` ## FileAsset.getThumbnail @@ -688,8 +684,9 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -data1.getThumbnail(size, (err2, pixelmap) => { +data1.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +}); ``` ## FileAsset.getThumbnail @@ -712,8 +709,9 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -data1.getThumbnail(size, (err2, pixelmap) => { +data1.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +}); ``` ## FileAsset.getThumbnail @@ -741,8 +739,9 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; **示例：** ``` -data1.getThumbnail(size, (err2, pixelmap) => { +data1.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); +}); ``` ## FileAsset.favorite @@ -823,7 +822,7 @@ isFavorite(callback: AsyncCallback<boolean>): void; ``` asset.favorite(true, (err) => { // do something - }); +}); ``` ## FileAsset.isFavorite @@ -874,7 +873,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; ``` asset.trash(true, (err) => { // do something - }); +}); ``` ## FileAsset.trash @@ -930,7 +929,7 @@ isTrash(callback: AsyncCallback<boolean>): void; ``` asset.isTrash((err, isTrash) => { // do something - }); +}); ``` ## FileAsset.isTrash @@ -1156,8 +1155,6 @@ data.getLastObject((err, value) => { }) ``` - - ## FetchFileResult.getLastObject getLastObject(): Promise<FileAsset>; @@ -1293,10 +1290,6 @@ getAllObject(): Promise<Array<FileAsset>>; var data = FetchFileResult.getAllObject(); ``` - - - - ## Album.commitModify commitModify(callback: AsyncCallback<void>): void; @@ -1412,7 +1405,16 @@ album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ }); ``` +## PeerInfo + +对端设备信息。 +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------- | ---------- | ---- | ---- | -------------- | +| deviceName | string | 是 | 否 | 设备名称 | +| networkId | string | 是 | 否 | 对端设备网络ID | +| deviceType | DeviceType | 是 | 否 | 设备类型 | +| isOnline | boolean | 是 | 否 | 是否在线 | FileAsset --------- -- Gitee From da23944e9a63c626bb1cf0d2d336236e9d546084 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 1 Mar 2022 14:44:56 +0800 Subject: [PATCH 06/25] fix issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 212 +++++++++--------- 1 file changed, 106 insertions(+), 106 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 83ef26bc388..5d0c4daf331 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -15,9 +15,9 @@ function getMediaLibrary(context: Context): MediaLibrary; 获取媒体库。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -46,9 +46,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 获取文件资源，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -70,9 +70,9 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; 获取文件资源，使用Promise方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -102,9 +102,9 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| 打开媒体文件变更和上线通知，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -126,9 +126,9 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' 关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -151,9 +151,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -178,9 +178,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -212,9 +212,9 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; 删除媒体资源，使用callback方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -237,9 +237,9 @@ deleteAsset(uri: string): Promise<void>; 删除媒体资源，使用promise方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -269,9 +269,9 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback; 获取实体相册，使用 promise 方式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -324,9 +324,9 @@ getActivePeers(callback: AsyncCallback): void; 获取活动对端设备 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore +**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore **参数：** @@ -348,9 +348,9 @@ getActivePeers(): Promise; 获取活动对端设备 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore +**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore **参数：** @@ -372,9 +372,9 @@ getAllPeers(callback: AsyncCallback): void; 获取所有对端设备 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore +**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore **参数：** @@ -396,9 +396,9 @@ getAllPeers(): Promise; 获取所有对端设备 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.DistributedCore +**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore **返回值：** @@ -416,9 +416,9 @@ release(callback: AsyncCallback<void>): void; 释放MediaLibrary实例 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -440,9 +440,9 @@ release(): Promise<void>; 释放MediaLibrary实例 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值：** @@ -462,9 +462,9 @@ isDirectory(callback: AsyncCallback<boolean>): void; 判断fileAsset是否为目录，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -486,9 +486,9 @@ isDirectory():Promise<boolean>; 判断fileAsset是否为目录，使用Promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值：** @@ -512,9 +512,9 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -536,9 +536,9 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值：** @@ -561,9 +561,9 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数** @@ -586,9 +586,9 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -616,9 +616,9 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -641,9 +641,9 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -671,9 +671,9 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -695,9 +695,9 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -720,9 +720,9 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -750,9 +750,9 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -775,9 +775,9 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -807,9 +807,9 @@ isFavorite(callback: AsyncCallback<boolean>): void; 判断该文件是否为收藏文件，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -831,9 +831,9 @@ isFavorite():Promise<boolean>; 判断该文件是否为收藏文件，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值：** @@ -857,9 +857,9 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -882,9 +882,9 @@ trash(isTrash: boolean,): Promise<void>; 当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -914,9 +914,9 @@ isTrash(callback: AsyncCallback<boolean>): void; 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -938,9 +938,9 @@ isTrash():Promise<boolean>; 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值：** @@ -968,9 +968,9 @@ getCount(): number; 获取文件检索结果中的文件总数。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -990,9 +990,9 @@ isAfterLast(): boolean; 检查结果集是否指向最后一行。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1012,9 +1012,9 @@ close(): void; 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **示例**： @@ -1028,9 +1028,9 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1056,9 +1056,9 @@ getFirstObject(): Promise<FileAsset>; 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1083,9 +1083,9 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1111,9 +1111,9 @@ data.getNextObject((err, value) => { 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1133,9 +1133,9 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1161,9 +1161,9 @@ getLastObject(): Promise<FileAsset>; 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1183,9 +1183,9 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1212,9 +1212,9 @@ getPositionObject(index: number): Promise<FileAsset>; 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1246,9 +1246,9 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1274,9 +1274,9 @@ getAllObject(): Promise<Array<FileAsset>>; 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1296,9 +1296,9 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1325,9 +1325,9 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1352,9 +1352,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： @@ -1379,9 +1379,9 @@ function getFileAssetsCallBack(err, fetchFileResult) { 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 -**需要权限：**ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE -**系统能力：**SystemCapability.Multimedia.MediaLibrary.Core +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： -- Gitee From e984e9c976a0859ab7334029eaae5e266ba1facd Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 1 Mar 2022 14:56:37 +0800 Subject: [PATCH 07/25] add permission Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 106 +++++++++--------- 1 file changed, 53 insertions(+), 53 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 5d0c4daf331..bc2cd94d4d1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -15,7 +15,7 @@ function getMediaLibrary(context: Context): MediaLibrary; 获取媒体库。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -46,7 +46,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 获取文件资源，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -70,7 +70,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; 获取文件资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -102,7 +102,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| 打开媒体文件变更和上线通知，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -126,7 +126,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' 关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -151,7 +151,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -178,7 +178,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -212,7 +212,7 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; 删除媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -237,7 +237,7 @@ deleteAsset(uri: string): Promise<void>; 删除媒体资源，使用promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -269,7 +269,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback; 获取实体相册，使用 promise 方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -324,7 +324,7 @@ getActivePeers(callback: AsyncCallback): void; 获取活动对端设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -348,7 +348,7 @@ getActivePeers(): Promise; 获取活动对端设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -372,7 +372,7 @@ getAllPeers(callback: AsyncCallback): void; 获取所有对端设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -396,7 +396,7 @@ getAllPeers(): Promise; 获取所有对端设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -416,7 +416,7 @@ release(callback: AsyncCallback<void>): void; 释放MediaLibrary实例 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -440,7 +440,7 @@ release(): Promise<void>; 释放MediaLibrary实例 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -462,7 +462,7 @@ isDirectory(callback: AsyncCallback<boolean>): void; 判断fileAsset是否为目录，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -486,7 +486,7 @@ isDirectory():Promise<boolean>; 判断fileAsset是否为目录，使用Promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -512,7 +512,7 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -536,7 +536,7 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -561,7 +561,7 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -586,7 +586,7 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -616,7 +616,7 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -641,7 +641,7 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -671,7 +671,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -695,7 +695,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -720,7 +720,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -750,7 +750,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -775,7 +775,7 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -807,7 +807,7 @@ isFavorite(callback: AsyncCallback<boolean>): void; 判断该文件是否为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -831,7 +831,7 @@ isFavorite():Promise<boolean>; 判断该文件是否为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -857,7 +857,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -882,7 +882,7 @@ trash(isTrash: boolean,): Promise<void>; 当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -914,7 +914,7 @@ isTrash(callback: AsyncCallback<boolean>): void; 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -938,7 +938,7 @@ isTrash():Promise<boolean>; 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -968,7 +968,7 @@ getCount(): number; 获取文件检索结果中的文件总数。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -990,7 +990,7 @@ isAfterLast(): boolean; 检查结果集是否指向最后一行。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1012,7 +1012,7 @@ close(): void; 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1028,7 +1028,7 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1056,7 +1056,7 @@ getFirstObject(): Promise<FileAsset>; 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1083,7 +1083,7 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1111,7 +1111,7 @@ data.getNextObject((err, value) => { 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1133,7 +1133,7 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1161,7 +1161,7 @@ getLastObject(): Promise<FileAsset>; 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1183,7 +1183,7 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1212,7 +1212,7 @@ getPositionObject(index: number): Promise<FileAsset>; 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1246,7 +1246,7 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1274,7 +1274,7 @@ getAllObject(): Promise<Array<FileAsset>>; 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1296,7 +1296,7 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1325,7 +1325,7 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1352,7 +1352,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1379,7 +1379,7 @@ function getFileAssetsCallBack(err, fetchFileResult) { 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core -- Gitee From f1c07219635e8099fd307afc46c0e0b6611c0b40 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Wed, 2 Mar 2022 16:46:17 +0800 Subject: [PATCH 08/25] add more example Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 585 ++++++++++++------ 1 file changed, 393 insertions(+), 192 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 bc2cd94d4d1..e0b9562cf39 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -15,7 +15,7 @@ function getMediaLibrary(context: Context): MediaLibrary; 获取媒体库。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -23,7 +23,7 @@ function getMediaLibrary(context: Context): MediaLibrary; | 参数名 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | -------------------- | -| context | Context | 是 | API 8接口此参数是必填参数，传入context，获取媒体库 | +| context | Context | 是 | API 8接口此参数是必填参数，传入Ability实例的context，获取媒体库 | **返回值：** @@ -46,7 +46,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 获取文件资源，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -54,14 +54,27 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe | 参数名 | 类型 | 必填 | 说明 | | -------- | ----------------------------------------------------------- | ---- | --------------------------------- | -| options | MediaFetchOptions | 是 | 媒体获取选项 | +| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体获取选项 | | callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步获取FetchFileResult之后的回调 | **示例：** ``` -medialibrary.getFileAssets(fetchOp, (error, data) => { - // do something +let fileKeyObj = mediaLibrary.FileKey +let imageType = mediaLibrary.MediaType.IMAGE +let imagesfetchOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], +}; +medialibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { + if (fetchFileResult != undefined) { + console.info('MediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); + fetchFileResult.getAllObject((err, fileAssetList) => { + if (fileAssetList != undefined) { + fileAssetList.forEach(getAllObjectInfo); + console.info('MediaLibraryTest : getAllObject :PASS'); + } + }); }); ``` ## medialibrary.getFileAssets @@ -70,7 +83,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; 获取文件资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -89,7 +102,13 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; **示例：** ``` -medialibrary.getFileAssets(fileNoArgsfetchOp).then(function(fetchFileResult){ +let fileKeyObj = mediaLibrary.FileKey +let imageType = mediaLibrary.MediaType.IMAGE +let imagesfetchOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], +}; +medialibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){ console.info("getFileAssets successfully:"+ JSON.stringify(dir)); }).catch(function(err){ console.info("getFileAssets failed with error:"+ err); @@ -100,9 +119,9 @@ medialibrary.getFileAssets(fileNoArgsfetchOp).then(function(fetchFileResult){ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; -打开媒体文件变更和上线通知，使用callback方式返回异步结果。 +打开媒体媒体库变更通知，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -110,7 +129,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型 | +| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
’audioChange‘：  音频文件变更
‘videoChange’：  视频文件变更
‘'fileChange'：  文件变更
‘remoteFileChange’： 注册设备上文件变更 | | callback | callback<void> | 是 | 回调返回空 | **示例：** @@ -124,9 +143,11 @@ medialibrary.on('imageChange', () => { off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void; -关闭媒体文件变更和设备上线通知，使用callback方式返回异步结果。 +关闭媒体媒体库变更通知，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +变更通知类型包括：注册设备变更，相册变更，图片文件变更，音频文件变更，视频文件变更，文件变更，远端文件变更。 + +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -134,7 +155,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型 | +| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
’audioChange‘：  音频文件变更
‘videoChange’：  视频文件变更
‘'fileChange'：  文件变更
‘remoteFileChange’： 注册设备上文件变更 | | callback | callback<void> | 否 | 回调返回空 | **示例：** @@ -151,25 +172,43 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | -------------------------------------- | ---- | ----------------------------------- | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | -| displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对路径 | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | -------------------------------------- | ---- | ------------------------------------------------------------ | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | +| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** ``` -medialibrary.createAsset(mediaType, displayName, rp, (createAssetErr, fileObj) => { - // do something -}); +// 使用Callback方式创建Image类型文件 +let mediaType = mediaLibrary.MediaType.IMAGE; +let path = "Pictures/"; +medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, albumFetchFileResult) => { + if (albumFetchFileResult != undefined) { + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets success'); + albumFetchFileResult.getAllObject((err, fileAssetList) => { + if (fileAssetList != undefined) { + fileAssetList.forEach(getAllObjectInfo); + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 success'); + } else { + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 fail, message = ' + err); + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 getFileAssets :No data'); + + } + }); + } else { + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 fail, message = ' + err); + + } + }); ``` ## medialibrary.createAsset @@ -178,17 +217,17 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ----------------------- | ---- | ---------- | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | -| displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对路径 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ----------------------- | ---- | ------------------------------------------------------------ | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | **返回值** @@ -199,6 +238,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr **示例：** ``` +// 使用Promise方式创建Image类型文件 +let mediaType = mediaLibrary.MediaType.IMAGE; +let path = "Pictures/"; medialibrary.createAsset(mediaType, "image01.jpg", path).then(function(asset){ console.info("createAsset successfully:"+ JSON.stringify(asset)); }).catch(function(err){ @@ -212,7 +254,7 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; 删除媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -237,7 +279,7 @@ deleteAsset(uri: string): Promise<void>; 删除媒体资源，使用promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -263,13 +305,79 @@ medialibrary.deleteAsset(asset.uri).then(()=>{ }); ``` +## medialibrary.getPublicDirectory + +getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; + +获取公共目录路径 + +**需要权限**：无 + +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------- | ---- | ------------ | +| type | [DirectoryType](#DirectoryType) | 是 | 公共目录类型 | +| callback |AsyncCallback<string> | 是 | callback 返回公共目录路径 | + + +**示例：** + +``` +let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; +media.getPublicDirectory(DIR_CAMERA，(err, dicResult) => { + if (dicResult == 'camera/') { + console.info('MediaLibraryTest : getPublicDirectory 001 passed'); + } else { + console.info('MediaLibraryTest : getPublicDirectory 001 failed'); + + } +}); +``` + +## medialibrary.getPublicDirectory + +getPublicDirectory(type: DirectoryType): Promise; + +获取公共目录路径 + +**需要权限**：无 + +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------------------------------- | ---- | ------------ | +| type | [DirectoryType](#DirectoryType) | 是 | 公共目录类型 | + +**返回值：** + +| 类型 | 说明 | +| --------------- | ---------------- | +| Promise | 返回公共目录路径 | + +**示例：** + +``` +let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; +const dicResult = await media.getPublicDirectory(DIR_CAMERA); +if (dicResult == 'camera/') { + console.info('MediaLibraryTest : getPublicDirectory 001 passed'); +} else { + console.info('MediaLibraryTest : getPublicDirectory 001 failed'); +} +``` + ## medialibrary.getAlbums getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void; 获取实体相册，使用callback 方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -292,7 +400,7 @@ getAlbums(options: MediaFetchOptions): Promise; 获取实体相册，使用 promise 方式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -322,9 +430,9 @@ medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ getActivePeers(callback: AsyncCallback): void; -获取活动对端设备 +获取活动注册设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -346,9 +454,9 @@ medialibrary.getActivePeers((err, data) => { getActivePeers(): Promise; -获取活动对端设备 +获取活动注册设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -370,9 +478,9 @@ peerInfoList = medialibrary.getActivePeers(); getAllPeers(callback: AsyncCallback): void; -获取所有对端设备 +获取所有注册设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -394,9 +502,9 @@ medialibrary.getAllPeers((err, data) => { getAllPeers(): Promise; -获取所有对端设备 +获取所有注册设备 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -416,7 +524,7 @@ release(callback: AsyncCallback<void>): void; 释放MediaLibrary实例 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -438,9 +546,9 @@ medialibrary.release((err, data) => { release(): Promise<void>; -释放MediaLibrary实例 +释放MediaLibrary实例 (补充说明) -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -462,7 +570,7 @@ isDirectory(callback: AsyncCallback<boolean>): void; 判断fileAsset是否为目录，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -486,7 +594,7 @@ isDirectory():Promise<boolean>; 判断fileAsset是否为目录，使用Promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -512,7 +620,7 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -525,9 +633,18 @@ commitModify(callback: AsyncCallback<void>): void; **示例：** ``` -asset.commitModify(function(err){ - // do something -}); +asset.title = ‘newtitle'; +asset.commitModify(commitModifyCallBack); +function commitModifyCallBack(err, commitModify) { + if (commitModify != undefined) { + console.info('MediaLibraryTest : ASSET_CALLBACK commitModify success'); + + } else { + console.info('MediaLibraryTest : ASSET_CALLBACK commitModify Unsuccessfull = ' + err); + + } + +} ``` ## FileAsset.commitModify @@ -536,7 +653,7 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -549,10 +666,8 @@ commitModify(): Promise<void>; **示例：** ``` -asset.commitModify(commitModifyCallBack); -function commitModifyCallBack(err, commitModify) { - // do something -} +asset.title = ‘newtitle'; +asset.commitModify(); ``` ## FileAsset.open @@ -561,7 +676,7 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -569,14 +684,21 @@ open(mode: string, callback: AsyncCallback<number>): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| mode | string | 是 | 打开文件方式 | +| mode | string | 是 | 打开文件方式，如：'r', 'w', 'rw' | | callback | AsyncCallback<number> | 是 | 回调返回文件句柄 | **示例：** ``` -asset.open('Rw').then((openError, fd) => { - // do something +let mediaType = mediaLibrary.MediaType.IMAGE; +let path = "Pictures/"; +asset = await media.createAsset(mediaType, "image00003.jpg", path); +asset.open('rw', (openError, fd) => { + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } }); ``` @@ -586,15 +708,15 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------------ | -| mode | string | 是 | 打开文件方式 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------- | +| mode | string | 是 | 打开文件方式，如：'r', 'w', 'rw' | **返回值：** @@ -605,8 +727,15 @@ open(mode: string): Promise<number>; **示例：** ``` -asset.open('Rw').then((openError, fd) => { - // do something +let mediaType = mediaLibrary.MediaType.IMAGE; +let path = "Pictures/"; +asset = await media.createAsset(mediaType, "image00003.jpg", path); +asset.open('rw').then((openError, fd) => { + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } }); ``` @@ -616,7 +745,7 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -630,8 +759,14 @@ close(fd: number, callback: AsyncCallback<void>): void; **示例：** ``` -fileAsset.close(fd).then((closeErr) => { - // do something +fileAsset.close(fd, (closeErr) => { + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + } else { + console.info("=======asset.close success====>"); + + } }); ``` @@ -641,7 +776,7 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -661,7 +796,13 @@ close(fd: number): Promise<void>; ``` fileAsset.close(fd).then((closeErr) => { - // do something + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + + } else { + console.info("=======asset.close success====>"); + } }); ``` @@ -671,7 +812,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -684,7 +825,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -data1.getThumbnail(size, (err, pixelmap) => { +fileAsset.getThumbnail((err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -695,7 +836,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -709,7 +850,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -data1.getThumbnail(size, (err, pixelmap) => { +fileAsset.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -720,7 +861,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -739,7 +880,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; **示例：** ``` -data1.getThumbnail(size, (err, pixelmap) => { +fileAsset.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -750,7 +891,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -758,7 +899,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------- | ---- | -------------- | -| isFavorite | boolean | 是 | 是否为收藏文件 | +| isFavorite | boolean | 是 | 是否设置为收藏文件, true：设置为收藏文件，false：取消收藏 | | callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -775,15 +916,15 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | -------------- | -| isFavorite | boolean | 是 | 是否为收藏文件 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | --------------------------------------------------------- | +| isFavorite | boolean | 是 | 是否设置为收藏文件, true：设置为收藏文件，false：取消收藏 | **返回值：** @@ -807,7 +948,7 @@ isFavorite(callback: AsyncCallback<boolean>): void; 判断该文件是否为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -820,8 +961,12 @@ isFavorite(callback: AsyncCallback<boolean>): void; **示例：** ``` -asset.favorite(true, (err) => { - // do something +asset.isFavorite((err, isFavorite) => { + if (isFavorite) { + console.info('FileAsset is favorite'); + }else{ + console.info('FileAsset is not favorite'); + } }); ``` @@ -831,7 +976,7 @@ isFavorite():Promise<boolean>; 判断该文件是否为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -857,7 +1002,9 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 + +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -865,15 +1012,17 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| isTrash | boolean | 是 | 是否为收藏文件 | +| isTrash | boolean | 是 | 是否设置为垃圾文件 | | callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** ``` -asset.trash(true, (err) => { - // do something -}); +asset.trash(true, trashCallBack); +function trashCallBack(err, trash) { + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); + +} ``` ## FileAsset.trash @@ -882,15 +1031,17 @@ trash(isTrash: boolean,): Promise<void>; 当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 + +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ---- | -------------- | -| isTrash | boolean | 是 | 是否放入回收站 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | ------------------ | +| isTrash | boolean | 是 | 是否设置为垃圾文件 | **返回值：** @@ -914,7 +1065,7 @@ isTrash(callback: AsyncCallback<boolean>): void; 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -927,9 +1078,18 @@ isTrash(callback: AsyncCallback<boolean>): void; **示例：** ``` -asset.isTrash((err, isTrash) => { - // do something -}); +asset.isTrash(isTrashCallBack); +function isTrashCallBack(err, isTrash) { + if (isTrash == true) { + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); + asset.trash(true, trashCallBack); + + } else { + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); + + } +} ``` ## FileAsset.isTrash @@ -938,7 +1098,7 @@ isTrash():Promise<boolean>; 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -968,7 +1128,7 @@ getCount(): number; 获取文件检索结果中的文件总数。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -981,7 +1141,14 @@ getCount(): number; **示例**： ``` -var resultnum = FetchFileResult.getCount(); +let getFileCountOneOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [fileType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,1", +}; +let fetchFileResult = await media.getFileAssets(getFileCountOneOp); +const fetchCount = fetchFileResult.getCount(); ``` ## FetchFileResult.isAfterLast @@ -990,7 +1157,7 @@ isAfterLast(): boolean; 检查结果集是否指向最后一行。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1003,7 +1170,21 @@ isAfterLast(): boolean; **示例**： ``` -var result = FetchFileResult.isAfterLast(); +let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +const fetchCount = fetchFileResult.getCount(); +console.info('MediaLibraryTest : count:' + fetchCount); +let fileAsset = await fetchFileResult.getFirstObject(); +for (var i = 1; i < fetchCount; i++) { + fileAsset = await fetchFileResult.getNextObject(); + if(i == fetchCount - 1) { + console.info('MediaLibraryTest : isLast'); + var result = fetchFileResult.isAfterLast(); + console.info('MediaLibraryTest : isAfterLast:' + result); + console.info('MediaLibraryTest : isAfterLast end'); + fetchFileResult.close(); + + } +} ``` ## FetchFileResult.close @@ -1012,14 +1193,15 @@ close(): void; 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **示例**： ``` -var result = FetchFileResult.close(); +let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +fetchFileResult.close(); ``` ## FetchFileResult.getFirstObject @@ -1028,7 +1210,7 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1056,7 +1238,7 @@ getFirstObject(): Promise<FileAsset>; 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1083,7 +1265,7 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1111,7 +1293,7 @@ data.getNextObject((err, value) => { 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1124,7 +1306,10 @@ data.getNextObject((err, value) => { **示例**： ``` -var result = FetchFileResult.getNextObject +let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +const fetchCount = fetchFileResult.getCount(); +console.info('MediaLibraryTest : count:' + fetchCount); +fileAsset = await fetchFileResult.getNextObject(); ``` ## FetchFileResult.getLastObject @@ -1133,7 +1318,7 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1161,7 +1346,7 @@ getLastObject(): Promise<FileAsset>; 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1174,7 +1359,15 @@ getLastObject(): Promise<FileAsset>; **示例**： ``` -var result = FetchFileResult.getLastObject() +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +let lastObject = await fetchFileResult.getLastObject(); ``` ## FetchFileResult.getPositionObject @@ -1183,7 +1376,7 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1191,7 +1384,7 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void | 参数 | 类型 | 必填 | 说明 | | -------- | -------------------------------------------- | ---- | --------------------------- | -| index | number | 是 | 要获取的文件的索引 | +| index | number | 是 | 要获取的文件的索引，从0开始 | | callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1212,7 +1405,7 @@ getPositionObject(index: number): Promise<FileAsset>; 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1220,7 +1413,7 @@ getPositionObject(index: number): Promise<FileAsset>; | 参数 | 类型 | 必填 | 说明 | | ----- | ------ | ---- | -------------------- | -| index | number | 是 | 要获取的文件在结果集中的位置 | +| index | number | 是 | 要获取的文件的索引，从0开始 | **返回值**： @@ -1246,7 +1439,7 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1274,7 +1467,7 @@ getAllObject(): Promise<Array<FileAsset>>; 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1287,7 +1480,15 @@ getAllObject(): Promise<Array<FileAsset>>; **示例**： ``` -var data = FetchFileResult.getAllObject(); +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +var data = fetchFileResult.getAllObject(); ``` ## Album.commitModify @@ -1296,7 +1497,7 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1325,7 +1526,7 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1352,7 +1553,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1379,7 +1580,7 @@ function getFileAssetsCallBack(err, fetchFileResult) { 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_LOCATION，ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE，ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：ohos.permission.MEDIA_READ **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1407,12 +1608,12 @@ album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ ## PeerInfo -对端设备信息。 +注册设备信息。 | 名称 | 类型 | 可读 | 可写 | 说明 | | ---------- | ---------- | ---- | ---- | -------------- | -| deviceName | string | 是 | 否 | 设备名称 | -| networkId | string | 是 | 否 | 对端设备网络ID | +| deviceName | string | 是 | 否 | 注册设备名称 | +| networkId | string | 是 | 否 | 注册设备网络ID | | deviceType | DeviceType | 是 | 否 | 设备类型 | | isOnline | boolean | 是 | 否 | 是否在线 | @@ -1421,29 +1622,29 @@ FileAsset **属性：** -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------ | --------- | ---- | ---- | ------------ | -| id | number | 是 | 否 | 文件资源编号 | -| uri | string | 是 | 否 | 文件资源uri | -| mimeType | string | 是 | 否 | 文件扩展 | -| mediaType | MediaType | 是 | 否 | 媒体类型 | -| displayName | string | 是 | 是 | 显示文件名 | -| title | string | 是 | 是 | 文件标题 | -| relativePath | string | 是 | 是 | 相对路径 | -| parent | number | 是 | 否 | 父目录id | -| size | number | 是 | 否 | 文件大小 | -| dateAdded | number | 是 | 否 | 添加日期 | -| dateModified | number | 是 | 否 | 修改日期 | -| dateTaken | number | 是 | 否 | 拍摄日期 | -| artist | string | 是 | 否 | 创建者 | -| audioAlbum | string | 是 | 否 | 音频相册 | -| width | number | 是 | 否 | 图片宽度 | -| height | number | 是 | 否 | 图片高度 | -| orientation | number | 是 | 是 | 图片方向 | -| duration | number | 是 | 否 | 持续时间 | -| albumId | number | 是 | 否 | 相册编号 | -| albumUri | string | 是 | 否 | 相册uri | -| albumName | string | 是 | 否 | 相册名称 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------ | --------- | ---- | ---- | ------------------------------------------------------ | +| id | number | 是 | 否 | 文件资源编号 | +| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | +| mimeType | string | 是 | 否 | 文件扩展属性 | +| mediaType | MediaType | 是 | 否 | 媒体类型 | +| displayName | string | 是 | 是 | 显示文件名 | +| title | string | 是 | 是 | 文件标题 | +| relativePath | string | 是 | 是 | 相对路径 | +| parent | number | 是 | 否 | 父目录id | +| size | number | 是 | 否 | 文件大小(单位：字节) | +| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | +| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | +| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | +| artist | string | 是 | 否 | 作者 | +| audioAlbum | string | 是 | 否 | 专辑 | +| width | number | 是 | 否 | 图片宽度（单位：像素） | +| height | number | 是 | 否 | 图片高度（单位：像素） | +| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | +| duration | number | 是 | 否 | 持续时间（单位：秒） | +| albumId | number | 是 | 否 | 文件所归属的相册编号 | +| albumUri | string | 是 | 否 | 文件所归属相册uri | +| albumName | string | 是 | 否 | 文件所归属相册名称 | Album --------- @@ -1454,8 +1655,8 @@ Album | 名称 | 参数型 | 可读 | 可写 | 说明 | | ------------ | ------ | ---- | ---- | -------------- | -| albumId | number | 是 | 否 | 相册ID | -| albumName | string | 是 | 是 | 相册名 | +| albumId | number | 是 | 否 | 相册编号 | +| albumName | string | 是 | 是 | 相册名称 | | albumUri | string | 是 | 否 | 相册Uri | | dateModified | number | 是 | 否 | 修改日期 | | count | number | 是 | 否 | 相册中文件数量 | @@ -1479,45 +1680,45 @@ FileKey 枚举，文件关键信息。 -| 名称 | 默认值 | 可读 | 可写 | 描述 | -| ------------- | ------------------- | ---- | ---- | ------------------ | -| ID | file_id | 是 | 否 | 文件编号 | -| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径 | -| DISPLAY_NAME | display_name | 是 | 是 | 显示名字 | -| PARENT | parent | 是 | 否 | 父目录 | -| MIME_TYPE | mime_type | 是 | 否 | 该资源的媒体类型 | -| MEDIA_TYPE | media_type | 是 | 否 | 媒体类型 | -| SIZE | size | 是 | 否 | 文件大小 | -| DATE_ADDED | date_added | 是 | 否 | 添加日期 | -| DATE_MODIFIED | date_modified | 是 | 否 | 修改日期 | -| DATE_TAKEN | date_taken | 是 | 否 | 表示拍摄日期 | -| TITLE | title | 是 | 是 | 表示标题 | -| ARTIST | artist | 是 | 否 | 创建者 | -| AUDIOALBUM | audio_album | 是 | 否 | 表示音频相册 | -| DURATION | duration | 是 | 否 | 表示媒体文件时长 | -| WIDTH | width | 是 | 否 | 表示图片宽 | -| HEIGHT | height | 是 | 否 | 表示图片高 | -| ORIENTATION | orientation | 是 | 否 | 图片显示方向 | -| ALBUM_ID | bucket_id | 是 | 否 | 媒体文件所在相册ID | -| ALBUM_NAME | bucket_display_name | 是 | 否 | 媒体文件所在相册名 | +| 名称 | 默认值 | 可读 | 可写 | 描述 | +| ------------- | ------------------- | ---- | ---- | ------------------------------------------------------ | +| ID | file_id | 是 | 否 | 文件编号 | +| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径 | +| DISPLAY_NAME | display_name | 是 | 是 | 显示名字 | +| PARENT | parent | 是 | 否 | 父目录id | +| MIME_TYPE | mime_type | 是 | 否 | 文件扩展属性 | +| 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 | 是 | 否 | 文件所归属相册名称 | DirectoryType ------------- 枚举，目录类型。 -| 名称 | 默认值 | 描述 | -| ---------------------- | ------ | ---------------- | -| DIR_CDSA | 0 | 表示CDSA规范路径 | -| DIR_VIDEO | 1 | 表示视频路径 | -| DIR_IMAGE | 2 | 表示图片路径 | -| DIR_AUDIO | 3 | 表示音频路径 | -| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径 | -| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径 | -| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径 | -| DIR_DOCUMENTS | 7 | 表示文档路径 | -| DIR_DOWNLOAD | 8 | 表示下载路径 | -| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径 | +| 名称 | 默认值 | 描述 | +| ---------------------- | ------ | ------------------ | +| DIR_CAMERA | 0 | 表示Camera文件路径 | +| DIR_VIDEO | 1 | 表示视频路径 | +| DIR_IMAGE | 2 | 表示图片路径 | +| DIR_AUDIO | 3 | 表示音频路径 | +| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径 | +| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径 | +| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径 | +| DIR_DOCUMENTS | 7 | 表示文档路径 | +| DIR_DOWNLOAD | 8 | 表示下载路径 | +| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径 | DeviceType ----------- @@ -1544,15 +1745,15 @@ DeviceType | selectionArgs | Array | 是 | 是 | 检索条件的值 | | order | string | 是 | 是 | 检索结果排序方式 | | uri | string | 是 | 是 | 文件URI | -| networkId | string | 是 | 是 | 对端设备网络ID | +| networkId | string | 是 | 是 | 注册设备网络ID | | extendArgs | string | 是 | 是 | 扩展的检索参数 | ## Size 图片尺寸。 -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------ | ------ | ---- | ---- | ---- | -| width | number | 是 | 是 | 宽 | -| height | number | 是 | 是 | 高 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------ | ------ | ---- | ---- | ---------------- | +| width | number | 是 | 是 | 宽（单位：像素） | +| height | number | 是 | 是 | 高（单位：像素） | -- Gitee From 85d98ae311205868dc7ffc128d595c536453d9e1 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 3 Mar 2022 09:53:36 +0800 Subject: [PATCH 09/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 253 ++++++++---------- 1 file changed, 117 insertions(+), 136 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 e0b9562cf39..48ad0b65bb4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -15,7 +15,7 @@ function getMediaLibrary(context: Context): MediaLibrary; 获取媒体库。 -**需要权限**：ohos.permission.GET_BUNDLE_INFO_PRIVILEGED +**需要权限**：无 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -46,7 +46,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 获取文件资源，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -67,14 +67,13 @@ let imagesfetchOp = { selectionArgs: [imageType.toString()], }; medialibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { - if (fetchFileResult != undefined) { - console.info('MediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); - fetchFileResult.getAllObject((err, fileAssetList) => { - if (fileAssetList != undefined) { - fileAssetList.forEach(getAllObjectInfo); - console.info('MediaLibraryTest : getAllObject :PASS'); - } - }); + if (fetchFileResult != undefined) { + console.info('MediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); + fetchFileResult.getAllObject((err, fileAssetList) => { + if (fileAssetList != undefined) { + fileAssetList.forEach(getAllObjectInfo); + } + }); }); ``` ## medialibrary.getFileAssets @@ -83,7 +82,7 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; 获取文件资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -172,7 +171,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -192,23 +191,20 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, albumFetchFileResult) => { - if (albumFetchFileResult != undefined) { - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets success'); - albumFetchFileResult.getAllObject((err, fileAssetList) => { - if (fileAssetList != undefined) { - fileAssetList.forEach(getAllObjectInfo); - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 success'); - } else { - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 fail, message = ' + err); - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 getFileAssets :No data'); - - } - }); + if (albumFetchFileResult != undefined) { + console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets success'); + albumFetchFileResult.getAllObject((err, fileAssetList) => { + if (fileAssetList != undefined) { + fileAssetList.forEach(getAllObjectInfo); } else { - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets 004_01 fail, message = ' + err); - + console.info('getFileAssets fail, message = ' + err); + console.info('getFileAssets getFileAssets :No data'); } }); + } else { + console.info('getFileAssets failed, message = ' + err); + } +}); ``` ## medialibrary.createAsset @@ -217,7 +213,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -254,7 +250,7 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; 删除媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -279,7 +275,7 @@ deleteAsset(uri: string): Promise<void>; 删除媒体资源，使用promise方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -329,10 +325,9 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; media.getPublicDirectory(DIR_CAMERA，(err, dicResult) => { if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory 001 passed'); + console.info('MediaLibraryTest : getPublicDirectory passed'); } else { - console.info('MediaLibraryTest : getPublicDirectory 001 failed'); - + console.info('MediaLibraryTest : getPublicDirectory failed'); } }); ``` @@ -365,9 +360,9 @@ getPublicDirectory(type: DirectoryType): Promise; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory 001 passed'); + console.info('MediaLibraryTest : getPublicDirectory passed'); } else { - console.info('MediaLibraryTest : getPublicDirectory 001 failed'); + console.info('MediaLibraryTest : getPublicDirectory failed'); } ``` @@ -377,7 +372,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback; 获取实体相册，使用 promise 方式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -432,7 +427,7 @@ getActivePeers(callback: AsyncCallback): void; 获取活动注册设备 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -456,7 +451,7 @@ getActivePeers(): Promise; 获取活动注册设备 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -480,7 +475,7 @@ getAllPeers(callback: AsyncCallback): void; 获取所有注册设备 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -504,7 +499,7 @@ getAllPeers(): Promise; 获取所有注册设备 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore @@ -570,7 +565,7 @@ isDirectory(callback: AsyncCallback<boolean>): void; 判断fileAsset是否为目录，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -594,7 +589,7 @@ isDirectory():Promise<boolean>; 判断fileAsset是否为目录，使用Promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -620,7 +615,7 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -634,16 +629,8 @@ commitModify(callback: AsyncCallback<void>): void; ``` asset.title = ‘newtitle'; -asset.commitModify(commitModifyCallBack); -function commitModifyCallBack(err, commitModify) { - if (commitModify != undefined) { - console.info('MediaLibraryTest : ASSET_CALLBACK commitModify success'); - - } else { - console.info('MediaLibraryTest : ASSET_CALLBACK commitModify Unsuccessfull = ' + err); - - } - +asset.commitModify(() => { + console.info('commitModify success'); } ``` @@ -653,7 +640,7 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -676,7 +663,7 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -708,7 +695,7 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -745,7 +732,7 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -760,13 +747,12 @@ close(fd: number, callback: AsyncCallback<void>): void; ``` fileAsset.close(fd, (closeErr) => { - if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); - } else { - console.info("=======asset.close success====>"); - - } + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + } else { + console.info("=======asset.close success====>"); + } }); ``` @@ -776,7 +762,7 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -796,13 +782,13 @@ close(fd: number): Promise<void>; ``` fileAsset.close(fd).then((closeErr) => { - if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); - - } else { - console.info("=======asset.close success====>"); - } + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + + } else { + console.info("=======asset.close success====>"); + } }); ``` @@ -812,7 +798,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -836,7 +822,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -861,7 +847,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -891,7 +877,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -916,7 +902,7 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -948,7 +934,7 @@ isFavorite(callback: AsyncCallback<boolean>): void; 判断该文件是否为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -976,7 +962,7 @@ isFavorite():Promise<boolean>; 判断该文件是否为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1004,7 +990,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1020,8 +1006,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; ``` asset.trash(true, trashCallBack); function trashCallBack(err, trash) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); - + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); } ``` @@ -1033,7 +1018,7 @@ trash(isTrash: boolean,): Promise<void>; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1065,7 +1050,7 @@ isTrash(callback: AsyncCallback<boolean>): void; 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1098,7 +1083,7 @@ isTrash():Promise<boolean>; 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1265,7 +1250,7 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1293,7 +1278,7 @@ data.getNextObject((err, value) => { 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1405,7 +1390,7 @@ getPositionObject(index: number): Promise<FileAsset>; 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1439,7 +1424,7 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1497,7 +1482,7 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1511,12 +1496,12 @@ commitModify(callback: AsyncCallback<void>): void; ``` album.albumName = 'hello'; -album.commitModify((err, value) => { +album.commitModify((err) => { if (err) { console.error('Failed '); return; } - console.log(value); + console.log('Modify successful.'); }) ``` @@ -1526,7 +1511,7 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.MEDIA_READ，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1553,7 +1538,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1580,7 +1565,7 @@ function getFileAssetsCallBack(err, fetchFileResult) { 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 -**需要权限**：ohos.permission.MEDIA_READ +**需要权限**：ohos.permission.READ_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1680,45 +1665,41 @@ FileKey 枚举，文件关键信息。 -| 名称 | 默认值 | 可读 | 可写 | 描述 | -| ------------- | ------------------- | ---- | ---- | ------------------------------------------------------ | -| ID | file_id | 是 | 否 | 文件编号 | -| RELATIVE_PATH | relative_path | 是 | 是 | 相对路径 | -| DISPLAY_NAME | display_name | 是 | 是 | 显示名字 | -| PARENT | parent | 是 | 否 | 父目录id | -| MIME_TYPE | mime_type | 是 | 否 | 文件扩展属性 | -| 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 | 文件扩展属性 | +| 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 | 文件所归属相册名称 | DirectoryType ------------- 枚举，目录类型。 -| 名称 | 默认值 | 描述 | -| ---------------------- | ------ | ------------------ | -| DIR_CAMERA | 0 | 表示Camera文件路径 | -| DIR_VIDEO | 1 | 表示视频路径 | -| DIR_IMAGE | 2 | 表示图片路径 | -| DIR_AUDIO | 3 | 表示音频路径 | -| DIR_AUDIO_RINGS | 4 | 表示铃声音频路径 | -| DIR_AUDIO_NOTICE | 5 | 表示提示音频路径 | -| DIR_AUDIO_CLOCK | 6 | 表示时钟音频路径 | -| DIR_DOCUMENTS | 7 | 表示文档路径 | -| DIR_DOWNLOAD | 8 | 表示下载路径 | -| DIR_DOWNLOAD_BLUETOOTH | 9 | 表示蓝牙下载路径 | +| 名称 | 默认值 | 描述 | +| ------------- | ------ | ------------------ | +| DIR_CAMERA | 0 | 表示Camera文件路径 | +| DIR_VIDEO | 1 | 表示视频路径 | +| DIR_IMAGE | 2 | 表示图片路径 | +| DIR_AUDIO | 3 | 表示音频路径 | +| DIR_DOCUMENTS | 4 | 表示文档路径 | +| DIR_DOWNLOAD | 5 | 表示下载路径 | DeviceType ----------- @@ -1739,14 +1720,14 @@ DeviceType 检索条件。 -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------- | ------------- | ---- | ---- | ---------------- | -| selections | string | 是 | 是 | 检索条件 | -| selectionArgs | Array | 是 | 是 | 检索条件的值 | -| order | string | 是 | 是 | 检索结果排序方式 | -| uri | string | 是 | 是 | 文件URI | -| networkId | string | 是 | 是 | 注册设备网络ID | -| extendArgs | string | 是 | 是 | 扩展的检索参数 | +| 名称 | 类型 | 可读 | 可写 | 必填 |说明 | +| ------------- | ------------- | ---- | ---- | ---- |---------------- | +| selections | string | 是 | 是 |是 | 检索条件 | +| selectionArgs | Array | 是 | 是 |是 | 检索条件的值 | +| order | string | 是 | 是 | 否 |检索结果排序方式 | +| uri | string | 是 | 是 | 否 |文件URI | +| networkId | string | 是 | 是 | 否 |注册设备网络ID | +| extendArgs | string | 是 | 是 | 否 |扩展的检索参数 | ## Size -- Gitee From 9f0a10559a1ee796618156ca0677de215e0ac732 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 3 Mar 2022 10:19:43 +0800 Subject: [PATCH 10/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 328 +++++++++++++++++- 1 file changed, 309 insertions(+), 19 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 48ad0b65bb4..0760833be07 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -264,7 +264,16 @@ deleteAsset(uri: string, callback: AsyncCallback<void>): void; **示例：** ``` -medialibrary.deleteAsset(fileAsset.uri, (deleteAssetErr, deleteRows) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +medialibrary.deleteAsset(asset.uri, (deleteAssetErr, deleteRows) => { // do something }); ``` @@ -294,6 +303,15 @@ deleteAsset(uri: string): Promise<void>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); medialibrary.deleteAsset(asset.uri).then(()=>{ console.info("deleteAsset successfully"); }).catch(function(err){ @@ -360,7 +378,7 @@ getPublicDirectory(type: DirectoryType): Promise; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory passed'); + console.info('MediaLibraryTest : getPublicDirectory passed'); } else { console.info('MediaLibraryTest : getPublicDirectory failed'); } @@ -386,7 +404,21 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback { + if (albumList != undefined) { + const album = albumList[0]; + console.info('album.albumName = ' + album.albumName); + console.info('album.count = ' + album.count); + done(); + } else { + console.info('getAlbum fail, message = ' + err); + done(); + } +}); ``` ## medialibrary.getAlbums @@ -414,6 +446,10 @@ getAlbums(options: MediaFetchOptions): Promise; **示例：** ``` +let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], +}; medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ console.info("getAlbums successfully:"+ JSON.stringify(albumList)); }).catch(function(err){ @@ -578,6 +614,15 @@ isDirectory(callback: AsyncCallback<boolean>): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isDirectory((err, isDirectory) => { // do something }); @@ -602,6 +647,15 @@ isDirectory():Promise<boolean>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isDirectory().then(function(isDirectory){ console.info("isDirectory result:"+ isDirectory); }).catch(function(err){ @@ -628,9 +682,18 @@ commitModify(callback: AsyncCallback<void>): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.title = ‘newtitle'; asset.commitModify(() => { - console.info('commitModify success'); + console.info('commitModify success'); } ``` @@ -653,6 +716,15 @@ commitModify(): Promise<void>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.title = ‘newtitle'; asset.commitModify(); ``` @@ -746,7 +818,16 @@ close(fd: number, callback: AsyncCallback<void>): void; **示例：** ``` -fileAsset.close(fd, (closeErr) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +asset.close(fd, (closeErr) => { if (closeErr != undefined) { console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); @@ -781,7 +862,16 @@ close(fd: number): Promise<void>; **示例：** ``` -fileAsset.close(fd).then((closeErr) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +asset.close(fd).then((closeErr) => { if (closeErr != undefined) { console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); @@ -811,7 +901,16 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -fileAsset.getThumbnail((err, pixelmap) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +asset.getThumbnail((err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -836,7 +935,16 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -fileAsset.getThumbnail(size, (err, pixelmap) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +asset.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -866,7 +974,16 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; **示例：** ``` -fileAsset.getThumbnail(size, (err, pixelmap) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); +asset.getThumbnail(size, (err, pixelmap) => { console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); ``` @@ -891,6 +1008,15 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.favorite(true,function(err){ // do something }); @@ -921,6 +1047,15 @@ favorite(isFavorite: boolean): Promise<void>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.favorite(true).then(function() { console.info("favorite successfully"); }).catch(function(err){ @@ -947,6 +1082,15 @@ isFavorite(callback: AsyncCallback<boolean>): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isFavorite((err, isFavorite) => { if (isFavorite) { console.info('FileAsset is favorite'); @@ -975,6 +1119,15 @@ isFavorite():Promise<boolean>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isFavorite().then(function(isFavorite){ console.info("isFavorite result:"+ isFavorite); }).catch(function(err){ @@ -1004,6 +1157,15 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.trash(true, trashCallBack); function trashCallBack(err, trash) { console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); @@ -1037,6 +1199,15 @@ trash(isTrash: boolean,): Promise<void>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.trash(true).then(function() { console.info("trash successfully"); }).catch(function(err){ @@ -1063,6 +1234,15 @@ isTrash(callback: AsyncCallback<boolean>): void; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isTrash(isTrashCallBack); function isTrashCallBack(err, isTrash) { if (isTrash == true) { @@ -1096,6 +1276,15 @@ isTrash():Promise<boolean>; **示例：** ``` +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +const fetchFileResult = await media.getFileAssets(getImageOp); +const asset = await fetchFileResult.getFirstObject(); asset.isTrash().then(function(isTrash){ console.info("isTrash result:"+ isTrash); }).catch(function(err){ @@ -1155,7 +1344,14 @@ isAfterLast(): boolean; **示例**： ``` -let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); console.info('MediaLibraryTest : count:' + fetchCount); let fileAsset = await fetchFileResult.getFirstObject(); @@ -1185,7 +1381,14 @@ close(): void; **示例**： ``` -let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.close(); ``` @@ -1208,7 +1411,15 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -data.getFirstObject((err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getFirstObject((err, value) => { if (err) { console.error('Failed '); return; @@ -1237,7 +1448,15 @@ getFirstObject(): Promise<FileAsset>; **示例**： ``` -queryResultSet_.getFirstObject().then(function(fileAsset){ +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getFirstObject().then(function(fileAsset){ console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset)); }).catch(function(err){ console.info("getFirstObject failed with error:"+ err); @@ -1263,7 +1482,15 @@ queryResultSet_.getFirstObject().then(function(fileAsset){ **示例**： ``` -data.getNextObject((err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getNextObject((err, value) => { if (err) { console.error('Failed '); return; @@ -1291,7 +1518,14 @@ data.getNextObject((err, value) => { **示例**： ``` -let fetchFileResult = await media.getFileAssets(getFileCountTenOp); +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); console.info('MediaLibraryTest : count:' + fetchCount); fileAsset = await fetchFileResult.getNextObject(); @@ -1316,7 +1550,15 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -data.getLastObject((err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getLastObject((err, value) => { if (err) { console.error('Failed '); return; @@ -1375,7 +1617,15 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void **示例**： ``` -data. getPositionObject(1，(err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getPositionObject(1，(err, value) => { if (err) { console.error('Failed '); return; @@ -1409,7 +1659,15 @@ getPositionObject(index: number): Promise<FileAsset>; **示例**： ``` -data.getPositionObject(1，(err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getPositionObject(1，(err, value) => { if (err) { console.error('Failed '); return; @@ -1437,7 +1695,15 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; **示例**： ``` -data.getAllObject((err, value) => { +let imageType = mediaLibrary.MediaType.IMAGE; +let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", +}; +let fetchFileResult = await media.getFileAssets(getImageOp); +fetchFileResult.getAllObject((err, value) => { if (err) { console.error('Failed '); return; @@ -1495,6 +1761,12 @@ commitModify(callback: AsyncCallback<void>): void; **示例**： ``` +let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], +}; +const albumList = await media.getAlbums(AlbumNoArgsfetchOp); +const album = albumList[0]; album.albumName = 'hello'; album.commitModify((err) => { if (err) { @@ -1524,6 +1796,12 @@ commitModify(): Promise<void>; **示例**： ``` +let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], +}; +const albumList = await media.getAlbums(AlbumNoArgsfetchOp); +const album = albumList[0]; album.albumName = 'hello'; album.commitModify().then(function() { console.info("commitModify successfully"); @@ -1552,6 +1830,12 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **示例**： ``` +let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], +}; +const albumList = await media.getAlbums(AlbumNoArgsfetchOp); +const album = albumList[0]; album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack); }) function getFileAssetsCallBack(err, fetchFileResult) { @@ -1584,6 +1868,12 @@ function getFileAssetsCallBack(err, fetchFileResult) { **示例**： ``` +let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], +}; +const albumList = await media.getAlbums(AlbumNoArgsfetchOp); +const album = albumList[0]; album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); }).catch(function(err){ -- Gitee From 6edecc8c6c2dadc87884ec664bf36e0f0abd0f61 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 3 Mar 2022 11:50:46 +0800 Subject: [PATCH 11/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 223 ++---------------- 1 file changed, 25 insertions(+), 198 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 0760833be07..8f91da0a391 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -13,7 +13,7 @@ import medialibrary from '@ohos.multimedia.medialibrary'; function getMediaLibrary(context: Context): MediaLibrary; -获取媒体库。 +获取媒体库的实例，用于访问和修改用户的个人数据信息。 **需要权限**：无 @@ -35,8 +35,10 @@ function getMediaLibrary(context: Context): MediaLibrary; ``` import featureAbility from '@ohos.ability.featureAbility'; +import mediaLibrary from ‘ohos.multimedia.mediaLibrary'; + var context = featureAbility.getContext() -var media = mediaLibrary.getMediaLibrary(context); +var mediaLibrary = mediaLibrary.getMediaLibrary(context); ``` ## medialibrary.getFileAssets @@ -171,7 +173,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal 创建媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -190,19 +192,11 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal // 使用Callback方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; -medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, albumFetchFileResult) => { - if (albumFetchFileResult != undefined) { - console.info('MediaLibraryTest : ALBUM_CALLBACK getFileAssets success'); - albumFetchFileResult.getAllObject((err, fileAssetList) => { - if (fileAssetList != undefined) { - fileAssetList.forEach(getAllObjectInfo); - } else { - console.info('getFileAssets fail, message = ' + err); - console.info('getFileAssets getFileAssets :No data'); - } - }); +medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, fileAsset) => { + if (fileAsset != undefined) { + console.info('createAsset successfully, message = ' + err); } else { - console.info('getFileAssets failed, message = ' + err); + console.info('createAsset failed, message = ' + err); } }); ``` @@ -213,7 +207,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr 创建媒体资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -237,88 +231,13 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr // 使用Promise方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; -medialibrary.createAsset(mediaType, "image01.jpg", path).then(function(asset){ +medialibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) { console.info("createAsset successfully:"+ JSON.stringify(asset)); }).catch(function(err){ console.info("createAsset failed with error:"+ err); }); ``` -## medialibrary.deleteAsset - -deleteAsset(uri: string, callback: AsyncCallback<void>): void; - -删除媒体资源，使用callback方式返回结果。 - -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------- | ---- | ---------------------- | -| uri | string | 是 | 文件uri | -| callback | AsyncCallback<void> | 是 | 回调返回空 | - -**示例：** - -``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -medialibrary.deleteAsset(asset.uri, (deleteAssetErr, deleteRows) => { - // do something -}); -``` - -## medialibrary.deleteAsset - -deleteAsset(uri: string): Promise<void>; - -删除媒体资源，使用promise方式返回结果。 - -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | ------- | -| uri | string | 是 | 文件uri | - -**返回值：** - -| 类型 | 说明 | -| ------------- | ------------------------------------------------- | -| Promise<void> | Promise实例，用于异步获取结果。本调用将返回空值 | - -**示例：** - -``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -medialibrary.deleteAsset(asset.uri).then(()=>{ - console.info("deleteAsset successfully"); -}).catch(function(err){ - console.info("deleteAsset failed with error:"+ err); -}); -``` - ## medialibrary.getPublicDirectory getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; @@ -457,103 +376,11 @@ medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ }); ``` -## medialibrary.getActivePeers - -getActivePeers(callback: AsyncCallback): void; - -获取活动注册设备 - -**需要权限**：ohos.permission.READ_MEDIA - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback> | 是 | 回调表示成功还是失败 | - -**示例：** - -``` -medialibrary.getActivePeers((err, data) => { - // do something -}); -``` - -## medialibrary.getActivePeers - -getActivePeers(): Promise; - -获取活动注册设备 - -**需要权限**：ohos.permission.READ_MEDIA - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore - -**参数：** - -返回值： - -| 类型 | 说明 | -| ------------------------------------- | --------------------------------- | -| Promise> | Promise实例，用于获取异步返回结果 | - -**示例：** - -``` -peerInfoList = medialibrary.getActivePeers(); -``` - -## medialibrary.getAllPeers - -getAllPeers(callback: AsyncCallback): void; - -获取所有注册设备 - -**需要权限**：ohos.permission.READ_MEDIA - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------ | ---- | ---------------------- | -| callback | AsyncCallback> | 是 | 回调表示成功还是失败 | - -**示例：** - -``` -medialibrary.getAllPeers((err, data) => { - // do something -}); -``` - -## medialibrary.getAllPeers - -getAllPeers(): Promise; - -获取所有注册设备 - -**需要权限**：ohos.permission.READ_MEDIA - -**系统能力**：SystemCapability.Multimedia.MediaLibrary.DistributedCore - -**返回值：** - -| 类型 | 说明 | -| ------------------------------------- | --------------------------------- | -| Promise> | Promise实例，用于获取异步返回结果 | - -**示例：** - -peerInfoList = media.getAllPeers(); - ## medialibrary.release release(callback: AsyncCallback<void>): void; -释放MediaLibrary实例 +释放MediaLibrary实例，当用户确认后续不再使用MediaLibrary实例中的方法后调用release方法释放MediaLibrary实例。 **需要权限**：无 @@ -577,7 +404,7 @@ medialibrary.release((err, data) => { release(): Promise<void>; -释放MediaLibrary实例 (补充说明) +释放MediaLibrary实例，当用户确认后续不再使用MediaLibrary实例中的方法后调用release方法释放MediaLibrary实例。 **需要权限**：无 @@ -669,7 +496,7 @@ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -703,7 +530,7 @@ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -735,7 +562,7 @@ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -767,7 +594,7 @@ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.MEDIA_WRITE（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（‘w’模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -804,7 +631,7 @@ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -843,7 +670,7 @@ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -994,7 +821,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1028,7 +855,7 @@ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1143,7 +970,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1180,7 +1007,7 @@ trash(isTrash: boolean,): Promise<void>; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1748,7 +1575,7 @@ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1783,7 +1610,7 @@ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.MEDIA_WRITE +**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core -- Gitee From 5f2b7556db0c2b459d849257ab260e3e59a53cab Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 3 Mar 2022 14:49:57 +0800 Subject: [PATCH 12/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 58 +++++++++---------- 1 file changed, 27 insertions(+), 31 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 8f91da0a391..ee1e26d7224 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -137,7 +137,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| ``` medialibrary.on('imageChange', () => { - this.sendNotify('image'); + // image file had changed, do something }) ``` ## medialibrary.off @@ -163,7 +163,7 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' ``` medialibrary.off('imageChange', () => { - this.sendNotify('image'); + // stop listening success }) ``` @@ -183,7 +183,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal | ------------ | -------------------------------------- | ---- | ------------------------------------------------------------ | | mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | | displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | +| relativePath | string | 是 | 相对公共目录路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | | callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** @@ -262,7 +262,7 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; media.getPublicDirectory(DIR_CAMERA，(err, dicResult) => { if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory passed'); + console.info('MediaLibraryTest : getPublicDirectory'); } else { console.info('MediaLibraryTest : getPublicDirectory failed'); } @@ -297,7 +297,7 @@ getPublicDirectory(type: DirectoryType): Promise; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory passed'); + console.info('MediaLibraryTest : getPublicDirectory'); } else { console.info('MediaLibraryTest : getPublicDirectory failed'); } @@ -327,17 +327,15 @@ let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], }; -medialibrary.AlbumNoArgsfetchOp, (err, albumList) => { +medialibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { if (albumList != undefined) { const album = albumList[0]; console.info('album.albumName = ' + album.albumName); console.info('album.count = ' + album.count); - done(); } else { console.info('getAlbum fail, message = ' + err); - done(); } -}); +}) ``` ## medialibrary.getAlbums @@ -580,11 +578,11 @@ let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; asset = await media.createAsset(mediaType, "image00003.jpg", path); asset.open('rw', (openError, fd) => { - if(fd > 0){ - asset.close(fd); - }else{ - console.info('File Open Failed!' + openError); - } + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } }); ``` @@ -617,11 +615,11 @@ let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; asset = await media.createAsset(mediaType, "image00003.jpg", path); asset.open('rw').then((openError, fd) => { - if(fd > 0){ - asset.close(fd); - }else{ - console.info('File Open Failed!' + openError); - } + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } }); ``` @@ -1072,15 +1070,13 @@ const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.isTrash(isTrashCallBack); function isTrashCallBack(err, isTrash) { - if (isTrash == true) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); - asset.trash(true, trashCallBack); - - } else { - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); - - } + if (isTrash == true) { + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); + asset.trash(true, trashCallBack); + } else { + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); + } } ``` @@ -1732,7 +1728,7 @@ FileAsset | mediaType | MediaType | 是 | 否 | 媒体类型 | | displayName | string | 是 | 是 | 显示文件名 | | title | string | 是 | 是 | 文件标题 | -| relativePath | string | 是 | 是 | 相对路径 | +| relativePath | string | 是 | 是 | 相对公共目录路径 | | parent | number | 是 | 否 | 父目录id | | size | number | 是 | 否 | 文件大小(单位：字节) | | dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | @@ -1785,7 +1781,7 @@ FileKey | 名称 | 默认值 | 描述 | | ------------- | ------------------- | ------------------------------------------------------ | | ID | file_id | 文件编号 | -| RELATIVE_PATH | relative_path | 相对路径 | +| RELATIVE_PATH | relative_path | 相对公共目录路径 | | DISPLAY_NAME | display_name | 显示名字 | | PARENT | parent | 父目录id | | MIME_TYPE | mime_type | 文件扩展属性 | @@ -1840,7 +1836,7 @@ DeviceType | 名称 | 类型 | 可读 | 可写 | 必填 |说明 | | ------------- | ------------- | ---- | ---- | ---- |---------------- | | selections | string | 是 | 是 |是 | 检索条件 | -| selectionArgs | Array | 是 | 是 |是 | 检索条件的值 | +| selectionArgs | Array<string> | 是 | 是 |是 | 检索条件的值 | | order | string | 是 | 是 | 否 |检索结果排序方式 | | uri | string | 是 | 是 | 否 |文件URI | | networkId | string | 是 | 是 | 否 |注册设备网络ID | -- Gitee From c74300296a1d2d01c030fccf8a534f33ad58ee92 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 3 Mar 2022 14:54:55 +0800 Subject: [PATCH 13/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 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 ee1e26d7224..d7c00987327 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -19,7 +19,7 @@ function getMediaLibrary(context: Context): MediaLibrary; **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | -------------------- | @@ -44,7 +44,7 @@ var mediaLibrary = mediaLibrary.getMediaLibrary(context); ## medialibrary.getFileAssets -getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; 获取文件资源，使用callback方式返回异步结果。 @@ -137,7 +137,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| ``` medialibrary.on('imageChange', () => { - // image file had changed, do something + // image file had changed, do something }) ``` ## medialibrary.off @@ -240,7 +240,7 @@ medialibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) ## medialibrary.getPublicDirectory -getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; +getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void; 获取公共目录路径 @@ -271,7 +271,7 @@ media.getPublicDirectory(DIR_CAMERA，(err, dicResult) => { ## medialibrary.getPublicDirectory -getPublicDirectory(type: DirectoryType): Promise; +getPublicDirectory(type: DirectoryType): Promise<string>; 获取公共目录路径 @@ -297,7 +297,7 @@ getPublicDirectory(type: DirectoryType): Promise; let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory'); + console.info('MediaLibraryTest : getPublicDirectory'); } else { console.info('MediaLibraryTest : getPublicDirectory failed'); } @@ -518,7 +518,7 @@ const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.title = ‘newtitle'; asset.commitModify(() => { - console.info('commitModify success'); + console.info('commitModify success'); } ``` @@ -1186,7 +1186,7 @@ for (var i = 1; i < fetchCount; i++) { console.info('MediaLibraryTest : isAfterLast:' + result); console.info('MediaLibraryTest : isAfterLast end'); fetchFileResult.close(); - + } } ``` @@ -1814,7 +1814,7 @@ DirectoryType | DIR_DOCUMENTS | 4 | 表示文档路径 | | DIR_DOWNLOAD | 5 | 表示下载路径 | -DeviceType +DeviceType ----------- 枚举，设备类型。 @@ -1829,7 +1829,7 @@ DeviceType | TYPE_CAR | 5 | 车载设备 | | TYPE_TV | 6 | 电视设备 | -## MediaFetchOptions +## MediaFetchOptions 检索条件。 -- Gitee From 1f2823b2fdd4628610374513027fe62a705673d0 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Fri, 4 Mar 2022 09:13:00 +0800 Subject: [PATCH 14/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 1039 +++++++++-------- 1 file changed, 559 insertions(+), 480 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 d7c00987327..7723c69dc0e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -35,7 +35,7 @@ function getMediaLibrary(context: Context): MediaLibrary; ``` import featureAbility from '@ohos.ability.featureAbility'; -import mediaLibrary from ‘ohos.multimedia.mediaLibrary'; +import mediaLibrary from '@ohos.multimedia.mediaLibrary'; var context = featureAbility.getContext() var mediaLibrary = mediaLibrary.getMediaLibrary(context); @@ -44,7 +44,7 @@ var mediaLibrary = mediaLibrary.getMediaLibrary(context); ## medialibrary.getFileAssets -getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; 获取文件资源，使用callback方式返回异步结果。 @@ -75,7 +75,8 @@ medialibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { if (fileAssetList != undefined) { fileAssetList.forEach(getAllObjectInfo); } - }); + }); + } }); ``` ## medialibrary.getFileAssets @@ -294,12 +295,14 @@ getPublicDirectory(type: DirectoryType): Promise<string>; **示例：** ``` -let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; -const dicResult = await media.getPublicDirectory(DIR_CAMERA); -if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory'); -} else { - console.info('MediaLibraryTest : getPublicDirectory failed'); +async function (done) { + let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; + const dicResult = await media.getPublicDirectory(DIR_CAMERA); + if (dicResult == 'camera/') { + console.info('MediaLibraryTest : getPublicDirectory'); + } else { + console.info('MediaLibraryTest : getPublicDirectory failed'); + } } ``` @@ -393,7 +396,8 @@ release(callback: AsyncCallback<void>): void; **示例：** ``` -medialibrary.release((err, data) => { +var mediaLibrary = mediaLibrary.getMediaLibrary(context); +mediaLibrary.release((err, data) => { // do something }); ``` @@ -417,7 +421,8 @@ release(): Promise<void>; **示例：** ``` -medialibrary.release() +var mediaLibrary = mediaLibrary.getMediaLibrary(context); +mediaLibrary.release() ``` ## FileAsset.isDirectory @@ -439,18 +444,20 @@ isDirectory(callback: AsyncCallback<boolean>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isDirectory((err, isDirectory) => { - // do something -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isDirectory((err, isDirectory) => { + // do something + }); +} ``` ## FileAsset.isDirectory @@ -472,20 +479,22 @@ isDirectory():Promise<boolean>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isDirectory().then(function(isDirectory){ - console.info("isDirectory result:"+ isDirectory); -}).catch(function(err){ - console.info("isDirectory failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isDirectory().then(function(isDirectory){ + console.info("isDirectory result:"+ isDirectory); + }).catch(function(err){ + console.info("isDirectory failed with error:"+ err); + }); +} ``` ## FileAsset.commitModify @@ -507,18 +516,20 @@ commitModify(callback: AsyncCallback<void>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.title = ‘newtitle'; -asset.commitModify(() => { - console.info('commitModify success'); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.title = ‘newtitle'; + asset.commitModify(() => { + console.info('commitModify success'); + } } ``` @@ -541,17 +552,19 @@ commitModify(): Promise<void>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.title = ‘newtitle'; -asset.commitModify(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.title = ‘newtitle'; + asset.commitModify(); +} ``` ## FileAsset.open @@ -574,16 +587,18 @@ open(mode: string, callback: AsyncCallback<number>): void; **示例：** ``` -let mediaType = mediaLibrary.MediaType.IMAGE; -let path = "Pictures/"; -asset = await media.createAsset(mediaType, "image00003.jpg", path); -asset.open('rw', (openError, fd) => { - if(fd > 0){ - asset.close(fd); - }else{ - console.info('File Open Failed!' + openError); - } -}); +async function (done) { + let mediaType = mediaLibrary.MediaType.IMAGE; + let path = "Pictures/"; + asset = await media.createAsset(mediaType, "image00003.jpg", path); + asset.open('rw', (openError, fd) => { + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } + }); +} ``` ## FileAsset.open @@ -611,16 +626,18 @@ open(mode: string): Promise<number>; **示例：** ``` -let mediaType = mediaLibrary.MediaType.IMAGE; -let path = "Pictures/"; -asset = await media.createAsset(mediaType, "image00003.jpg", path); -asset.open('rw').then((openError, fd) => { - if(fd > 0){ - asset.close(fd); - }else{ - console.info('File Open Failed!' + openError); - } -}); +async function (done) { + let mediaType = mediaLibrary.MediaType.IMAGE; + let path = "Pictures/"; + asset = await media.createAsset(mediaType, "image00003.jpg", path); + asset.open('rw').then((openError, fd) => { + if(fd > 0){ + asset.close(fd); + }else{ + console.info('File Open Failed!' + openError); + } + }); +} ``` ## FileAsset.close @@ -643,23 +660,25 @@ close(fd: number, callback: AsyncCallback<void>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.close(fd, (closeErr) => { - if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); - } else { - console.info("=======asset.close success====>"); - } -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.close(fd, (closeErr) => { + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + } else { + console.info("=======asset.close success====>"); + } + }); +} ``` ## FileAsset.close @@ -687,24 +706,26 @@ close(fd: number): Promise<void>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.close(fd).then((closeErr) => { - if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); - - } else { - console.info("=======asset.close success====>"); - } -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.close(fd).then((closeErr) => { + if (closeErr != undefined) { + console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + + } else { + console.info("=======asset.close success====>"); + } + }); +} ``` ## FileAsset.getThumbnail @@ -726,18 +747,20 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.getThumbnail((err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.getThumbnail((err, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + }); +} ``` ## FileAsset.getThumbnail @@ -760,18 +783,20 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.getThumbnail(size, (err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.getThumbnail(size, (err, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + }); +} ``` ## FileAsset.getThumbnail @@ -799,18 +824,20 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.getThumbnail(size, (err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.getThumbnail(size, (err, pixelmap) => { + console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + }); +} ``` ## FileAsset.favorite @@ -833,18 +860,20 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.favorite(true,function(err){ - // do something -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.favorite(true,function(err){ + // do something + }); +} ``` ## FileAsset.favorite @@ -872,20 +901,22 @@ favorite(isFavorite: boolean): Promise<void>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.favorite(true).then(function() { - console.info("favorite successfully"); -}).catch(function(err){ - console.info("favorite failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.favorite(true).then(function() { + console.info("favorite successfully"); + }).catch(function(err){ + console.info("favorite failed with error:"+ err); + }); +} ``` ## FileAsset.isFavorite @@ -907,22 +938,24 @@ isFavorite(callback: AsyncCallback<boolean>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isFavorite((err, isFavorite) => { - if (isFavorite) { - console.info('FileAsset is favorite'); - }else{ - console.info('FileAsset is not favorite'); - } -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isFavorite((err, isFavorite) => { + if (isFavorite) { + console.info('FileAsset is favorite'); + }else{ + console.info('FileAsset is not favorite'); + } + }); +} ``` ## FileAsset.isFavorite @@ -944,20 +977,22 @@ isFavorite():Promise<boolean>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isFavorite().then(function(isFavorite){ - console.info("isFavorite result:"+ isFavorite); -}).catch(function(err){ - console.info("isFavorite failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isFavorite().then(function(isFavorite){ + console.info("isFavorite result:"+ isFavorite); + }).catch(function(err){ + console.info("isFavorite failed with error:"+ err); + }); +} ``` ## FileAsset.trash @@ -982,18 +1017,20 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.trash(true, trashCallBack); -function trashCallBack(err, trash) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.trash(true, trashCallBack); + function trashCallBack(err, trash) { + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); + } } ``` @@ -1024,20 +1061,22 @@ trash(isTrash: boolean,): Promise<void>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.trash(true).then(function() { - console.info("trash successfully"); -}).catch(function(err){ - console.info("trash failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.trash(true).then(function() { + console.info("trash successfully"); + }).catch(function(err){ + console.info("trash failed with error:"+ err); + }); +} ``` ## FileAsset.isTrash @@ -1059,23 +1098,27 @@ isTrash(callback: AsyncCallback<boolean>): void; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isTrash(isTrashCallBack); -function isTrashCallBack(err, isTrash) { - if (isTrash == true) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); - asset.trash(true, trashCallBack); - } else { - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isTrash(isTrashCallBack); + function isTrashCallBack(err, isTrash) { + if (isTrash == true) { + console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); + asset.trash(true, trashCallBack); + + } else { + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); + console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); + + } } } ``` @@ -1099,20 +1142,22 @@ isTrash():Promise<boolean>; **示例：** ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -const fetchFileResult = await media.getFileAssets(getImageOp); -const asset = await fetchFileResult.getFirstObject(); -asset.isTrash().then(function(isTrash){ - console.info("isTrash result:"+ isTrash); -}).catch(function(err){ - console.info("isTrash failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + const fetchFileResult = await media.getFileAssets(getImageOp); + const asset = await fetchFileResult.getFirstObject(); + asset.isTrash().then(function(isTrash){ + console.info("isTrash result:"+ isTrash); + }).catch(function(err){ + console.info("isTrash failed with error:"+ err); + }); +} ``` **FetchFileResult** @@ -1138,14 +1183,16 @@ getCount(): number; **示例**： ``` -let getFileCountOneOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [fileType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,1", -}; -let fetchFileResult = await media.getFileAssets(getFileCountOneOp); -const fetchCount = fetchFileResult.getCount(); +async function (done) { + let getFileCountOneOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [fileType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,1", + }; + let fetchFileResult = await media.getFileAssets(getFileCountOneOp); + const fetchCount = fetchFileResult.getCount(); +} ``` ## FetchFileResult.isAfterLast @@ -1167,27 +1214,29 @@ isAfterLast(): boolean; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -const fetchCount = fetchFileResult.getCount(); -console.info('MediaLibraryTest : count:' + fetchCount); -let fileAsset = await fetchFileResult.getFirstObject(); -for (var i = 1; i < fetchCount; i++) { - fileAsset = await fetchFileResult.getNextObject(); - if(i == fetchCount - 1) { - console.info('MediaLibraryTest : isLast'); - var result = fetchFileResult.isAfterLast(); - console.info('MediaLibraryTest : isAfterLast:' + result); - console.info('MediaLibraryTest : isAfterLast end'); - fetchFileResult.close(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + const fetchCount = fetchFileResult.getCount(); + console.info('MediaLibraryTest : count:' + fetchCount); + let fileAsset = await fetchFileResult.getFirstObject(); + for (var i = 1; i < fetchCount; i++) { + fileAsset = await fetchFileResult.getNextObject(); + if(i == fetchCount - 1) { + console.info('MediaLibraryTest : isLast'); + var result = fetchFileResult.isAfterLast(); + console.info('MediaLibraryTest : isAfterLast:' + result); + console.info('MediaLibraryTest : isAfterLast end'); + fetchFileResult.close(); - } + } + } } ``` @@ -1204,15 +1253,17 @@ close(): void; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.close(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.close(); +} ``` ## FetchFileResult.getFirstObject @@ -1234,21 +1285,23 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getFirstObject((err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getFirstObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getFirstObject @@ -1271,19 +1324,21 @@ getFirstObject(): Promise<FileAsset>; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getFirstObject().then(function(fileAsset){ - console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset)); -}).catch(function(err){ - console.info("getFirstObject failed with error:"+ err); -}); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getFirstObject().then(function(fileAsset){ + console.info("getFirstObject successfully:"+ JSON.stringify(fileAsset)); + }).catch(function(err){ + console.info("getFirstObject failed with error:"+ err); + }); +} ``` ## FetchFileResult.getNextObject @@ -1305,21 +1360,23 @@ fetchFileResult.getFirstObject().then(function(fileAsset){ **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getNextObject((err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getNextObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getNextObject @@ -1341,17 +1398,19 @@ fetchFileResult.getNextObject((err, value) => { **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -const fetchCount = fetchFileResult.getCount(); -console.info('MediaLibraryTest : count:' + fetchCount); -fileAsset = await fetchFileResult.getNextObject(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + const fetchCount = fetchFileResult.getCount(); + console.info('MediaLibraryTest : count:' + fetchCount); + fileAsset = await fetchFileResult.getNextObject(); +} ``` ## FetchFileResult.getLastObject @@ -1373,21 +1432,23 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getLastObject((err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getLastObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getLastObject @@ -1409,15 +1470,17 @@ getLastObject(): Promise<FileAsset>; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -let lastObject = await fetchFileResult.getLastObject(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + let lastObject = await fetchFileResult.getLastObject(); +} ``` ## FetchFileResult.getPositionObject @@ -1440,21 +1503,23 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getPositionObject(1，(err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getPositionObject(1，(err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getPositionObject @@ -1482,21 +1547,23 @@ getPositionObject(index: number): Promise<FileAsset>; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getPositionObject(1，(err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getPositionObject(1，(err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getAllObject @@ -1518,21 +1585,23 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -fetchFileResult.getAllObject((err, value) => { - if (err) { - console.error('Failed '); - return; - } - console.log(value); -}) +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + fetchFileResult.getAllObject((err, value) => { + if (err) { + console.error('Failed '); + return; + } + console.log(value); + }) +} ``` ## FetchFileResult.getAllObject @@ -1554,15 +1623,17 @@ getAllObject(): Promise<Array<FileAsset>>; **示例**： ``` -let imageType = mediaLibrary.MediaType.IMAGE; -let getImageOp = { - selections: fileKeyObj.MEDIA_TYPE + '= ?', - selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", -}; -let fetchFileResult = await media.getFileAssets(getImageOp); -var data = fetchFileResult.getAllObject(); +async function (done) { + let imageType = mediaLibrary.MediaType.IMAGE; + let getImageOp = { + selections: fileKeyObj.MEDIA_TYPE + '= ?', + selectionArgs: [imageType.toString()], + order: fileKeyObj.DATE_ADDED, + extendArgs: "LIMIT 0,10", + }; + let fetchFileResult = await media.getFileAssets(getImageOp); + var data = fetchFileResult.getAllObject(); +} ``` ## Album.commitModify @@ -1584,20 +1655,22 @@ commitModify(callback: AsyncCallback<void>): void; **示例**： ``` -let AlbumNoArgsfetchOp = { - selections: '', - selectionArgs: [], -}; -const albumList = await media.getAlbums(AlbumNoArgsfetchOp); -const album = albumList[0]; -album.albumName = 'hello'; -album.commitModify((err) => { - if (err) { - console.error('Failed '); - return; - } - console.log('Modify successful.'); -}) +async function (done) { + let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], + }; + const albumList = await media.getAlbums(AlbumNoArgsfetchOp); + const album = albumList[0]; + album.albumName = 'hello'; + album.commitModify((err) => { + if (err) { + console.error('Failed '); + return; + } + console.log('Modify successful.'); + }) +} ``` ## Album.commitModify @@ -1619,18 +1692,20 @@ commitModify(): Promise<void>; **示例**： ``` -let AlbumNoArgsfetchOp = { - selections: '', - selectionArgs: [], -}; -const albumList = await media.getAlbums(AlbumNoArgsfetchOp); -const album = albumList[0]; -album.albumName = 'hello'; -album.commitModify().then(function() { - console.info("commitModify successfully"); -}).catch(function(err){ - console.info("commitModify failed with error:"+ err); -}); +async function (done) { + let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], + }; + const albumList = await media.getAlbums(AlbumNoArgsfetchOp); + const album = albumList[0]; + album.albumName = 'hello'; + album.commitModify().then(function() { + console.info("commitModify successfully"); + }).catch(function(err){ + console.info("commitModify failed with error:"+ err); + }); +} ``` ## Album.getFileAssets @@ -1653,16 +1728,18 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **示例**： ``` -let AlbumNoArgsfetchOp = { - selections: '', - selectionArgs: [], -}; -const albumList = await media.getAlbums(AlbumNoArgsfetchOp); -const album = albumList[0]; -album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack); -}) -function getFileAssetsCallBack(err, fetchFileResult) { - // do something +async function (done) { + let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], + }; + const albumList = await media.getAlbums(AlbumNoArgsfetchOp); + const album = albumList[0]; + album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack); + }) + function getFileAssetsCallBack(err, fetchFileResult) { + // do something + } } ``` @@ -1691,17 +1768,19 @@ function getFileAssetsCallBack(err, fetchFileResult) { **示例**： ``` -let AlbumNoArgsfetchOp = { - selections: '', - selectionArgs: [], -}; -const albumList = await media.getAlbums(AlbumNoArgsfetchOp); -const album = albumList[0]; -album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ - console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); -}).catch(function(err){ - console.info("getFileAssets failed with error:"+ err); -}); +async function (done) { + let AlbumNoArgsfetchOp = { + selections: '', + selectionArgs: [], + }; + const albumList = await media.getAlbums(AlbumNoArgsfetchOp); + const album = albumList[0]; + album.getFileAssets(fileNoArgsfetchOp).then(function(albumFetchFileResult){ + console.info("getFileAssets successfully:"+ JSON.stringify(albumFetchFileResult)); + }).catch(function(err){ + console.info("getFileAssets failed with error:"+ err); + }); +} ``` ## PeerInfo -- Gitee From 2bd6e6ce48de1782eb8b8159f18a87a79cb3d403 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Sun, 6 Mar 2022 10:50:36 +0800 Subject: [PATCH 15/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 226 +++++++++--------- 1 file changed, 113 insertions(+), 113 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 7723c69dc0e..0f2fad66ffc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -1,11 +1,13 @@ 媒体库管理 ========== - +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 + 导入模块 --------- ``` -import medialibrary from '@ohos.multimedia.medialibrary'; +import mediaLibrary from '@ohos.multimedia.medialibrary'; ``` @@ -19,7 +21,7 @@ function getMediaLibrary(context: Context): MediaLibrary; **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core -**参数：** +**参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | -------------------- | @@ -29,19 +31,18 @@ function getMediaLibrary(context: Context): MediaLibrary; | 类型 | 说明 | | ------------ | :----- | -| MediaLibrary | 媒体库实例 | +| mediaLibrary | 媒体库实例 | **示例：** ``` import featureAbility from '@ohos.ability.featureAbility'; -import mediaLibrary from '@ohos.multimedia.mediaLibrary'; var context = featureAbility.getContext() -var mediaLibrary = mediaLibrary.getMediaLibrary(context); +var media = mediaLibrary.getMediaLibrary(context); ``` -## medialibrary.getFileAssets +## mediaLibrary.getFileAssets8+ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; @@ -68,9 +69,9 @@ let imagesfetchOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], }; -medialibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { +mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { if (fetchFileResult != undefined) { - console.info('MediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); + console.info('mediaLibraryTest : ASSET_CALLBACK fetchFileResult success'); fetchFileResult.getAllObject((err, fileAssetList) => { if (fileAssetList != undefined) { fileAssetList.forEach(getAllObjectInfo); @@ -79,7 +80,7 @@ medialibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { } }); ``` -## medialibrary.getFileAssets +## mediaLibrary.getFileAssets8+ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; @@ -110,14 +111,14 @@ let imagesfetchOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], }; -medialibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){ +mediaLibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){ console.info("getFileAssets successfully:"+ JSON.stringify(dir)); }).catch(function(err){ console.info("getFileAssets failed with error:"+ err); }); ``` -## medialibrary.on +## mediaLibrary.on8+ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; @@ -131,17 +132,17 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
’audioChange‘：  音频文件变更
‘videoChange’：  视频文件变更
‘'fileChange'：  文件变更
‘remoteFileChange’： 注册设备上文件变更 | +| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | | callback | callback<void> | 是 | 回调返回空 | **示例：** ``` -medialibrary.on('imageChange', () => { +mediaLibrary.on('imageChange', () => { // image file had changed, do something }) ``` -## medialibrary.off +## mediaLibrary.off8+ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void; @@ -157,24 +158,24 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
’audioChange‘：  音频文件变更
‘videoChange’：  视频文件变更
‘'fileChange'：  文件变更
‘remoteFileChange’： 注册设备上文件变更 | +| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | | callback | callback<void> | 否 | 回调返回空 | **示例：** ``` -medialibrary.off('imageChange', () => { +mediaLibrary.off('imageChange', () => { // stop listening success }) ``` -## medialibrary.createAsset +## mediaLibrary.createAsset 8+ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void; 创建媒体资源，使用callback方式返回结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -193,7 +194,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal // 使用Callback方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; -medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, fileAsset) => { +mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path, (err, fileAsset) => { if (fileAsset != undefined) { console.info('createAsset successfully, message = ' + err); } else { @@ -202,13 +203,13 @@ medialibrary.createAsset(mediaType, “imageCallBack.jpg”, path, (err, fileAss }); ``` -## medialibrary.createAsset +## mediaLibrary.createAsset8+ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset>; 创建媒体资源，使用Promise方式返回结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -232,14 +233,14 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr // 使用Promise方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; -medialibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) { +mediaLibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) { console.info("createAsset successfully:"+ JSON.stringify(asset)); }).catch(function(err){ console.info("createAsset failed with error:"+ err); }); ``` -## medialibrary.getPublicDirectory +## mediaLibrary.getPublicDirectory8+ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void; @@ -261,16 +262,16 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): ``` let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; -media.getPublicDirectory(DIR_CAMERA，(err, dicResult) => { +media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { if (dicResult == 'camera/') { - console.info('MediaLibraryTest : getPublicDirectory'); + console.info('mediaLibraryTest : getPublicDirectory passed'); } else { - console.info('MediaLibraryTest : getPublicDirectory failed'); + console.info('mediaLibraryTest : getPublicDirectory failed'); } }); ``` -## medialibrary.getPublicDirectory +## mediaLibrary.getPublicDirectory8+ getPublicDirectory(type: DirectoryType): Promise<string>; @@ -306,7 +307,7 @@ async function (done) { } ``` -## medialibrary.getAlbums +## mediaLibrary.getAlbums6+ getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void; @@ -330,7 +331,7 @@ let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], }; -medialibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { +mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { if (albumList != undefined) { const album = albumList[0]; console.info('album.albumName = ' + album.albumName); @@ -341,7 +342,7 @@ medialibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { }) ``` -## medialibrary.getAlbums +## mediaLibrary.getAlbums6+ getAlbums(options: MediaFetchOptions): Promise; @@ -370,18 +371,18 @@ let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], }; -medialibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ +mediaLibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ console.info("getAlbums successfully:"+ JSON.stringify(albumList)); }).catch(function(err){ console.info("getAlbums failed with error:"+ err); }); ``` -## medialibrary.release +## mediaLibrary.release8+ release(callback: AsyncCallback<void>): void; -释放MediaLibrary实例，当用户确认后续不再使用MediaLibrary实例中的方法后调用release方法释放MediaLibrary实例。 +释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 **需要权限**：无 @@ -396,17 +397,17 @@ release(callback: AsyncCallback<void>): void; **示例：** ``` -var mediaLibrary = mediaLibrary.getMediaLibrary(context); -mediaLibrary.release((err, data) => { +var media = mediaLibrary.getMediaLibrary(context); +media.release((err, data) => { // do something }); ``` -## medialibrary.release +## mediaLibrary.release8+ release(): Promise<void>; -释放MediaLibrary实例，当用户确认后续不再使用MediaLibrary实例中的方法后调用release方法释放MediaLibrary实例。 +释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 **需要权限**：无 @@ -421,11 +422,11 @@ release(): Promise<void>; **示例：** ``` -var mediaLibrary = mediaLibrary.getMediaLibrary(context); -mediaLibrary.release() +var media = mediaLibrary.getMediaLibrary(context); +media.release() ``` -## FileAsset.isDirectory +## FileAsset.isDirectory8+ isDirectory(callback: AsyncCallback<boolean>): void; @@ -460,7 +461,7 @@ async function (done) { } ``` -## FileAsset.isDirectory +## FileAsset.isDirectory8+ isDirectory():Promise<boolean>; @@ -497,13 +498,13 @@ async function (done) { } ``` -## FileAsset.commitModify +## FileAsset.commitModify8+ commitModify(callback: AsyncCallback<void>): void; 修改文件的元数据，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -526,20 +527,20 @@ async function (done) { }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); - asset.title = ‘newtitle'; + asset.title = 'newtitle'; asset.commitModify(() => { console.info('commitModify success'); - } + }); } ``` -## FileAsset.commitModify +## FileAsset.commitModify8+ commitModify(): Promise<void>; 修改文件的元数据，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -562,18 +563,18 @@ async function (done) { }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); - asset.title = ‘newtitle'; + asset.title = 'newtitle'; asset.commitModify(); } ``` -## FileAsset.open +## FileAsset.open8+ open(mode: string, callback: AsyncCallback<number>): void; 打开当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -601,13 +602,13 @@ async function (done) { } ``` -## FileAsset.open +## FileAsset.open8+ open(mode: string): Promise<number>; 打开当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（‘w’模式打开） +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -640,13 +641,13 @@ async function (done) { } ``` -## FileAsset.close +## FileAsset.close8+ close(fd: number, callback: AsyncCallback<void>): void; 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -672,8 +673,8 @@ async function (done) { const asset = await fetchFileResult.getFirstObject(); asset.close(fd, (closeErr) => { if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + console.info('mediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL'); } else { console.info("=======asset.close success====>"); } @@ -681,13 +682,13 @@ async function (done) { } ``` -## FileAsset.close +## FileAsset.close8+ close(fd: number): Promise<void>; 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -718,8 +719,8 @@ async function (done) { const asset = await fetchFileResult.getFirstObject(); asset.close(fd).then((closeErr) => { if (closeErr != undefined) { - console.info('MediaLibraryTest : close : FAIL ' + closeErr.message); - console.info('MediaLibraryTest : ASSET_CALLBACK : FAIL'); + console.info('mediaLibraryTest : close : FAIL ' + closeErr.message); + console.info('mediaLibraryTest : ASSET_CALLBACK : FAIL'); } else { console.info("=======asset.close success====>"); @@ -728,7 +729,7 @@ async function (done) { } ``` -## FileAsset.getThumbnail +## FileAsset.getThumbnail8+ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; @@ -758,12 +759,12 @@ async function (done) { const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail((err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); } ``` -## FileAsset.getThumbnail +## FileAsset.getThumbnail8+ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; @@ -794,12 +795,12 @@ async function (done) { const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail(size, (err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); } ``` -## FileAsset.getThumbnail +## FileAsset.getThumbnail8+ getThumbnail(size?: Size): Promise<image.PixelMap>; @@ -835,18 +836,18 @@ async function (done) { const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); asset.getThumbnail(size, (err, pixelmap) => { - console.info('MediaLibraryTest : getThumbnail Successfull '+ pixelmap); + console.info('mediaLibraryTest : getThumbnail Successfull '+ pixelmap); }); } ``` -## FileAsset.favorite +## FileAsset.favorite8+ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; 将文件设置为收藏文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -876,13 +877,13 @@ async function (done) { } ``` -## FileAsset.favorite +## FileAsset.favorite8+ favorite(isFavorite: boolean): Promise<void>; 将文件设置为收藏文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -919,7 +920,7 @@ async function (done) { } ``` -## FileAsset.isFavorite +## FileAsset.isFavorite8+ isFavorite(callback: AsyncCallback<boolean>): void; @@ -958,7 +959,7 @@ async function (done) { } ``` -## FileAsset.isFavorite +## FileAsset.isFavorite8+ isFavorite():Promise<boolean>; @@ -995,7 +996,7 @@ async function (done) { } ``` -## FileAsset.trash +## FileAsset.trash8+ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; @@ -1003,7 +1004,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1029,12 +1030,12 @@ async function (done) { const asset = await fetchFileResult.getFirstObject(); asset.trash(true, trashCallBack); function trashCallBack(err, trash) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); + console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK trash'); } } ``` -## FileAsset.trash +## FileAsset.trash8+ trash(isTrash: boolean,): Promise<void>; @@ -1042,7 +1043,7 @@ trash(isTrash: boolean,): Promise<void>; 放入垃圾文件夹的文件不会被真正删除，可以通过isTrash = false参数恢复成正常文件。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1079,7 +1080,7 @@ async function (done) { } ``` -## FileAsset.isTrash +## FileAsset.isTrash8+ isTrash(callback: AsyncCallback<boolean>): void; @@ -1111,19 +1112,19 @@ async function (done) { asset.isTrash(isTrashCallBack); function isTrashCallBack(err, isTrash) { if (isTrash == true) { - console.info('MediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); + console.info('mediaLibraryTest : ASSET_CALLBACK ASSET_CALLBACK isTrash = ' + isTrash); asset.trash(true, trashCallBack); } else { - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); - console.info('MediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); + console.info('mediaLibraryTest : ASSET_CALLBACK isTrash Unsuccessfull = ' + err); + console.info('mediaLibraryTest : ASSET_CALLBACK isTrash : FAIL'); } } } ``` -## FileAsset.isTrash +## FileAsset.isTrash8+ isTrash():Promise<boolean>; @@ -1164,7 +1165,7 @@ async function (done) { 文件检索结果集。 -## FetchFileResult.getCount +## FetchFileResult.getCount8+ getCount(): number; @@ -1195,7 +1196,7 @@ async function (done) { } ``` -## FetchFileResult.isAfterLast +## FetchFileResult.isAfterLast8+ isAfterLast(): boolean; @@ -1224,15 +1225,15 @@ async function (done) { }; let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); - console.info('MediaLibraryTest : count:' + fetchCount); + console.info('mediaLibraryTest : count:' + fetchCount); let fileAsset = await fetchFileResult.getFirstObject(); for (var i = 1; i < fetchCount; i++) { fileAsset = await fetchFileResult.getNextObject(); if(i == fetchCount - 1) { - console.info('MediaLibraryTest : isLast'); + console.info('mediaLibraryTest : isLast'); var result = fetchFileResult.isAfterLast(); - console.info('MediaLibraryTest : isAfterLast:' + result); - console.info('MediaLibraryTest : isAfterLast end'); + console.info('mediaLibraryTest : isAfterLast:' + result); + console.info('mediaLibraryTest : isAfterLast end'); fetchFileResult.close(); } @@ -1240,7 +1241,7 @@ async function (done) { } ``` -## FetchFileResult.close +## FetchFileResult.close8+ close(): void; @@ -1266,7 +1267,7 @@ async function (done) { } ``` -## FetchFileResult.getFirstObject +## FetchFileResult.getFirstObject8+ getFirstObject(callback: AsyncCallback<FileAsset>): void; @@ -1304,7 +1305,7 @@ async function (done) { } ``` -## FetchFileResult.getFirstObject +## FetchFileResult.getFirstObject8+ getFirstObject(): Promise<FileAsset>; @@ -1341,7 +1342,7 @@ async function (done) { } ``` -## FetchFileResult.getNextObject +## FetchFileResult.getNextObject8+ getNextObject(callback: AsyncCallback<FileAsset>): void; @@ -1379,7 +1380,7 @@ async function (done) { } ``` -## FetchFileResult.getNextObject +## FetchFileResult.getNextObject8+ getNextObject(): Promise<FileAsset>; @@ -1408,12 +1409,12 @@ async function (done) { }; let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); - console.info('MediaLibraryTest : count:' + fetchCount); + console.info('mediaLibraryTest : count:' + fetchCount); fileAsset = await fetchFileResult.getNextObject(); } ``` -## FetchFileResult.getLastObject +## FetchFileResult.getLastObject8+ getLastObject(callback: AsyncCallback<FileAsset>): void; @@ -1451,7 +1452,7 @@ async function (done) { } ``` -## FetchFileResult.getLastObject +## FetchFileResult.getLastObject8+ getLastObject(): Promise<FileAsset>; @@ -1483,7 +1484,7 @@ async function (done) { } ``` -## FetchFileResult.getPositionObject +## FetchFileResult.getPositionObject8+ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void; @@ -1512,7 +1513,7 @@ async function (done) { extendArgs: "LIMIT 0,10", }; let fetchFileResult = await media.getFileAssets(getImageOp); - fetchFileResult.getPositionObject(1，(err, value) => { + fetchFileResult.getPositionObject(0, (err, value) => { if (err) { console.error('Failed '); return; @@ -1522,7 +1523,7 @@ async function (done) { } ``` -## FetchFileResult.getPositionObject +## FetchFileResult.getPositionObject8+ getPositionObject(index: number): Promise<FileAsset>; @@ -1556,7 +1557,7 @@ async function (done) { extendArgs: "LIMIT 0,10", }; let fetchFileResult = await media.getFileAssets(getImageOp); - fetchFileResult.getPositionObject(1，(err, value) => { + fetchFileResult.getPositionObject(1, (err, value) => { if (err) { console.error('Failed '); return; @@ -1566,7 +1567,7 @@ async function (done) { } ``` -## FetchFileResult.getAllObject +## FetchFileResult.getAllObject8+ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; @@ -1604,7 +1605,7 @@ async function (done) { } ``` -## FetchFileResult.getAllObject +## FetchFileResult.getAllObject8+ getAllObject(): Promise<Array<FileAsset>>; @@ -1636,13 +1637,13 @@ async function (done) { } ``` -## Album.commitModify +## Album.commitModify8+ commitModify(callback: AsyncCallback<void>): void; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1673,13 +1674,13 @@ async function (done) { } ``` -## Album.commitModify +## Album.commitModify8+ commitModify(): Promise<void>; 更新相册属性修改到数据库中。 -**需要权限**：ohos.permission.READ_MEDIA，ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1708,7 +1709,7 @@ async function (done) { } ``` -## Album.getFileAssets +## Album.getFileAssets8+ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; @@ -1736,14 +1737,13 @@ async function (done) { const albumList = await media.getAlbums(AlbumNoArgsfetchOp); const album = albumList[0]; album.getFileAssets(fileNoArgsfetchOp, getFileAssetsCallBack); - }) function getFileAssetsCallBack(err, fetchFileResult) { // do something } } ``` -## Album.getFileAssets +## Album.getFileAssets8+ getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult>; @@ -1783,7 +1783,7 @@ async function (done) { } ``` -## PeerInfo +## PeerInfo8+ 注册设备信息。 @@ -1908,7 +1908,7 @@ DeviceType | TYPE_CAR | 5 | 车载设备 | | TYPE_TV | 6 | 电视设备 | -## MediaFetchOptions +## MediaFetchOptions8+ 检索条件。 @@ -1921,7 +1921,7 @@ DeviceType | networkId | string | 是 | 是 | 否 |注册设备网络ID | | extendArgs | string | 是 | 是 | 否 |扩展的检索参数 | -## Size +## Size8+ 图片尺寸。 -- Gitee From bcbb0783d03c14b3e18e15dbf8bf0867dd286a4e Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 7 Mar 2022 11:10:09 +0800 Subject: [PATCH 16/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 74 +++++++++---------- 1 file changed, 37 insertions(+), 37 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 0f2fad66ffc..f1615341834 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -296,7 +296,7 @@ getPublicDirectory(type: DirectoryType): Promise<string>; **示例：** ``` -async function (done) { +async function example() { let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); if (dicResult == 'camera/') { @@ -445,7 +445,7 @@ isDirectory(callback: AsyncCallback<boolean>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -480,7 +480,7 @@ isDirectory():Promise<boolean>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -517,7 +517,7 @@ commitModify(callback: AsyncCallback<void>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -553,7 +553,7 @@ commitModify(): Promise<void>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -588,7 +588,7 @@ open(mode: string, callback: AsyncCallback<number>): void; **示例：** ``` -async function (done) { +async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; asset = await media.createAsset(mediaType, "image00003.jpg", path); @@ -627,7 +627,7 @@ open(mode: string): Promise<number>; **示例：** ``` -async function (done) { +async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; let path = "Pictures/"; asset = await media.createAsset(mediaType, "image00003.jpg", path); @@ -661,7 +661,7 @@ close(fd: number, callback: AsyncCallback<void>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -707,7 +707,7 @@ close(fd: number): Promise<void>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -748,7 +748,7 @@ getThumbnail(callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -784,7 +784,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -825,7 +825,7 @@ getThumbnail(size?: Size): Promise<image.PixelMap>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -861,7 +861,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -902,7 +902,7 @@ favorite(isFavorite: boolean): Promise<void>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -939,7 +939,7 @@ isFavorite(callback: AsyncCallback<boolean>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -978,7 +978,7 @@ isFavorite():Promise<boolean>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1018,7 +1018,7 @@ trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1062,7 +1062,7 @@ trash(isTrash: boolean,): Promise<void>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1099,7 +1099,7 @@ isTrash(callback: AsyncCallback<boolean>): void; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1143,7 +1143,7 @@ isTrash():Promise<boolean>; **示例：** ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1184,7 +1184,7 @@ getCount(): number; **示例**： ``` -async function (done) { +async function example() { let getFileCountOneOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [fileType.toString()], @@ -1215,7 +1215,7 @@ isAfterLast(): boolean; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1254,7 +1254,7 @@ close(): void; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1286,7 +1286,7 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1325,7 +1325,7 @@ getFirstObject(): Promise<FileAsset>; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1361,7 +1361,7 @@ async function (done) { **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1399,7 +1399,7 @@ async function (done) { **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1433,7 +1433,7 @@ getLastObject(callback: AsyncCallback<FileAsset>): void; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1471,7 +1471,7 @@ getLastObject(): Promise<FileAsset>; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1504,7 +1504,7 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1548,7 +1548,7 @@ getPositionObject(index: number): Promise<FileAsset>; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1586,7 +1586,7 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1624,7 +1624,7 @@ getAllObject(): Promise<Array<FileAsset>>; **示例**： ``` -async function (done) { +async function example() { let imageType = mediaLibrary.MediaType.IMAGE; let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', @@ -1656,7 +1656,7 @@ commitModify(callback: AsyncCallback<void>): void; **示例**： ``` -async function (done) { +async function example() { let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], @@ -1693,7 +1693,7 @@ commitModify(): Promise<void>; **示例**： ``` -async function (done) { +async function example() { let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], @@ -1729,7 +1729,7 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **示例**： ``` -async function (done) { +async function example() { let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], @@ -1768,7 +1768,7 @@ async function (done) { **示例**： ``` -async function (done) { +async function example() { let AlbumNoArgsfetchOp = { selections: '', selectionArgs: [], -- Gitee From 732852bb1322270e35f6b030fe8564ae984a8f43 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 7 Mar 2022 14:11:33 +0800 Subject: [PATCH 17/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 290 +++++++++--------- 1 file changed, 147 insertions(+), 143 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 f1615341834..cfe4281493d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -2,7 +2,7 @@ ========== > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > 该组件从API Version 6开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 - + 导入模块 --------- @@ -13,7 +13,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ## getMediaLibrary -function getMediaLibrary(context: Context): MediaLibrary; +function getMediaLibrary(context: Context): MediaLibrary 获取媒体库的实例，用于访问和修改用户的个人数据信息。 @@ -31,7 +31,7 @@ function getMediaLibrary(context: Context): MediaLibrary; | 类型 | 说明 | | ------------ | :----- | -| mediaLibrary | 媒体库实例 | +| MediaLibrary | 媒体库实例 | **示例：** @@ -41,11 +41,12 @@ import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext() var media = mediaLibrary.getMediaLibrary(context); ``` +## MediaLibrary -## mediaLibrary.getFileAssets8+ +### getFileAssets8+ -getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void 获取文件资源，使用callback方式返回异步结果。 @@ -80,9 +81,9 @@ mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { } }); ``` -## mediaLibrary.getFileAssets8+ +### getFileAssets8+ -getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult>; +getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> 获取文件资源，使用Promise方式返回结果。 @@ -118,9 +119,9 @@ mediaLibrary.getFileAssets(imagesfetchOp).then(function(fetchFileResult){ }); ``` -## mediaLibrary.on8+ +### on8+ -on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void; +on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback<void>): void 打开媒体媒体库变更通知，使用callback方式返回异步结果。 @@ -142,9 +143,9 @@ mediaLibrary.on('imageChange', () => { // image file had changed, do something }) ``` -## mediaLibrary.off8+ +### off8+ -off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void; +off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback<void>): void 关闭媒体媒体库变更通知，使用callback方式返回异步结果。 @@ -169,9 +170,9 @@ mediaLibrary.off('imageChange', () => { }) ``` -## mediaLibrary.createAsset 8+ +### createAsset 8+ -createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void; +createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback<FileAsset>): void 创建媒体资源，使用callback方式返回结果。 @@ -203,9 +204,9 @@ mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path, (err, fileAsset) }); ``` -## mediaLibrary.createAsset8+ +### createAsset8+ -createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset>; +createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise<FileAsset> 创建媒体资源，使用Promise方式返回结果。 @@ -240,9 +241,9 @@ mediaLibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) }); ``` -## mediaLibrary.getPublicDirectory8+ +### getPublicDirectory8+ -getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void; +getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void 获取公共目录路径 @@ -271,9 +272,9 @@ media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { }); ``` -## mediaLibrary.getPublicDirectory8+ +### getPublicDirectory8+ -getPublicDirectory(type: DirectoryType): Promise<string>; +getPublicDirectory(type: DirectoryType): Promise<string> 获取公共目录路径 @@ -307,9 +308,9 @@ async function example() { } ``` -## mediaLibrary.getAlbums6+ +### getAlbums6+ -getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void; +getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void 获取实体相册，使用callback 方式返回结果。 @@ -342,9 +343,9 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { }) ``` -## mediaLibrary.getAlbums6+ +### getAlbums6+ -getAlbums(options: MediaFetchOptions): Promise; +getAlbums(options: MediaFetchOptions): Promise 获取实体相册，使用 promise 方式返回结果。 @@ -378,9 +379,9 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ }); ``` -## mediaLibrary.release8+ +### release8+ -release(callback: AsyncCallback<void>): void; +release(callback: AsyncCallback<void>): void 释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 @@ -403,9 +404,9 @@ media.release((err, data) => { }); ``` -## mediaLibrary.release8+ +### release8+ -release(): Promise<void>; +release(): Promise<void> 释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 @@ -426,7 +427,38 @@ var media = mediaLibrary.getMediaLibrary(context); media.release() ``` -## FileAsset.isDirectory8+ +## FileAsset8+ + +提供封装文件属性的方法。 + +### **属性** + +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------ | --------- | ---- | ---- | ------------------------------------------------------ | +| id | number | 是 | 否 | 文件资源编号 | +| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | +| mimeType | string | 是 | 否 | 文件扩展属性 | +| mediaType | MediaType | 是 | 否 | 媒体类型 | +| displayName | string | 是 | 是 | 显示文件名 | +| title | string | 是 | 是 | 文件标题 | +| relativePath | string | 是 | 是 | 相对公共目录路径 | +| parent | number | 是 | 否 | 父目录id | +| size | number | 是 | 否 | 文件大小(单位：字节) | +| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | +| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | +| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | +| artist | string | 是 | 否 | 作者 | +| audioAlbum | string | 是 | 否 | 专辑 | +| width | number | 是 | 否 | 图片宽度（单位：像素） | +| height | number | 是 | 否 | 图片高度（单位：像素） | +| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | +| duration | number | 是 | 否 | 持续时间（单位：秒） | +| albumId | number | 是 | 否 | 文件所归属的相册编号 | +| albumUri | string | 是 | 否 | 文件所归属相册uri | +| albumName | string | 是 | 否 | 文件所归属相册名称 | + + +### isDirectory8+ isDirectory(callback: AsyncCallback<boolean>): void; @@ -461,9 +493,9 @@ async function example() { } ``` -## FileAsset.isDirectory8+ +### isDirectory8+ -isDirectory():Promise<boolean>; +isDirectory():Promise<boolean> 判断fileAsset是否为目录，使用Promise方式返回异步结果。 @@ -498,9 +530,9 @@ async function example() { } ``` -## FileAsset.commitModify8+ +### commitModify8+ -commitModify(callback: AsyncCallback<void>): void; +commitModify(callback: AsyncCallback<void>): void 修改文件的元数据，使用callback方式返回异步结果。 @@ -534,9 +566,9 @@ async function example() { } ``` -## FileAsset.commitModify8+ +### commitModify8+ -commitModify(): Promise<void>; +commitModify(): Promise<void> 修改文件的元数据，使用promise方式返回异步结果。 @@ -568,9 +600,9 @@ async function example() { } ``` -## FileAsset.open8+ +### open8+ -open(mode: string, callback: AsyncCallback<number>): void; +open(mode: string, callback: AsyncCallback<number>): void 打开当前文件，使用callback方式返回异步结果。 @@ -602,9 +634,9 @@ async function example() { } ``` -## FileAsset.open8+ +### open8+ -open(mode: string): Promise<number>; +open(mode: string): Promise<number> 打开当前文件，使用promise方式返回异步结果。 @@ -641,9 +673,9 @@ async function example() { } ``` -## FileAsset.close8+ +### close8+ -close(fd: number, callback: AsyncCallback<void>): void; +close(fd: number, callback: AsyncCallback<void>): void 关闭当前文件，使用callback方式返回异步结果。 @@ -682,9 +714,9 @@ async function example() { } ``` -## FileAsset.close8+ +### close8+ -close(fd: number): Promise<void>; +close(fd: number): Promise<void> 关闭当前文件，使用promise方式返回异步结果。 @@ -729,9 +761,9 @@ async function example() { } ``` -## FileAsset.getThumbnail8+ +### getThumbnail8+ -getThumbnail(callback: AsyncCallback<image.PixelMap>): void; +getThumbnail(callback: AsyncCallback<image.PixelMap>): void 获取文件的缩略图，使用callback方式返回异步结果。 @@ -764,9 +796,9 @@ async function example() { } ``` -## FileAsset.getThumbnail8+ +### getThumbnail8+ -getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void; +getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void 获取文件的缩略图，传入缩略图尺寸，使用callback方式返回异步结果。 @@ -800,9 +832,9 @@ async function example() { } ``` -## FileAsset.getThumbnail8+ +### getThumbnail8+ -getThumbnail(size?: Size): Promise<image.PixelMap>; +getThumbnail(size?: Size): Promise<image.PixelMap> 获取文件的缩略图，传入缩略图尺寸，使用promise方式返回异步结果。 @@ -841,9 +873,9 @@ async function example() { } ``` -## FileAsset.favorite8+ +### favorite8+ -favorite(isFavorite: boolean, callback: AsyncCallback<void>): void; +favorite(isFavorite: boolean, callback: AsyncCallback<void>): void 将文件设置为收藏文件，使用callback方式返回异步结果。 @@ -877,9 +909,9 @@ async function example() { } ``` -## FileAsset.favorite8+ +### favorite8+ -favorite(isFavorite: boolean): Promise<void>; +favorite(isFavorite: boolean): Promise<void> 将文件设置为收藏文件，使用promise方式返回异步结果。 @@ -920,9 +952,9 @@ async function example() { } ``` -## FileAsset.isFavorite8+ +### isFavorite8+ -isFavorite(callback: AsyncCallback<boolean>): void; +isFavorite(callback: AsyncCallback<boolean>): void 判断该文件是否为收藏文件，使用callback方式返回异步结果。 @@ -959,9 +991,9 @@ async function example() { } ``` -## FileAsset.isFavorite8+ +### isFavorite8+ -isFavorite():Promise<boolean>; +isFavorite():Promise<boolean> 判断该文件是否为收藏文件，使用promise方式返回异步结果。 @@ -996,9 +1028,9 @@ async function example() { } ``` -## FileAsset.trash8+ +### trash8+ -trash(isTrash: boolean, callback: AsyncCallback<void&g;): void; +trash(isTrash: boolean, callback: AsyncCallback<void&g;): void 当文件被定位时，将文件放到垃圾文件夹，使用callback方式返回异步结果。 @@ -1035,9 +1067,9 @@ async function example() { } ``` -## FileAsset.trash8+ +### trash8+ -trash(isTrash: boolean,): Promise<void>; +trash(isTrash: boolean,): Promise<void> 当文件被定位时，将文件放到垃圾文件夹，使用promise方式返回异步结果。 @@ -1080,9 +1112,9 @@ async function example() { } ``` -## FileAsset.isTrash8+ +### isTrash8+ -isTrash(callback: AsyncCallback<boolean>): void; +isTrash(callback: AsyncCallback<boolean>): void 当文件被定位，判断文件是否为垃圾文件，使用callback方式返回异步结果。 @@ -1124,9 +1156,9 @@ async function example() { } ``` -## FileAsset.isTrash8+ +### isTrash8+ -isTrash():Promise<boolean>; +isTrash():Promise<boolean> 当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 @@ -1161,13 +1193,13 @@ async function example() { } ``` -**FetchFileResult** +## **FetchFileResult**8+ 文件检索结果集。 -## FetchFileResult.getCount8+ +### getCount8+ -getCount(): number; +getCount(): number 获取文件检索结果中的文件总数。 @@ -1196,9 +1228,9 @@ async function example() { } ``` -## FetchFileResult.isAfterLast8+ +### isAfterLast8+ -isAfterLast(): boolean; +isAfterLast(): boolean 检查结果集是否指向最后一行。 @@ -1241,9 +1273,9 @@ async function example() { } ``` -## FetchFileResult.close8+ +### close8+ -close(): void; +close(): void 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 @@ -1267,9 +1299,9 @@ async function example() { } ``` -## FetchFileResult.getFirstObject8+ +### getFirstObject8+ -getFirstObject(callback: AsyncCallback<FileAsset>): void; +getFirstObject(callback: AsyncCallback<FileAsset>): void 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 @@ -1305,9 +1337,9 @@ async function example() { } ``` -## FetchFileResult.getFirstObject8+ +### getFirstObject8+ -getFirstObject(): Promise<FileAsset>; +getFirstObject(): Promise<FileAsset> 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 @@ -1342,9 +1374,9 @@ async function example() { } ``` -## FetchFileResult.getNextObject8+ +### getNextObject8+ - getNextObject(callback: AsyncCallback<FileAsset>): void; + getNextObject(callback: AsyncCallback<FileAsset>): void 获取文件检索结果中的下一个文件资产。此方法使用callback形式返回结果。 @@ -1380,9 +1412,9 @@ async function example() { } ``` -## FetchFileResult.getNextObject8+ +### getNextObject8+ - getNextObject(): Promise<FileAsset>; + getNextObject(): Promise<FileAsset> 获取文件检索结果中的下一个文件资产。此方法使用promise方式来异步返回FileAsset。 @@ -1414,9 +1446,9 @@ async function example() { } ``` -## FetchFileResult.getLastObject8+ +### getLastObject8+ -getLastObject(callback: AsyncCallback<FileAsset>): void; +getLastObject(callback: AsyncCallback<FileAsset>): void 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 @@ -1452,9 +1484,9 @@ async function example() { } ``` -## FetchFileResult.getLastObject8+ +### getLastObject8+ -getLastObject(): Promise<FileAsset>; +getLastObject(): Promise<FileAsset> 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 @@ -1484,9 +1516,9 @@ async function example() { } ``` -## FetchFileResult.getPositionObject8+ +### getPositionObject8+ -getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void; +getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 @@ -1523,9 +1555,9 @@ async function example() { } ``` -## FetchFileResult.getPositionObject8+ +### getPositionObject8+ -getPositionObject(index: number): Promise<FileAsset>; +getPositionObject(index: number): Promise<FileAsset> 获取文件检索结果中具有指定索引的文件资产。此方法使用Promise形式返回文件Asset。 @@ -1567,9 +1599,9 @@ async function example() { } ``` -## FetchFileResult.getAllObject8+ +### getAllObject8+ -getAllObject(callback: AsyncCallback<Array<FileAsset>>): void; +getAllObject(callback: AsyncCallback<Array<FileAsset>>): void 获取文件检索结果中的所有文件资产。此方法使用Callback回调来返回FileAsset结果集。 @@ -1605,9 +1637,9 @@ async function example() { } ``` -## FetchFileResult.getAllObject8+ +### getAllObject8+ -getAllObject(): Promise<Array<FileAsset>>; +getAllObject(): Promise<Array<FileAsset>> 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 @@ -1637,9 +1669,25 @@ async function example() { } ``` -## Album.commitModify8+ +## Album8+ + +实体相册 + +### **属性** + +| 名称 | 参数型 | 可读 | 可写 | 说明 | +| ------------ | ------ | ---- | ---- | -------------- | +| albumId | number | 是 | 否 | 相册编号 | +| albumName | string | 是 | 是 | 相册名称 | +| albumUri | string | 是 | 否 | 相册Uri | +| dateModified | number | 是 | 否 | 修改日期 | +| count | number | 是 | 否 | 相册中文件数量 | +| relativePath | string | 是 | 否 | 相对路径 | +| coverUri | string | 是 | 否 | 封面文件Uri | -commitModify(callback: AsyncCallback<void>): void; +### commitModify8+ + +commitModify(callback: AsyncCallback<void>): void 更新相册属性修改到数据库中。 @@ -1674,9 +1722,9 @@ async function example() { } ``` -## Album.commitModify8+ +### commitModify8+ -commitModify(): Promise<void>; +commitModify(): Promise<void> 更新相册属性修改到数据库中。 @@ -1709,9 +1757,9 @@ async function example() { } ``` -## Album.getFileAssets8+ +### getFileAssets8+ -getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void; +getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void 按照检索条件获取相册中的文件。此方法使用Callback回调来返回文件结果集。 @@ -1743,9 +1791,9 @@ async function example() { } ``` -## Album.getFileAssets8+ +### getFileAssets8+ - getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult>; + getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult> 按照检索条件获取相册中的文件。此方法使用异步回调来返回文件结果集。 @@ -1794,51 +1842,7 @@ async function example() { | deviceType | DeviceType | 是 | 否 | 设备类型 | | isOnline | boolean | 是 | 否 | 是否在线 | -FileAsset ---------- - -**属性：** - -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------ | --------- | ---- | ---- | ------------------------------------------------------ | -| id | number | 是 | 否 | 文件资源编号 | -| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | -| mimeType | string | 是 | 否 | 文件扩展属性 | -| mediaType | MediaType | 是 | 否 | 媒体类型 | -| displayName | string | 是 | 是 | 显示文件名 | -| title | string | 是 | 是 | 文件标题 | -| relativePath | string | 是 | 是 | 相对公共目录路径 | -| parent | number | 是 | 否 | 父目录id | -| size | number | 是 | 否 | 文件大小(单位：字节) | -| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | -| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | -| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | -| artist | string | 是 | 否 | 作者 | -| audioAlbum | string | 是 | 否 | 专辑 | -| width | number | 是 | 否 | 图片宽度（单位：像素） | -| height | number | 是 | 否 | 图片高度（单位：像素） | -| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | -| duration | number | 是 | 否 | 持续时间（单位：秒） | -| albumId | number | 是 | 否 | 文件所归属的相册编号 | -| albumUri | string | 是 | 否 | 文件所归属相册uri | -| albumName | string | 是 | 否 | 文件所归属相册名称 | - -Album ---------- - -实体相册。 -**属性** - -| 名称 | 参数型 | 可读 | 可写 | 说明 | -| ------------ | ------ | ---- | ---- | -------------- | -| albumId | number | 是 | 否 | 相册编号 | -| albumName | string | 是 | 是 | 相册名称 | -| albumUri | string | 是 | 否 | 相册Uri | -| dateModified | number | 是 | 否 | 修改日期 | -| count | number | 是 | 否 | 相册中文件数量 | -| relativePath | string | 是 | 否 | 相对路径 | -| coverUri | string | 是 | 否 | 封面文件Uri | MediaType --------- -- Gitee From d5cf807d79730684851aaf01328c4c3733fd89d3 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 7 Mar 2022 19:03:41 +0800 Subject: [PATCH 18/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 309 ++++++++---------- 1 file changed, 137 insertions(+), 172 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 cfe4281493d..fe9cfe9d63d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -10,28 +10,25 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ``` - ## getMediaLibrary function getMediaLibrary(context: Context): MediaLibrary 获取媒体库的实例，用于访问和修改用户的个人数据信息。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | | ------- | ------- | ---- | -------------------- | -| context | Context | 是 | API 8接口此参数是必填参数，传入Ability实例的context，获取媒体库 | +| context | Context | 是 | API7以下接口可不传此参数，API 8以上接口此参数是必填参数，传入Ability实例的context，获取媒体库 | **返回值：** | 类型 | 说明 | | ------------ | :----- | -| MediaLibrary | 媒体库实例 | +| [MediaLibrary](#MediaLibrary) | 媒体库实例 | **示例：** @@ -56,10 +53,10 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | --------------------------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体获取选项 | -| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步获取FetchFileResult之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体获取选项 | +| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步获取FetchFileResult之后的回调 | **示例：** @@ -93,15 +90,15 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------------ | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项 | **返回值** -| 类型 | 说明 | -| -------------------------------------------- | -------------- | -| [FetchFileResult](#FetchFileResult.getCount) | 媒体数据结果集 | +| 类型 | 说明 | +| ----------------------------- | -------------- | +| [FetchFileResult](#fetchfileresult8) | 媒体数据结果集 | **示例：** @@ -125,8 +122,6 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| 打开媒体媒体库变更通知，使用callback方式返回异步结果。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** @@ -149,17 +144,13 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange' 关闭媒体媒体库变更通知，使用callback方式返回异步结果。 -变更通知类型包括：注册设备变更，相册变更，图片文件变更，音频文件变更，视频文件变更，文件变更，远端文件变更。 - -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数：** | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | +| type | string | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | | callback | callback<void> | 否 | 回调返回空 | **示例：** @@ -182,12 +173,12 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | -------------------------------------- | ---- | ------------------------------------------------------------ | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | -| displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对公共目录路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取媒体数据FileAsset之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | +| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对公共目录路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | +| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** @@ -224,9 +215,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr **返回值** -| 类型 | 说明 | -| ----------------------- | ----------------- | -| [FileAsset](#FileAsset) | 媒体数据FileAsset | +| 类型 | 说明 | +| ------------------------ | ----------------- | +| [FileAsset](#fileasset8) | 媒体数据FileAsset | **示例：** @@ -245,9 +236,7 @@ mediaLibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): void -获取公共目录路径 - -**需要权限**：无 +获取公共目录路径，使用callback方式返回结果。 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -255,10 +244,9 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | ------------ | -| type | [DirectoryType](#DirectoryType) | 是 | 公共目录类型 | +| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | | callback |AsyncCallback<string> | 是 | callback 返回公共目录路径 | - **示例：** ``` @@ -276,9 +264,7 @@ media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { getPublicDirectory(type: DirectoryType): Promise<string> -获取公共目录路径 - -**需要权限**：无 +获取公共目录路径，使用Promise方式返回结果。 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -286,7 +272,7 @@ getPublicDirectory(type: DirectoryType): Promise<string> | 参数名 | 类型 | 必填 | 说明 | | ------ | ------------------------------- | ---- | ------------ | -| type | [DirectoryType](#DirectoryType) | 是 | 公共目录类型 | +| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | **返回值：** @@ -308,7 +294,7 @@ async function example() { } ``` -### getAlbums6+ +### getAlbums8+ getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void @@ -320,10 +306,10 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback> | 是 | 异步获取Album列表之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体文件获取条件 | +| callback | AsyncCallback<Array<[Album](#album8)>> | 是 | 异步获取Album列表之后的回调 | **示例：** @@ -343,7 +329,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { }) ``` -### getAlbums6+ +### getAlbums8+ getAlbums(options: MediaFetchOptions): Promise @@ -355,15 +341,15 @@ getAlbums(options: MediaFetchOptions): Promise **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ---------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体文件获取条件 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ---------------- | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体文件获取条件 | **返回值：** -| 类型 | 说明 | -| ------------------------------- | ------------- | -| Promise> | 返回Album列表 | +| 类型 | 说明 | +| -------------------------------- | ------------- | +| Promise> | 返回Album列表 | **示例：** @@ -383,9 +369,8 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp).then(function(albumList){ release(callback: AsyncCallback<void>): void -释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 - -**需要权限**：无 +释放MediaLibrary实例。 +当后续不需要使用MediaLibrary实例中的方法时调用。 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -408,9 +393,8 @@ media.release((err, data) => { release(): Promise<void> -释放mediaLibrary实例，当用户确认后续不再使用mediaLibrary实例中的方法后调用release方法释放mediaLibrary实例。 - -**需要权限**：无 +释放MediaLibrary实例。 +当后续不需要使用MediaLibrary实例中的方法时调用。 **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -433,34 +417,34 @@ media.release() ### **属性** -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------ | --------- | ---- | ---- | ------------------------------------------------------ | -| id | number | 是 | 否 | 文件资源编号 | -| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | -| mimeType | string | 是 | 否 | 文件扩展属性 | -| mediaType | MediaType | 是 | 否 | 媒体类型 | -| displayName | string | 是 | 是 | 显示文件名 | -| title | string | 是 | 是 | 文件标题 | -| relativePath | string | 是 | 是 | 相对公共目录路径 | -| parent | number | 是 | 否 | 父目录id | -| size | number | 是 | 否 | 文件大小(单位：字节) | -| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | -| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | -| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | -| artist | string | 是 | 否 | 作者 | -| audioAlbum | string | 是 | 否 | 专辑 | -| width | number | 是 | 否 | 图片宽度（单位：像素） | -| height | number | 是 | 否 | 图片高度（单位：像素） | -| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | -| duration | number | 是 | 否 | 持续时间（单位：秒） | -| albumId | number | 是 | 否 | 文件所归属的相册编号 | -| albumUri | string | 是 | 否 | 文件所归属相册uri | -| albumName | string | 是 | 否 | 文件所归属相册名称 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------ | ----------------------- | ---- | ---- | ------------------------------------------------------ | +| id | number | 是 | 否 | 文件资源编号 | +| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | +| mimeType | string | 是 | 否 | 文件扩展属性 | +| mediaType | [MediaType](#mediaType) | 是 | 否 | 媒体类型 | +| displayName | string | 是 | 是 | 显示文件名 | +| title | string | 是 | 是 | 文件标题 | +| relativePath | string | 是 | 是 | 相对公共目录路径 | +| parent | number | 是 | 否 | 父目录id | +| size | number | 是 | 否 | 文件大小（单位：字节） | +| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | +| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | +| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | +| artist | string | 是 | 否 | 作者 | +| audioAlbum | string | 是 | 否 | 专辑 | +| width | number | 是 | 否 | 图片宽度（单位：像素） | +| height | number | 是 | 否 | 图片高度（单位：像素） | +| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | +| duration | number | 是 | 否 | 持续时间（单位：秒） | +| albumId | number | 是 | 否 | 文件所归属的相册编号 | +| albumUri | string | 是 | 否 | 文件所归属相册uri | +| albumName | string | 是 | 否 | 文件所归属相册名称 | ### isDirectory8+ -isDirectory(callback: AsyncCallback<boolean>): void; +isDirectory(callback: AsyncCallback<boolean>): void 判断fileAsset是否为目录，使用callback方式返回异步结果。 @@ -614,7 +598,7 @@ open(mode: string, callback: AsyncCallback<number>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| mode | string | 是 | 打开文件方式，如：'r', 'w', 'rw' | +| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） | | callback | AsyncCallback<number> | 是 | 回调返回文件句柄 | **示例：** @@ -646,9 +630,9 @@ open(mode: string): Promise<number> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------ | ---- | -------------------------------- | -| mode | string | 是 | 打开文件方式，如：'r', 'w', 'rw' | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------------------------- | +| mode | string | 是 | 打开文件方式，如：'r'（只读）, 'w'（只写）, 'rw'（读写） | **返回值：** @@ -810,7 +794,7 @@ getThumbnail(size: Size, callback: AsyncCallback<image.PixelMap>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------- | ---- | -------------------- | -| size | [Size](#Size) | 是 | 缩略图尺寸 | +| size | [Size](#size8) | 是 | 缩略图尺寸 | | callback | AsyncCallback<image.PixelMap> | 是 | 回调返回缩略图的PixelMap | **示例：** @@ -844,9 +828,9 @@ getThumbnail(size?: Size): Promise<image.PixelMap> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------ | ------------- | ---- | ---------- | -| size | [Size](#Size) | 否 | 缩略图尺寸 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------------- | ---- | ---------- | +| size | [Size](#size8) | 否 | 缩略图尺寸 | **返回值：** @@ -887,7 +871,7 @@ favorite(isFavorite: boolean, callback: AsyncCallback<void>): void | 参数名 | 类型 | 必填 | 说明 | | ---------- | ------------------- | ---- | -------------- | -| isFavorite | boolean | 是 | 是否设置为收藏文件, true：设置为收藏文件，false：取消收藏 | +| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 | | callback | AsyncCallback<void> | 是 | 回调返回空 | **示例：** @@ -921,9 +905,9 @@ favorite(isFavorite: boolean): Promise<void> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---------- | ------- | ---- | --------------------------------------------------------- | -| isFavorite | boolean | 是 | 是否设置为收藏文件, true：设置为收藏文件，false：取消收藏 | +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ------- | ---- | ---------------------------------------------------------- | +| isFavorite | boolean | 是 | 是否设置为收藏文件， true：设置为收藏文件，false：取消收藏 | **返回值：** @@ -1160,7 +1144,7 @@ async function example() { isTrash():Promise<boolean> -当文件被定位，设置文件为垃圾文件，使用promise方式返回异步结果。 +当文件被定位，判断文件是否为垃圾文件，使用promise方式返回异步结果。 **需要权限**：ohos.permission.READ_MEDIA @@ -1193,7 +1177,7 @@ async function example() { } ``` -## **FetchFileResult**8+ +## FetchFileResult8+ 文件检索结果集。 @@ -1203,8 +1187,6 @@ getCount(): number 获取文件检索结果中的文件总数。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： @@ -1234,15 +1216,13 @@ isAfterLast(): boolean 检查结果集是否指向最后一行。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： -| 类型 | 说明 | -| ------- | ------------------------------------------------------------ | -| boolean | 当读到最后一条记录后，再继续读就到结果集尾了，没有记录了，执行isAfterLast()方法就返回true，否则返回false | +| 类型 | 说明 | +| ------- | ----------------------------------------------------------- | +| boolean | 当读到最后一条记录后，后续没有记录返回true，否则返回false。 | **示例**： @@ -1279,8 +1259,6 @@ close(): void 释放 FetchFileResult 实例并使其失效。无法调用其他方法。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **示例**： @@ -1305,15 +1283,13 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void 获取文件检索结果中的第一个文件资产。此方法使用回调返回FileAsset。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------- | ---- | ------------------------------------------- | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | ------------------------------------------- | +| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | **示例**： @@ -1343,16 +1319,13 @@ getFirstObject(): Promise<FileAsset> 获取文件检索结果中的第一个文件资产。此方法使用返回FileAsset。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： | 类型 | 说明 | | ------------------ | -------------------------------------- | -| Promise<[FileAsset](#FileAsset)> | Promise方式返回FileAsset | - +| Promise<[FileAsset](#fileasset8)> | Promise方式返回FileAsset | **示例**： @@ -1386,9 +1359,9 @@ async function example() { **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| --------- | -------------------------------------------- | ---- | ----------------------------------------- | -| callbacke | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回结果集中下一个FileAsset之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ----------------------------------------- | +| callbacke | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回结果集中下一个FileAsset之后的回调 | **示例**： @@ -1426,7 +1399,7 @@ async function example() { | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | +| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | **示例**： @@ -1452,15 +1425,13 @@ getLastObject(callback: AsyncCallback<FileAsset>): void 获取文件检索结果中的最后一个文件资产。此方法使用callback回调来返回FileAsset。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------- | ---- | --------------------------- | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | --------------------------- | +| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1490,15 +1461,13 @@ getLastObject(): Promise<FileAsset> 获取文件检索结果中的最后一个文件资产。此方法使用Promise方式来返回FileAsset。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | +| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | **示例**： @@ -1522,16 +1491,14 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void 获取文件检索结果中具有指定索引的文件资产。此方法使用回调来返回FileAsset。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------- | ---- | --------------------------- | -| index | number | 是 | 要获取的文件的索引，从0开始 | -| callback | AsyncCallback<[FileAsset](#FileAsset)> | 是 | 异步返回FileAsset之后的回调 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | --------------------------- | +| index | number | 是 | 要获取的文件的索引，从0开始 | +| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1575,7 +1542,7 @@ getPositionObject(index: number): Promise<FileAsset> | 类型 | 说明 | | -------------------------------- | ------------------- | -| Promise<[FileAsset](#FileAsset)> | 返回FileAsset对象 | +| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | **示例**： @@ -1611,9 +1578,9 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | --------------------------------------------- | ---- | ------------------------------- | -| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------------- | ---- | ------------------------------- | +| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调 | **示例**： @@ -1643,15 +1610,13 @@ getAllObject(): Promise<Array<FileAsset>> 获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。 -**需要权限**：无 - **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core **返回值**： -| 类型 | 说明 | -| --------------------------------------- | --------------------- | -| Promise> | 返回FileAsset对象列表 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise> | 返回FileAsset对象列表 | **示例**： @@ -1769,10 +1734,10 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **参数**： -| 参数 | 类型 | 必填 | 说明 | -| -------- | ----------------------------------------------------------- | ---- | --------------------------------- | -| options | [MediaFetchOptions](#MediaFetchOptions) | 是 | 媒体检索选项 | -| callback | AsyncCallback<[FetchFileResult](#FetchFileResult.getCount)> | 是 | 异步返回FetchFileResult之后的回调 | +| 参数 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项 | +| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步返回FetchFileResult之后的回调 | **示例**： @@ -1803,15 +1768,15 @@ async function example() { **参数**： -| 参数 | 类型 | 必填 | 说明 | -| ------- | --------------------------------------- | ---- | ------------ | -| options | [MediaFetchOptions](#MediaFetchOptions) | 否 | 媒体检索选项 | +| 参数 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#mediafetchoptions8) | 否 | 媒体检索选项 | **返回值**： -| 类型 | 说明 | -| ----------------------------------------------------- | ----------------------- | -| Promise<[FetchFileResult](#FetchFileResult.getCount)> | 返回FetchFileResult对象 | +| 类型 | 说明 | +| --------------------------------------------- | ----------------------- | +| Promise<[FetchFileResult](#fetchfileresult8)> | 返回FetchFileResult对象 | **示例**： @@ -1861,27 +1826,27 @@ FileKey 枚举，文件关键信息。 -| 名称 | 默认值 | 描述 | -| ------------- | ------------------- | ------------------------------------------------------ | -| ID | file_id | 文件编号 | -| RELATIVE_PATH | relative_path | 相对公共目录路径 | -| DISPLAY_NAME | display_name | 显示名字 | -| PARENT | parent | 父目录id | -| MIME_TYPE | mime_type | 文件扩展属性 | -| 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 | 文件扩展属性 | +| 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 | 文件所归属相册名称 | DirectoryType ------------- -- Gitee From 3ca3c20125720712dd5f76335eae2b594db38d35 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 7 Mar 2022 20:12:25 +0800 Subject: [PATCH 19/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 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 fe9cfe9d63d..4e17e265355 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -10,7 +10,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ``` -## getMediaLibrary +## mediaLibrary.getMediaLibrary function getMediaLibrary(context: Context): MediaLibrary @@ -28,7 +28,7 @@ function getMediaLibrary(context: Context): MediaLibrary | 类型 | 说明 | | ------------ | :----- | -| [MediaLibrary](#MediaLibrary) | 媒体库实例 | +| [MediaLibrary](#medialibrary) | 媒体库实例 | **示例：** @@ -128,7 +128,7 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'| | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------- | ---- | ------------------- | -| type | type | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | +| type | string | 是 | 媒体类型
'deviceChange'： 注册设备变更
'albumChange'： 相册变更
'imageChange'： 图片文件变更
'audioChange'：  音频文件变更
'videoChange'：  视频文件变更
'fileChange'：  文件变更
'remoteFileChange'： 注册设备上文件变更 | | callback | callback<void> | 是 | 回调返回空 | **示例：** @@ -175,7 +175,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal | 参数名 | 类型 | 必填 | 说明 | | ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | | displayName | string | 是 | 展示文件名 | | relativePath | string | 是 | 相对公共目录路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | | callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取媒体数据FileAsset之后的回调 | @@ -209,7 +209,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr | 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------- | ---- | ------------------------------------------------------------ | -| mediaType | [MediaType](#MediaType) | 是 | 媒体类型 | +| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | | displayName | string | 是 | 展示文件名 | | relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | @@ -422,7 +422,7 @@ media.release() | id | number | 是 | 否 | 文件资源编号 | | uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | | mimeType | string | 是 | 否 | 文件扩展属性 | -| mediaType | [MediaType](#mediaType) | 是 | 否 | 媒体类型 | +| mediaType | [MediaType](#mediatype) | 是 | 否 | 媒体类型 | | displayName | string | 是 | 是 | 显示文件名 | | title | string | 是 | 是 | 文件标题 | | relativePath | string | 是 | 是 | 相对公共目录路径 | -- Gitee From 172b48f8a670e8a703b7a9801116763c0635be7f Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Mon, 7 Mar 2022 20:17:05 +0800 Subject: [PATCH 20/25] add code fix Signed-off-by: panqiangbiao --- zh-cn/application-dev/reference/apis/js-apis-medialibrary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 4e17e265355..13d5e458486 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -12,7 +12,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ## mediaLibrary.getMediaLibrary -function getMediaLibrary(context: Context): MediaLibrary +getMediaLibrary(context: Context): MediaLibrary 获取媒体库的实例，用于访问和修改用户的个人数据信息。 -- Gitee From 57592568f8e7a6937aca7d60764e7f7d6dac0ee8 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 8 Mar 2022 09:04:03 +0800 Subject: [PATCH 21/25] add more detail info Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 130 +++++++++--------- 1 file changed, 65 insertions(+), 65 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 13d5e458486..0952cbe8247 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -12,7 +12,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ## mediaLibrary.getMediaLibrary -getMediaLibrary(context: Context): MediaLibrary +function getMediaLibrary(context: Context): MediaLibrary 获取媒体库的实例，用于访问和修改用户的个人数据信息。 @@ -466,8 +466,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -501,8 +501,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -538,8 +538,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -574,8 +574,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -682,8 +682,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -728,8 +728,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -769,8 +769,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -805,8 +805,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -846,8 +846,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -882,8 +882,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -923,8 +923,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -960,8 +960,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -999,8 +999,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -1039,8 +1039,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -1083,8 +1083,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -1120,8 +1120,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -1164,8 +1164,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; const fetchFileResult = await media.getFileAssets(getImageOp); const asset = await fetchFileResult.getFirstObject(); @@ -1202,8 +1202,8 @@ async function example() { let getFileCountOneOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [fileType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,1", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getFileCountOneOp); const fetchCount = fetchFileResult.getCount(); @@ -1232,8 +1232,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); @@ -1269,8 +1269,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.close(); @@ -1299,8 +1299,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getFirstObject((err, value) => { @@ -1335,8 +1335,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getFirstObject().then(function(fileAsset){ @@ -1371,8 +1371,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getNextObject((err, value) => { @@ -1409,8 +1409,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); const fetchCount = fetchFileResult.getCount(); @@ -1441,8 +1441,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getLastObject((err, value) => { @@ -1477,8 +1477,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); let lastObject = await fetchFileResult.getLastObject(); @@ -1508,8 +1508,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getPositionObject(0, (err, value) => { @@ -1552,8 +1552,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getPositionObject(1, (err, value) => { @@ -1590,8 +1590,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); fetchFileResult.getAllObject((err, value) => { @@ -1626,8 +1626,8 @@ async function example() { let getImageOp = { selections: fileKeyObj.MEDIA_TYPE + '= ?', selectionArgs: [imageType.toString()], - order: fileKeyObj.DATE_ADDED, - extendArgs: "LIMIT 0,10", + order: fileKeyObj.DATE_ADDED + " DESC", + extendArgs: "", }; let fetchFileResult = await media.getFileAssets(getImageOp); var data = fetchFileResult.getAllObject(); @@ -1883,12 +1883,12 @@ DeviceType | 名称 | 类型 | 可读 | 可写 | 必填 |说明 | | ------------- | ------------- | ---- | ---- | ---- |---------------- | -| selections | string | 是 | 是 |是 | 检索条件 | -| selectionArgs | Array<string> | 是 | 是 |是 | 检索条件的值 | -| order | string | 是 | 是 | 否 |检索结果排序方式 | +| selections | string | 是 | 是 |是 | 检索条件，使用[FileKey](#filekey)中的枚举值作为检索条件的列名。示例：
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](#filekey)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：
升序排列：order: mediaLibrary.FileKey.DATE_ADDED + " AESC"
降序排列：order: mediaLibrary.FileKey.DATE_ADDED + " DESC" | | uri | string | 是 | 是 | 否 |文件URI | | networkId | string | 是 | 是 | 否 |注册设备网络ID | -| extendArgs | string | 是 | 是 | 否 |扩展的检索参数 | +| extendArgs | string | 是 | 是 | 否 |扩展的检索参数，目前没有扩展检索参数 | ## Size8+ -- Gitee From e82f7e60a0f3afeb0d9adb75a62bc7fe2b909a8a Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 8 Mar 2022 12:14:38 +0800 Subject: [PATCH 22/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 60 ++++++++++--------- 1 file changed, 32 insertions(+), 28 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 0952cbe8247..174e11f0893 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -92,13 +92,13 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> | 参数名 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------- | ---- | ------------ | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项 | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件检索选项 | **返回值** | 类型 | 说明 | | ----------------------------- | -------------- | -| [FetchFileResult](#fetchfileresult8) | 媒体数据结果集 | +| [FetchFileResult](#fetchfileresult8) | 文件数据结果集 | **示例：** @@ -177,7 +177,7 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal | ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | | mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | | displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对公共目录路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | +| relativePath | string | 是 | 文件保存路径，可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 | | callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** @@ -185,8 +185,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal ``` // 使用Callback方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; -let path = "Pictures/"; -mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path, (err, fileAsset) => { +let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; +const path = await media.getPublicDirectory(DIR_IMAGE); +mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => { if (fileAsset != undefined) { console.info('createAsset successfully, message = ' + err); } else { @@ -224,8 +225,9 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr ``` // 使用Promise方式创建Image类型文件 let mediaType = mediaLibrary.MediaType.IMAGE; -let path = "Pictures/"; -mediaLibrary.createAsset(mediaType, "image01.jpg", path).then (function (asset) { +let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; +const path = await media.getPublicDirectory(DIR_IMAGE); +mediaLibrary.createAsset(mediaType, "image01.jpg", path + 'myPicture/').then (function (asset) { console.info("createAsset successfully:"+ JSON.stringify(asset)); }).catch(function(err){ console.info("createAsset failed with error:"+ err); @@ -252,7 +254,7 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): ``` let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; media.getPublicDirectory(DIR_CAMERA, (err, dicResult) => { - if (dicResult == 'camera/') { + if (dicResult == 'Camera/') { console.info('mediaLibraryTest : getPublicDirectory passed'); } else { console.info('mediaLibraryTest : getPublicDirectory failed'); @@ -286,7 +288,7 @@ getPublicDirectory(type: DirectoryType): Promise<string> async function example() { let DIR_CAMERA = mediaLibrary.DirectoryType.DIR_CAMERA; const dicResult = await media.getPublicDirectory(DIR_CAMERA); - if (dicResult == 'camera/') { + if (dicResult == 'Camera/') { console.info('MediaLibraryTest : getPublicDirectory'); } else { console.info('MediaLibraryTest : getPublicDirectory failed'); @@ -298,7 +300,7 @@ async function example() { getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void -获取实体相册，使用callback 方式返回结果。 +获取相册列表，使用callback 方式返回结果。 **需要权限**：ohos.permission.READ_MEDIA @@ -308,7 +310,7 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback> | 是 | 异步获取Album列表之后的回调 | **示例：** @@ -333,7 +335,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { getAlbums(options: MediaFetchOptions): Promise -获取实体相册，使用 promise 方式返回结果。 +获取相册列表，使用 promise 方式返回结果。 **需要权限**：ohos.permission.READ_MEDIA @@ -341,9 +343,9 @@ getAlbums(options: MediaFetchOptions): Promise **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ---------------- | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体文件获取条件 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 相册获取条件 | **返回值：** @@ -384,7 +386,7 @@ release(callback: AsyncCallback<void>): void ``` var media = mediaLibrary.getMediaLibrary(context); -media.release((err, data) => { +media.release((err) => { // do something }); ``` @@ -423,7 +425,7 @@ media.release() | uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | | mimeType | string | 是 | 否 | 文件扩展属性 | | mediaType | [MediaType](#mediatype) | 是 | 否 | 媒体类型 | -| displayName | string | 是 | 是 | 显示文件名 | +| displayName | string | 是 | 是 | 显示文件名，包含后缀名 | | title | string | 是 | 是 | 文件标题 | | relativePath | string | 是 | 是 | 相对公共目录路径 | | parent | number | 是 | 否 | 父目录id | @@ -606,7 +608,8 @@ open(mode: string, callback: AsyncCallback<number>): void ``` async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; - let path = "Pictures/"; + let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; + const path = await media.getPublicDirectory(DIR_IMAGE); asset = await media.createAsset(mediaType, "image00003.jpg", path); asset.open('rw', (openError, fd) => { if(fd > 0){ @@ -645,7 +648,8 @@ open(mode: string): Promise<number> ``` async function example() { let mediaType = mediaLibrary.MediaType.IMAGE; - let path = "Pictures/"; + let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; + const path = await media.getPublicDirectory(DIR_IMAGE); asset = await media.createAsset(mediaType, "image00003.jpg", path); asset.open('rw').then((openError, fd) => { if(fd > 0){ @@ -663,7 +667,7 @@ close(fd: number, callback: AsyncCallback<void>): void 关闭当前文件，使用callback方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -704,7 +708,7 @@ close(fd: number): Promise<void> 关闭当前文件，使用promise方式返回异步结果。 -**需要权限**：ohos.permission.READ_MEDIA, ohos.permission.WRITE_MEDIA +**需要权限**：ohos.permission.READ_MEDIA（'r'模式打开），ohos.permission.WRITE_MEDIA（'w'模式打开） **系统能力**：SystemCapability.Multimedia.MediaLibrary.Core @@ -1798,14 +1802,14 @@ async function example() { ## PeerInfo8+ -注册设备信息。 +注册设备的信息。 -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ---------- | ---------- | ---- | ---- | -------------- | -| deviceName | string | 是 | 否 | 注册设备名称 | -| networkId | string | 是 | 否 | 注册设备网络ID | -| deviceType | DeviceType | 是 | 否 | 设备类型 | -| isOnline | boolean | 是 | 否 | 是否在线 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------- | ---------- | ---- | ---- | ---------------- | +| deviceName | string | 是 | 否 | 注册设备的名称 | +| networkId | string | 是 | 否 | 注册设备的网络ID | +| deviceType | DeviceType | 是 | 否 | 设备类型 | +| isOnline | boolean | 是 | 否 | 是否在线 | -- Gitee From 43f3e6cae420deead331743f02f4622a6524eac4 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 8 Mar 2022 12:16:26 +0800 Subject: [PATCH 23/25] fix code issue Signed-off-by: panqiangbiao --- zh-cn/application-dev/reference/apis/js-apis-medialibrary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 174e11f0893..27d19058671 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -12,7 +12,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ## mediaLibrary.getMediaLibrary -function getMediaLibrary(context: Context): MediaLibrary +getMediaLibrary(context: Context): MediaLibrary 获取媒体库的实例，用于访问和修改用户的个人数据信息。 -- Gitee From 9a33df38e67191f4e656df1352054dbf9469f49e Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 8 Mar 2022 12:20:56 +0800 Subject: [PATCH 24/25] fix code issue Signed-off-by: panqiangbiao --- .../reference/apis/js-apis-medialibrary.md | 44 ++++++++++--------- 1 file changed, 24 insertions(+), 20 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 27d19058671..2057d1e2ad1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -183,17 +183,19 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal **示例：** ``` -// 使用Callback方式创建Image类型文件 -let mediaType = mediaLibrary.MediaType.IMAGE; -let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; -const path = await media.getPublicDirectory(DIR_IMAGE); -mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => { - if (fileAsset != undefined) { - console.info('createAsset successfully, message = ' + err); - } else { - console.info('createAsset failed, message = ' + err); - } -}); +async function example() { + // 使用Callback方式创建Image类型文件 + let mediaType = mediaLibrary.MediaType.IMAGE; + let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; + const path = await media.getPublicDirectory(DIR_IMAGE); + mediaLibrary.createAsset(mediaType, 'imageCallBack.jpg', path + 'myPicture/', (err, fileAsset) => { + if (fileAsset != undefined) { + console.info('createAsset successfully, message = ' + err); + } else { + console.info('createAsset failed, message = ' + err); + } + }); +} ``` ### createAsset8+ @@ -223,15 +225,17 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr **示例：** ``` -// 使用Promise方式创建Image类型文件 -let mediaType = mediaLibrary.MediaType.IMAGE; -let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; -const path = await media.getPublicDirectory(DIR_IMAGE); -mediaLibrary.createAsset(mediaType, "image01.jpg", path + 'myPicture/').then (function (asset) { - console.info("createAsset successfully:"+ JSON.stringify(asset)); -}).catch(function(err){ - console.info("createAsset failed with error:"+ err); -}); +async function example() { + // 使用Promise方式创建Image类型文件 + let mediaType = mediaLibrary.MediaType.IMAGE; + let DIR_IMAGE = mediaLibrary.DirectoryType.DIR_IMAGE; + const path = await media.getPublicDirectory(DIR_IMAGE); + mediaLibrary.createAsset(mediaType, "image01.jpg", path + 'myPicture/').then (function (asset) { + console.info("createAsset successfully:"+ JSON.stringify(asset)); + }).catch(function(err){ + console.info("createAsset failed with error:"+ err); + }); +} ``` ### getPublicDirectory8+ -- Gitee From 1a2b2fecc8684dd3927bdac4ae745ae11a8bfde0 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Tue, 8 Mar 2022 16:00:10 +0800 Subject: [PATCH 25/25] fix code issue Signed-off-by: panqiangbiao --- .../application-dev/reference/apis/js-apis-medialibrary.md | 6 +++--- 1 file changed, 3 insertions(+), 3 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 2057d1e2ad1..06cc8523579 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -53,9 +53,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | -------------------------------------------- | ---- | --------------------------------- | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体获取选项 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | --------------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件获取选项 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步获取FetchFileResult之后的回调 | **示例：** -- Gitee