Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d5cf807d
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
d5cf807d
编写于
3月 07, 2022
作者:
P
panqiangbiao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
fix code issue
Signed-off-by:
N
panqiangbiao
<
panqiangbiao@huawei.com
>
上级
732852bb
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
137 addition
and
172 deletion
+137
-172
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
+137
-172
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @
d5cf807d
...
...
@@ -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 | 是 | API
7以下接口可不传此参数,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
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| type |
string
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'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
](
#
DirectoryT
ype
)
| 是 | 公共目录类型 |
| type |
[
DirectoryType
](
#
directoryt
ype
)
| 是 | 公共目录类型 |
| 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
](
#
DirectoryT
ype
)
| 是 | 公共目录类型 |
| type |
[
DirectoryType
](
#
directoryt
ype
)
| 是 | 公共目录类型 |
**返回值:**
...
...
@@ -308,7 +294,7 @@ async function example() {
}
```
### getAlbums<sup>
6
+</sup>
### getAlbums<sup>
8
+</sup>
getAlbums(options: MediaFetchOptions, callback: AsyncCallback
<Array
&
lt
;
Album
&
gt
;
>
): void
...
...
@@ -320,10 +306,10 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array<Album>
**参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------- | ---- | --------------------------- |
| options |
[
MediaFetchOptions
](
#
MediaFetchOptions
)
| 是 | 媒体文件获取条件 |
| callback | AsyncCallback
<
Array
<
[
Album
](
#
Album
)
>
>
| 是 | 异步获取Album列表之后的回调 |
| 参数名 | 类型
| 必填 | 说明 |
| -------- | -------------------------------------------
-
| ---- | --------------------------- |
| options |
[
MediaFetchOptions
](
#
mediafetchoptions8
)
| 是 | 媒体文件获取条件 |
| callback | AsyncCallback
<
Array
<
[
Album
](
#
album8
)
>
>
| 是 | 异步获取Album列表之后的回调 |
**示例:**
...
...
@@ -343,7 +329,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => {
})
```
### getAlbums<sup>
6
+</sup>
### getAlbums<sup>
8
+</sup>
getAlbums(options: MediaFetchOptions): Promise
<Array
&
lt
;
Album
&
gt
;
>
...
...
@@ -355,15 +341,15 @@ getAlbums(options: MediaFetchOptions): Promise<Array<Album>>
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | --------------------------------------- | ---- | ---------------- |
| options |
[
MediaFetchOptions
](
#
MediaFetchOptions
)
| 是 | 媒体文件获取条件 |
| 参数名 | 类型
| 必填 | 说明 |
| ------- | ---------------------------------------
-
| ---- | ---------------- |
| options |
[
MediaFetchOptions
](
#
mediafetchoptions8
)
| 是 | 媒体文件获取条件 |
**返回值:**
| 类型 | 说明 |
| ------------------------------- | ------------- |
| Promise
<Array
<[
Album
](
#
Album
)
>
> | 返回Album列表 |
| 类型
| 说明 |
| -------------------------------
-
| ------------- |
| Promise
<Array
<[
Album
](
#
album8
)
>
> | 返回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
| 是 | 否 | 文件所归属相册名称 |
### isDirectory<sup>8+</sup>
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**
<sup>8+</sup>
##
FetchFileResult
<sup>8+</sup>
文件检索结果集。
...
...
@@ -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
<Array
<[
FileAsset
](
#
FileAsset
)
>
> | 是 | 异步返回FileAsset列表之后的回调 |
| 参数 | 类型
| 必填 | 说明 |
| -------- | ---------------------------------------------
-
| ---- | ------------------------------- |
| callback | AsyncCallback
<Array
<[
FileAsset
](
#
fileasset8
)
>
> | 是 | 异步返回FileAsset列表之后的回调 |
**示例**
:
...
...
@@ -1643,15 +1610,13 @@ getAllObject(): Promise<Array<FileAsset>>
获取文件检索结果中的所有文件资产。此方法使用Promise来返回FileAsset结果集。
**需要权限**
:无
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**返回值**
:
| 类型 | 说明 |
| --------------------------------------- | --------------------- |
| Promise
<Array
<[
FileAsset
](
#
FileAsset
)
>
> | 返回FileAsset对象列表 |
| 类型
| 说明 |
| ---------------------------------------
-
| --------------------- |
| Promise
<Array
<[
FileAsset
](
#
fileasset8
)
>
> | 返回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
-------------
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录