未验证 提交 67f0df3a 编写于 作者: O openharmony_ci 提交者: Gitee

!4518 MR版本实现接口说明修改

Merge pull request !4518 from zengyawen/master
...@@ -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
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
...@@ -616,10 +610,10 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { ...@@ -616,10 +610,10 @@ 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
**参数:** **参数:**
......
...@@ -465,8 +465,6 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): void ...@@ -465,8 +465,6 @@ selectContact(callback: AsyncCallback&lt;Array&lt;Contact&gt;&gt;): 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&lt;Array&lt;Contact&gt;&gt; ...@@ -495,8 +493,6 @@ selectContact(): Promise&lt;Array&lt;Contact&gt;&gt;
选择联系人,使用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格式创建数据:
......
...@@ -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&lt;string&gt;): void storeMediaAsset(option: MediaAssetOption, callback: AsyncCallback&lt;string&gt;): 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&lt;string&gt; storeMediaAsset(option: MediaAssetOption): Promise&lt;string&gt;
保存媒体资源,以异步方法获取保存成功的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&lt;string&gt;, index: number, callback: AsyncCallback&lt;void&gt;): void startImagePreview(images: Array&lt;string&gt;, index: number, callback: AsyncCallback&lt;void&gt;): 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&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): void startImagePreview(images: Array&lt;string&gt;, callback: AsyncCallback&lt;void&gt;): 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&lt;string&gt;, index?: number): Promise&lt;void&gt; startImagePreview(images: Array&lt;string&gt;, index?: number): Promise&lt;void&gt;
启动图片预览界面并限定预览开始显示的图片。可以预览指定序号的单张本地图片(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&lt;Array&lt;string&gt;&gt;): void startMediaSelect(option: MediaSelectOption, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): 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&lt;Array&lt;string&gt;&gt; startMediaSelect(option: MediaSelectOption): Promise&lt;Array&lt;string&gt;&gt;
启动媒体选择界面,以异步方法获取选择的媒体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&nbsp;Internet&nbsp;Mail&nbsp;Extensions)类型。<br/>包括:'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | | mimeType | string | 是 | 媒体MIME(Multipurpose&nbsp;Internet&nbsp;Mail&nbsp;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
......
...@@ -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版本提供使用支持。
## 导入模块 ## 导入模块
......
...@@ -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.
先完成此消息的编辑!
想要评论请 注册