Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
e7412f13
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看板
提交
e7412f13
编写于
5月 27, 2022
作者:
Z
zengyawen
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update
Signed-off-by:
N
zengyawen
<
zengyawen1@huawei.com
>
上级
33624f36
变更
5
隐藏空白更改
内联
并排
Showing
5 changed file
with
24 addition
and
43 deletion
+24
-43
zh-cn/application-dev/reference/apis/js-apis-audio.md
zh-cn/application-dev/reference/apis/js-apis-audio.md
+5
-17
zh-cn/application-dev/reference/apis/js-apis-contact.md
zh-cn/application-dev/reference/apis/js-apis-contact.md
+0
-5
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
+18
-18
zh-cn/application-dev/reference/apis/js-apis-system-cipher.md
...n/application-dev/reference/apis/js-apis-system-cipher.md
+1
-2
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
+0
-1
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @
e7412f13
...
@@ -465,8 +465,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
...
@@ -465,8 +465,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
枚举,中断事件返回类型。
枚举,中断事件返回类型。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 | 默认值 | 描述 |
| 名称 | 默认值 | 描述 |
...
@@ -526,8 +524,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
...
@@ -526,8 +524,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
音频监听事件传入的参数。
音频监听事件传入的参数。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
...
@@ -540,8 +536,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
...
@@ -540,8 +536,6 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
音频打断/获取焦点事件的回调方法。
音频打断/获取焦点事件的回调方法。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Renderer
| 名称 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
...
@@ -615,11 +609,11 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
...
@@ -615,11 +609,11 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.Core
| 名称 | 默认值 | 描述
|
| 名称 | 默认值 | 描述 |
| :------------------------------ | :----- | :---------------------
--------------------------------------
|
| :------------------------------ | :----- | :--------------------- |
| SOURCE_TYPE_INVALID | -1 | 无效的音频源。
|
| SOURCE_TYPE_INVALID | -1 | 无效的音频源。 |
| SOURCE_TYPE_MIC | 0 | Mic音频源。
|
| SOURCE_TYPE_MIC | 0 | Mic音频源。 |
| SOURCE_TYPE_VOICE_COMMUNICATION | 7 | 语音通话场景的音频源。
<br/>
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
|
| SOURCE_TYPE_VOICE_COMMUNICATION | 7 | 语音通话场景的音频源。 |
## AudioScene<sup>8+</sup><a name="audioscene"></a>
## AudioScene<sup>8+</sup><a name="audioscene"></a>
...
@@ -1603,8 +1597,6 @@ off(type: 'deviceChange', callback?: Callback<DeviceChangeAction\>): void
...
@@ -1603,8 +1597,6 @@ off(type: 'deviceChange', callback?: Callback<DeviceChangeAction\>): void
取消订阅音频设备连接变化事件。
取消订阅音频设备连接变化事件。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**系统能力:**
SystemCapability.Multimedia.Audio.Device
**参数:**
**参数:**
...
@@ -1628,8 +1620,6 @@ on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\<InterruptAc
...
@@ -1628,8 +1620,6 @@ on(type: 'interrupt', interrupt: AudioInterrupt, callback: Callback\<InterruptAc
请求焦点并开始监听音频打断事件(当应用程序的音频被另一个播放事件中断,回调通知此应用程序)
请求焦点并开始监听音频打断事件(当应用程序的音频被另一个播放事件中断,回调通知此应用程序)
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
**参数:**
...
@@ -1666,8 +1656,6 @@ off(type: 'interrupt', interrupt: AudioInterrupt, callback?: Callback\<Interrupt
...
@@ -1666,8 +1656,6 @@ off(type: 'interrupt', interrupt: AudioInterrupt, callback?: Callback\<Interrupt
取消监听音频打断事件(删除监听事件,取消打断)
取消监听音频打断事件(删除监听事件,取消打断)
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**系统能力:**
SystemCapability.Multimedia.Audio.Renderer
**参数:**
**参数:**
...
...
zh-cn/application-dev/reference/apis/js-apis-contact.md
浏览文件 @
e7412f13
...
@@ -465,8 +465,6 @@ selectContact(callback: AsyncCallback<Array<Contact>>): void
...
@@ -465,8 +465,6 @@ selectContact(callback: AsyncCallback<Array<Contact>>): void
选择联系人,使用callback方式作为异步方法。
选择联系人,使用callback方式作为异步方法。
本接口在Openharmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**需要权限**
:ohos.permission.READ_CONTACTS
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData
**系统能力**
:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData
...
@@ -495,8 +493,6 @@ selectContact(): Promise<Array<Contact>>
...
@@ -495,8 +493,6 @@ selectContact(): Promise<Array<Contact>>
选择联系人,使用Promise方式作为异步方法。
选择联系人,使用Promise方式作为异步方法。
本接口在Openharmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
**需要权限**
:ohos.permission.READ_CONTACTS
**需要权限**
:ohos.permission.READ_CONTACTS
**系统能力**
:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData
**系统能力**
:SystemCapability.Applications.Contacts、SystemCapability.Applications.ContactsData
...
@@ -2116,7 +2112,6 @@ relation.labelId = contact.Relation.RELATION_ASSISTANT;
...
@@ -2116,7 +2112,6 @@ relation.labelId = contact.Relation.RELATION_ASSISTANT;
| sipAddress | string | 是 | 是 | 会话发起协议(SIP)地址。 |
| sipAddress | string | 是 | 是 | 会话发起协议(SIP)地址。 |
| labelId | number | 是 | 是 | 会话发起协议(SIP)地址类型。 |
| labelId | number | 是 | 是 | 会话发起协议(SIP)地址类型。 |
**对象创建示例:**
**对象创建示例:**
使用JSON格式创建数据:
使用JSON格式创建数据:
...
...
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @
e7412f13
...
@@ -443,13 +443,13 @@ var media = mediaLibrary.getMediaLibrary(context);
...
@@ -443,13 +443,13 @@ var media = mediaLibrary.getMediaLibrary(context);
media.release()
media.release()
```
```
### storeMediaAsset
### storeMediaAsset
<sup>(deprecated)</sup>
storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback
<
string
>
): void
storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback
<
string
>
): void
保存媒体资源,以异步方法获取保存成功的URI,使用callback形式返回结果。
保存媒体资源,以异步方法获取保存成功的URI,使用callback形式返回结果。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -479,13 +479,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => {
...
@@ -479,13 +479,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option, (err, value) => {
```
```
### storeMediaAsset
### storeMediaAsset
<sup>(deprecated)</sup>
storeMediaAsset(option: MediaAssetOption): Promise
<
string
>
storeMediaAsset(option: MediaAssetOption): Promise
<
string
>
保存媒体资源,以异步方法获取保存成功的URI,使用Promise形式返回结果。
保存媒体资源,以异步方法获取保存成功的URI,使用Promise形式返回结果。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -518,13 +518,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {
...
@@ -518,13 +518,13 @@ mediaLibrary.getMediaLibrary().storeMediaAsset(option).then((value) => {
```
```
### startImagePreview
### startImagePreview
<sup>(deprecated)</sup>
startImagePreview(images: Array
<
string
>
, index: number, callback: AsyncCallback
<
void
>
): void
startImagePreview(images: Array
<
string
>
, index: number, callback: AsyncCallback
<
void
>
): void
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -560,13 +560,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => {
...
@@ -560,13 +560,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index, (err) => {
```
```
### startImagePreview
### startImagePreview
<sup>(deprecated)</sup>
startImagePreview(images: Array
<
string
>
, callback: AsyncCallback
<
void
>
): void
startImagePreview(images: Array
<
string
>
, callback: AsyncCallback
<
void
>
): void
启动图片预览界面,可以预览列表中首张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。
启动图片预览界面,可以预览列表中首张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用callback方式进行异步回调。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -600,13 +600,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => {
...
@@ -600,13 +600,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, (err) => {
```
```
### startImagePreview
### startImagePreview
<sup>(deprecated)</sup>
startImagePreview(images: Array
<
string
>
, index?: number): Promise
<
void
>
startImagePreview(images: Array
<
string
>
, index?: number): Promise
<
void
>
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用Promise方式进行异步回调。
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(dataability://),也可以预览列表中的所有网络图片(https://)。使用Promise方式进行异步回调。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -645,13 +645,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
...
@@ -645,13 +645,13 @@ mediaLibrary.getMediaLibrary().startImagePreview(images, index).then(() => {
```
```
### startMediaSelect
### startMediaSelect
<sup>(deprecated)</sup>
startMediaSelect(option: MediaSelectOption, callback: AsyncCallback
<
Array
<
string
>>
): void
startMediaSelect(option: MediaSelectOption, callback: AsyncCallback
<
Array
<
string
>>
): void
启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用callback形式返回结果。
启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用callback形式返回结果。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -680,13 +680,13 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => {
...
@@ -680,13 +680,13 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option, (err, value) => {
```
```
### startMediaSelect
### startMediaSelect
<sup>(deprecated)</sup>
startMediaSelect(option: MediaSelectOption): Promise
<
Array
<
string
>>
startMediaSelect(option: MediaSelectOption): Promise
<
Array
<
string
>>
启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用Promise形式返回结果。
启动媒体选择界面,以异步方法获取选择的媒体URI列表,使用Promise形式返回结果。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
**系统能力**
:SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -2228,11 +2228,11 @@ async function example() {
...
@@ -2228,11 +2228,11 @@ async function example() {
| width | number | 是 | 是 | 宽(单位:像素) |
| width | number | 是 | 是 | 宽(单位:像素) |
| height | number | 是 | 是 | 高(单位:像素) |
| height | number | 是 | 是 | 高(单位:像素) |
## MediaAssetOption
## MediaAssetOption
<sup>(deprecated)</sup>
媒体资源选项。
媒体资源选项。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
...
@@ -2243,11 +2243,11 @@ async function example() {
...
@@ -2243,11 +2243,11 @@ async function example() {
| 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
## MediaSelectOption
<sup>(deprecated)</sup>
媒体资源类型选项。
媒体资源类型选项。
本接口在OpenHarmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持
。
> **说明**: 从API Version 9开始废弃
。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
...
...
zh-cn/application-dev/reference/apis/js-apis-system-cipher.md
浏览文件 @
e7412f13
...
@@ -2,8 +2,7 @@
...
@@ -2,8 +2,7 @@
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
>
>
> - 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 3开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> - 本接口在OpenHarmony 3.1 Release版本仅为接口定义。接口将在OpenHarmony 3.1 MR版本提供使用支持。
## 导入模块
## 导入模块
...
...
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @
e7412f13
...
@@ -3,7 +3,6 @@
...
@@ -3,7 +3,6 @@
>![](public_sys-resources/icon-note.gif) **说明:**
>![](public_sys-resources/icon-note.gif) **说明:**
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>本模块首批接口从API version 6开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
>
>
>本接口在Openharmony 3.1 Release版本仅为接口定义,暂不支持使用。接口将在OpenHarmony 3.1 MR版本中提供使用支持。
使用WebSocket建立服务器与客户端的双向连接,需要先通过
[
createWebSocket
](
#websocketcreatewebsocket
)
方法创建
[
WebSocket
](
#websocket
)
对象,然后通过
[
connect
](
#connect
)
方法连接到服务器。当连接成功后,客户端会收到
[
open
](
#onopen
)
事件的回调,之后客户端就可以通过
[
send
](
#send
)
方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到
[
message
](
#onmessage
)
事件的回调。当客户端不要此连接时,可以通过调用
[
close
](
#close
)
方法主动断开连接,之后客户端会收到
[
close
](
#onclose
)
事件的回调。
使用WebSocket建立服务器与客户端的双向连接,需要先通过
[
createWebSocket
](
#websocketcreatewebsocket
)
方法创建
[
WebSocket
](
#websocket
)
对象,然后通过
[
connect
](
#connect
)
方法连接到服务器。当连接成功后,客户端会收到
[
open
](
#onopen
)
事件的回调,之后客户端就可以通过
[
send
](
#send
)
方法与服务器进行通信。当服务器发信息给客户端时,客户端会收到
[
message
](
#onmessage
)
事件的回调。当客户端不要此连接时,可以通过调用
[
close
](
#close
)
方法主动断开连接,之后客户端会收到
[
close
](
#onclose
)
事件的回调。
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录