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 f1615341834766c7cb99a11ccd1642838b64fffd..cfe4281493d79d4c5a715196ac794e5987314bd8 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 ---------