Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4116f709
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看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
4116f709
编写于
11月 23, 2022
作者:
O
openharmony_ci
提交者:
Gitee
11月 23, 2022
浏览文件
操作
浏览文件
下载
差异文件
!11671 modify js-apis-medialibrary.md warning
Merge pull request !11671 from 胡伟奇/modify_medialibrary_md
上级
171b0cb2
59d30fbf
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
45 addition
and
58 deletion
+45
-58
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
+45
-58
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @
4116f709
...
@@ -203,8 +203,8 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
...
@@ -203,8 +203,8 @@ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- |
| -------- | -------------------- | ---- | ---------------------------------------- |
| type |
string
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| type |
'deviceChange'
|
'albumChange'
|
'imageChange'
|
'audioChange'
|
'videoChange'
|
'fileChange'
|
'remoteFileChange'
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| callback |
c
allback
<
void
>
| 是 | 回调返回空 |
| callback |
C
allback
<
void
>
| 是 | 回调返回空 |
**示例:**
**示例:**
...
@@ -225,8 +225,8 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
...
@@ -225,8 +225,8 @@ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------------- |
| -------- | -------------------- | ---- | ---------------------------------------- |
| type |
string
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| type |
'deviceChange'
|
'albumChange'
|
'imageChange'
|
'audioChange'
|
'videoChange'
|
'fileChange'
|
'remoteFileChange'
| 是 | 媒体类型
<br/>
'deviceChange':
注册设备变更
<br/>
'albumChange':
相册变更
<br/>
'imageChange':
图片文件变更
<br/>
'audioChange':
音频文件变更
<br/>
'videoChange':
视频文件变更
<br/>
'fileChange':
文件变更
<br/>
'remoteFileChange':
注册设备上文件变更 |
| callback |
c
allback
<
void
>
| 否 | 回调返回空 |
| callback |
C
allback
<
void
>
| 否 | 回调返回空 |
**示例:**
**示例:**
...
@@ -346,8 +346,6 @@ async function example() {
...
@@ -346,8 +346,6 @@ async function example() {
selections
:
fileKeyObj
.
MEDIA_TYPE
+
'
= ?
'
,
selections
:
fileKeyObj
.
MEDIA_TYPE
+
'
= ?
'
,
selectionArgs
:
[
fileType
.
toString
()],
selectionArgs
:
[
fileType
.
toString
()],
};
};
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
const
fetchFileResult
=
await
media
.
getFileAssets
(
option
);
const
fetchFileResult
=
await
media
.
getFileAssets
(
option
);
let
asset
=
await
fetchFileResult
.
getFirstObject
();
let
asset
=
await
fetchFileResult
.
getFirstObject
();
if
(
asset
==
undefined
)
{
if
(
asset
==
undefined
)
{
...
@@ -390,8 +388,6 @@ async function example() {
...
@@ -390,8 +388,6 @@ async function example() {
selections
:
fileKeyObj
.
MEDIA_TYPE
+
'
= ?
'
,
selections
:
fileKeyObj
.
MEDIA_TYPE
+
'
= ?
'
,
selectionArgs
:
[
fileType
.
toString
()],
selectionArgs
:
[
fileType
.
toString
()],
};
};
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
const
fetchFileResult
=
await
media
.
getFileAssets
(
option
);
const
fetchFileResult
=
await
media
.
getFileAssets
(
option
);
let
asset
=
await
fetchFileResult
.
getFirstObject
();
let
asset
=
await
fetchFileResult
.
getFirstObject
();
if
(
asset
==
undefined
)
{
if
(
asset
==
undefined
)
{
...
@@ -559,7 +555,6 @@ release(callback: AsyncCallback<void>): void
...
@@ -559,7 +555,6 @@ release(callback: AsyncCallback<void>): void
**示例:**
**示例:**
```
js
```
js
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
media
.
release
((
err
)
=>
{
media
.
release
((
err
)
=>
{
// do something
// do something
});
});
...
@@ -882,8 +877,6 @@ getActivePeers(): Promise\<Array\<PeerInfo>>;
...
@@ -882,8 +877,6 @@ getActivePeers(): Promise\<Array\<PeerInfo>>;
```
js
```
js
async
function
example
()
{
async
function
example
()
{
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
media
.
getActivePeers
().
then
((
devicesInfo
)
=>
{
media
.
getActivePeers
().
then
((
devicesInfo
)
=>
{
if
(
devicesInfo
!=
undefined
)
{
if
(
devicesInfo
!=
undefined
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
...
@@ -920,8 +913,6 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
...
@@ -920,8 +913,6 @@ getActivePeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
```
js
```
js
async
function
example
()
{
async
function
example
()
{
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
media
.
getActivePeers
((
err
,
devicesInfo
)
=>
{
media
.
getActivePeers
((
err
,
devicesInfo
)
=>
{
if
(
devicesInfo
!=
undefined
)
{
if
(
devicesInfo
!=
undefined
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
...
@@ -957,8 +948,6 @@ getAllPeers(): Promise\<Array\<PeerInfo>>;
...
@@ -957,8 +948,6 @@ getAllPeers(): Promise\<Array\<PeerInfo>>;
```
js
```
js
async
function
example
()
{
async
function
example
()
{
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
media
.
getAllPeers
().
then
((
devicesInfo
)
=>
{
media
.
getAllPeers
().
then
((
devicesInfo
)
=>
{
if
(
devicesInfo
!=
undefined
)
{
if
(
devicesInfo
!=
undefined
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
...
@@ -995,8 +984,6 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
...
@@ -995,8 +984,6 @@ getAllPeers(callback: AsyncCallback\<Array\<PeerInfo>>): void;
```
js
```
js
async
function
example
()
{
async
function
example
()
{
const
context
=
getContext
(
this
);
var
media
=
mediaLibrary
.
getMediaLibrary
(
context
);
media
.
getAllPeers
((
err
,
devicesInfo
)
=>
{
media
.
getAllPeers
((
err
,
devicesInfo
)
=>
{
if
(
devicesInfo
!=
undefined
)
{
if
(
devicesInfo
!=
undefined
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
for
(
let
i
=
0
;
i
<
devicesInfo
.
length
;
i
++
)
{
...
@@ -2470,12 +2457,12 @@ async function example() {
...
@@ -2470,12 +2457,12 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 说明 |
| 名称 |
值 |
说明 |
| ----- | ---- |
| ----- | ---- |
---- |
| FILE | 文件 |
| FILE |
0 |
文件 |
| IMAGE | 图片 |
| IMAGE |
1 |
图片 |
| VIDEO | 视频 |
| VIDEO |
2 |
视频 |
| AUDIO | 音频 |
| AUDIO |
3 |
音频 |
## FileKey<sup>8+</sup>
## FileKey<sup>8+</sup>
...
@@ -2483,7 +2470,7 @@ async function example() {
...
@@ -2483,7 +2470,7 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 |
默认
值 | 说明 |
| 名称 | 值 | 说明 |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ------------- | ------------------- | ---------------------------------------------------------- |
| ID | file_id | 文件编号 |
| ID | file_id | 文件编号 |
| RELATIVE_PATH | relative_path | 相对公共目录路径 |
| RELATIVE_PATH | relative_path | 相对公共目录路径 |
...
@@ -2511,14 +2498,14 @@ async function example() {
...
@@ -2511,14 +2498,14 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 说明 |
| 名称 |
值 |
说明 |
| ------------- | ------------------ |
| ------------- |
--- |
------------------ |
| DIR_CAMERA | 表示Camera文件路径 |
| DIR_CAMERA |
0 |
表示Camera文件路径 |
| DIR_VIDEO | 表示视频路径 |
| DIR_VIDEO |
1 |
表示视频路径 |
| DIR_IMAGE | 表示图片路径 |
| DIR_IMAGE |
2 |
表示图片路径 |
| DIR_AUDIO | 表示音频路径 |
| DIR_AUDIO |
3 |
表示音频路径 |
| DIR_DOCUMENTS | 表示文档路径 |
| DIR_DOCUMENTS |
4 |
表示文档路径 |
| DIR_DOWNLOAD | 表示下载路径 |
| DIR_DOWNLOAD |
5 |
表示下载路径 |
## DeviceType<sup>8+</sup>
## DeviceType<sup>8+</sup>
...
@@ -2528,15 +2515,15 @@ async function example() {
...
@@ -2528,15 +2515,15 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.DistributedCore
| 名称 | 说明 |
| 名称 |
值 |
说明 |
| ------------ | ---------- |
| ------------ |
--- |
---------- |
| TYPE_UNKNOWN | 未识别设备 |
| TYPE_UNKNOWN |
0 |
未识别设备 |
| TYPE_LAPTOP | 笔记本电脑 |
| TYPE_LAPTOP |
1 |
笔记本电脑 |
| TYPE_PHONE | 手机 |
| TYPE_PHONE |
2 |
手机 |
| TYPE_TABLET | 平板电脑 |
| TYPE_TABLET |
3 |
平板电脑 |
| TYPE_WATCH | 智能手表 |
| TYPE_WATCH |
4 |
智能手表 |
| TYPE_CAR | 车载设备 |
| TYPE_CAR |
5 |
车载设备 |
| TYPE_TV | 电视设备 |
| TYPE_TV |
6 |
电视设备 |
## MediaFetchOptions<sup>7+</sup>
## MediaFetchOptions<sup>7+</sup>
...
@@ -2544,14 +2531,14 @@ async function example() {
...
@@ -2544,14 +2531,14 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 |
必填 |
说明 |
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ------------------- | ---- | ---- | ----
| ----
-------------------------------------------------------- |
| ----------------------- | ------------------- | ---- | ---- | ------------------------------------------------------------ |
| selections | string | 是 | 是 |
是 |
检索条件,使用
[
FileKey
](
#filekey8
)
中的枚举值作为检索条件的列名。示例:
<br
/>
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?', |
| selections | string | 是 | 是 | 检索条件,使用
[
FileKey
](
#filekey8
)
中的枚举值作为检索条件的列名。示例:
<br
/>
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR ' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?', |
| selectionArgs | Array
<
string
>
| 是 | 是 |
是 |
检索条件的值,对应selections中检索条件列的值。
<br
/>
示例:
<br
/>
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| selectionArgs | Array
<
string
>
| 是 | 是 | 检索条件的值,对应selections中检索条件列的值。
<br
/>
示例:
<br
/>
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| order | string | 是 | 是 |
否 |
检索结果排序方式,使用
[
FileKey
](
#filekey8
)
中的枚举值作为检索结果排序的列,可以用升序或降序排列。示例:
<br
/>
升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " ASC"
<br
/>
降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| order | string | 是 | 是 | 检索结果排序方式,使用
[
FileKey
](
#filekey8
)
中的枚举值作为检索结果排序的列,可以用升序或降序排列。示例:
<br
/>
升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " ASC"
<br
/>
降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| uri
<sup>
8+
</sup>
| string | 是 | 是 |
否 |
文件URI |
| uri
<sup>
8+
</sup>
| string | 是 | 是 | 文件URI |
| networkId
<sup>
8+
</sup>
| string | 是 | 是 |
否 |
注册设备网络ID |
| networkId
<sup>
8+
</sup>
| string | 是 | 是 | 注册设备网络ID |
| extendArgs
<sup>
8+
</sup>
| string | 是 | 是 |
否 |
扩展的检索参数,目前没有扩展检索参数 |
| extendArgs
<sup>
8+
</sup>
| string | 是 | 是 | 扩展的检索参数,目前没有扩展检索参数 |
## Size<sup>8+</sup>
## Size<sup>8+</sup>
...
@@ -2573,11 +2560,11 @@ async function example() {
...
@@ -2573,11 +2560,11 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 |
必填 | 描述
|
| 名称 | 类型 |
可读 | 可写 | 说明
|
| ------------ | ------ | ---- | ------------------------------------------------------------ |
| ------------ | ------ | ---- | ----
| ----
-------------------------------------------------------- |
| src | string | 是 | 本地文件应用沙箱路径。 |
| src | string | 是 |
是 |
本地文件应用沙箱路径。 |
| mimeType | string | 是 | 媒体MIME(Multipurpose
Internet
Mail
Extensions)类型。
<br/>
包括:'image/
\*
'、'video/
\*
'、'audio/
\*
'、 'file
\*
'。 |
| mimeType | string | 是 |
是 |
媒体MIME(Multipurpose
Internet
Mail
Extensions)类型。
<br/>
包括:'image/
\*
'、'video/
\*
'、'audio/
\*
'、 'file
\*
'。 |
| relativePath | string |
否
| 自定义媒体资源保存位置,例:Pictures/ 不填则保存到默认路径。
<br/>
image类型默认路径Pictures/
<br/>
video类型默认路径Videos/
<br/>
audio类型默认路径Audios/
<br/>
file类型默认路径Documents/ 。 |
| relativePath | string |
是 | 是
| 自定义媒体资源保存位置,例:Pictures/ 不填则保存到默认路径。
<br/>
image类型默认路径Pictures/
<br/>
video类型默认路径Videos/
<br/>
audio类型默认路径Audios/
<br/>
file类型默认路径Documents/ 。 |
## MediaSelectOption<sup>(deprecated)</sup>
## MediaSelectOption<sup>(deprecated)</sup>
...
@@ -2587,9 +2574,9 @@ async function example() {
...
@@ -2587,9 +2574,9 @@ async function example() {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 |
必填 | 描述
|
| 名称 | 类型 |
可读 | 可写 | 说明
|
| ----- | ------ | ---- | -------------------- |
| ----- | ------ | ---- | ----
| ----
---------------- |
| type | string | 是 | 媒体类型,包括:image, video, media,当前仅支持media类型 |
| type | string | 是 |
是 |
媒体类型,包括:image, video, media,当前仅支持media类型 |
| count | number | 是 | 媒体选择,count = 1表示单选,count大于1表示多选。 |
| count | number | 是 |
是 |
媒体选择,count = 1表示单选,count大于1表示多选。 |
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录