From 1d15a82c85b745aabc98c41e7f111b191a7c5b48 Mon Sep 17 00:00:00 2001 From: panqiangbiao Date: Thu, 24 Feb 2022 20:34:26 +0800 Subject: [PATCH] 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 0000000000..26e3b530ea --- /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 | 是 | 是 | 高 | -- GitLab