Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 7e47fae3 编写于 作者: A Aurora
浏览文件
操作

IssueNo: 处理API一致性与API示例代码问题 

Description: 处理API一致性与API示例代码问题
Sig: SIG_Telephony
Feature or Bugfix: Feature
Binary Source: No
Signed-off-by: Nliuxiyao223 <liuxiyao223@huawei.com>
Change-Id: I2e60cf0d7196e244cd8f24e5a42372ea8163a87d
上级 53c15a75
隐藏空白更改
内联 并排
Showing with 72 addition and 22 deletion
zh-cn/application-dev/reference/apis/js-apis-call.md
浏览文件 @ 7e47fae3
...@@ -3598,7 +3598,7 @@ setAudioDevice\(device: AudioDevice, callback: AsyncCallback\<void\>\): void ...@@ -3598,7 +3598,7 @@ setAudioDevice\(device: AudioDevice, callback: AsyncCallback\<void\>\): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------- | | -------- | ---------------------------- | ---- | ---------- |
| device | [AudioDevice](#audiodevice8) | 是 | 音频设备。 | | device | [AudioDevice](#audiodevice10) | 是 | 音频设备。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -3617,11 +3617,58 @@ setAudioDevice\(device: AudioDevice, callback: AsyncCallback\<void\>\): void ...@@ -3617,11 +3617,58 @@ setAudioDevice\(device: AudioDevice, callback: AsyncCallback\<void\>\): void
**示例：** **示例：**
```js ```js
call.setAudioDevice(1, (err) => { let audioDevice={
deviceType: 1
}
call.setAudioDevice(audioDevice, (err) => {
console.log(`callback: err->${JSON.stringify(err)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
## call.setAudioDevice<sup>10+</sup>
setAudioDevice\(device: AudioDevice): Promise\<void\>
设置通话音频设备。使用Promise异步回调。
**系统接口：** 此接口为系统接口。
**需要权限**：ohos.permission.SET_TELEPHONY_STATE
**系统能力**：SystemCapability.Telephony.CallManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------- | ---- | ---------- |
| device | [AudioDevice](#audiodevice10) | 是 | 音频设备。 |
**错误码：**
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)。
| 错误码ID | 错误信息 |
| -------- | -------------------------------------------- |
| 201 | Permission denied. |
| 202 | Non-system applications use system APIs. |
| 401 | Parameter error. |
| 8300001 | Invalid parameter value. |
| 8300002 | Operation failed. Cannot connect to service. |
| 8300003 | System internal error. |
| 8300999 | Unknown error code. |
**示例：**
```js
let audioDevice={
deviceType: 1
}
call.setAudioDevice(audioDevice).then(() => {
console.log(`setAudioDevice success.`);
}).catch((err) => {
console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`);
});
```
## call.setAudioDevice<sup>9+</sup> ## call.setAudioDevice<sup>9+</sup>
...@@ -3637,7 +3684,7 @@ setAudioDevice\(device: AudioDevice, options: AudioDeviceOptions, callback: Asyn ...@@ -3637,7 +3684,7 @@ setAudioDevice\(device: AudioDevice, options: AudioDeviceOptions, callback: Asyn
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------ | ---- | -------------- | | -------- | ------------------------------------------ | ---- | -------------- |
| device | [AudioDevice](#audiodevice8) | 是 | 音频设备。 | | device | [AudioDevice](#audiodevice10) | 是 | 音频设备。 |
| options | [AudioDeviceOptions](#audiodeviceoptions9) | 是 | 音频设备参数。 | | options | [AudioDeviceOptions](#audiodeviceoptions9) | 是 | 音频设备参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
...@@ -3657,10 +3704,13 @@ setAudioDevice\(device: AudioDevice, options: AudioDeviceOptions, callback: Asyn ...@@ -3657,10 +3704,13 @@ setAudioDevice\(device: AudioDevice, options: AudioDeviceOptions, callback: Asyn
**示例：** **示例：**
```js ```js
let audioDevice={
deviceType: 1
}
let audioDeviceOptions={ let audioDeviceOptions={
bluetoothAddress: "IEEE 802-2014" bluetoothAddress: "IEEE 802-2014"
} }
call.setAudioDevice(1, audioDeviceOptions, (err) => { call.setAudioDevice(audioDevice, audioDeviceOptions, (err) => {
console.log(`callback: err->${JSON.stringify(err)}`); console.log(`callback: err->${JSON.stringify(err)}`);
}); });
``` ```
...@@ -3680,7 +3730,7 @@ setAudioDevice\(device: AudioDevice, options?: AudioDeviceOptions\): Promise\<vo ...@@ -3680,7 +3730,7 @@ setAudioDevice\(device: AudioDevice, options?: AudioDeviceOptions\): Promise\<vo
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------------------------------------------ | ---- | ------------------ | | ------- | ------------------------------------------ | ---- | ------------------ |
| device | [AudioDevice](#audiodevice8) | 是 | 音频设备。 | | device | [AudioDevice](#audiodevice10) | 是 | 音频设备。 |
| options | [AudioDeviceOptions](#audiodeviceoptions9) | 否 | 音频设备参数参数。 | | options | [AudioDeviceOptions](#audiodeviceoptions9) | 否 | 音频设备参数参数。 |
**返回值：** **返回值：**
...@@ -3705,10 +3755,13 @@ setAudioDevice\(device: AudioDevice, options?: AudioDeviceOptions\): Promise\<vo ...@@ -3705,10 +3755,13 @@ setAudioDevice\(device: AudioDevice, options?: AudioDeviceOptions\): Promise\<vo
**示例：** **示例：**
```js ```js
let audioDevice={
deviceType: 1
}
let audioDeviceOptions={ let audioDeviceOptions={
bluetoothAddress: "IEEE 802-2014" bluetoothAddress: "IEEE 802-2014"
} }
call.setAudioDevice(1, audioDeviceOptions).then(() => { call.setAudioDevice(audioDevice, audioDeviceOptions).then(() => {
console.log(`setAudioDevice success.`); console.log(`setAudioDevice success.`);
}).catch((err) => { }).catch((err) => {
console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`); console.error(`setAudioDevice fail, promise: err->${JSON.stringify(err)}`);
...@@ -4248,7 +4301,7 @@ call.closeUnfinishedUssd(slotId).then(() => { ...@@ -4248,7 +4301,7 @@ call.closeUnfinishedUssd(slotId).then(() => {
## call.setVoNRState<sup>10+</sup> ## call.setVoNRState<sup>10+</sup>
setVoNRState\(slotId: number, state: VoNRState, callback: AsyncCallback\<boolean\>\): void setVoNRState\(slotId: number, state: VoNRState, callback: AsyncCallback\<void\>\): void
设置NR语音的开关状态。使用callback异步回调。 设置NR语音的开关状态。使用callback异步回调。
...@@ -4264,7 +4317,7 @@ setVoNRState\(slotId: number, state: VoNRState, callback: AsyncCallback\<boolean ...@@ -4264,7 +4317,7 @@ setVoNRState\(slotId: number, state: VoNRState, callback: AsyncCallback\<boolean
| ----------- | ----------------------------- | ---- | ---------------------------------------------------- | | ----------- | ----------------------------- | ---- | ---------------------------------------------------- |
| slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 | | slotId | number | 是 | 卡槽ID。<br/>- 0：卡槽1<br/>- 1：卡槽2 |
| state | [VoNRState](#vonrstate10) | 是 | 开关状态。 | | state | [VoNRState](#vonrstate10) | 是 | 开关状态。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数。返回true表示设置成功，返回false表示设置失败。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -4293,7 +4346,7 @@ call.setVoNRState(slotId, state, (err, data) => { ...@@ -4293,7 +4346,7 @@ call.setVoNRState(slotId, state, (err, data) => {
## call.setVoNRState<sup>10+</sup> ## call.setVoNRState<sup>10+</sup>
setVoNRState\(slotId: number, state: VoNRState\): Promise\<boolean\> setVoNRState\(slotId: number, state: VoNRState\): Promise\<void\>
设置NR语音的开关状态。使用Promise异步回调。 设置NR语音的开关状态。使用Promise异步回调。
...@@ -4314,7 +4367,7 @@ setVoNRState\(slotId: number, state: VoNRState\): Promise\<boolean\> ...@@ -4314,7 +4367,7 @@ setVoNRState\(slotId: number, state: VoNRState\): Promise\<boolean\>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------------------------------- | | ---------------------- | --------------------------------------------- |
| Promise&lt;boolean&gt; | 以Promise形式异步返回开关状态是否设置成功。 | | Promise&lt;void&gt; | 以Promise形式异步返回结果。 |
**错误码：** **错误码：**
...@@ -4335,7 +4388,7 @@ setVoNRState\(slotId: number, state: VoNRState\): Promise\<boolean\> ...@@ -4335,7 +4388,7 @@ setVoNRState\(slotId: number, state: VoNRState\): Promise\<boolean\>
```js ```js
let slotId = 0; let slotId = 0;
let state = 1; let state = 1;
call.setVoNRState(slotId, state).then(() => { call.setVoNRState(slotId, state).then((data) => {
console.log(`setVoNRState success, promise: data->${JSON.stringify(data)}`); console.log(`setVoNRState success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => { }).catch((err) => {
console.error(`setVoNRState fail, promise: err->${JSON.stringify(err)}`); console.error(`setVoNRState fail, promise: err->${JSON.stringify(err)}`);
...@@ -4522,7 +4575,7 @@ canSetCallTransferTime\(slotId: number\): Promise\<boolean\> ...@@ -4522,7 +4575,7 @@ canSetCallTransferTime\(slotId: number\): Promise\<boolean\>
```js ```js
let slotId = 0; let slotId = 0;
call.canSetCallTransferTime(slotId).then(() => { call.canSetCallTransferTime(slotId).then((data) => {
console.log(`canSetCallTransferTime success, promise: data->${JSON.stringify(data)}`); console.log(`canSetCallTransferTime success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => { }).catch((err) => {
console.error(`canSetCallTransferTime fail, promise: err->${JSON.stringify(err)}`); console.error(`canSetCallTransferTime fail, promise: err->${JSON.stringify(err)}`);
...@@ -4710,7 +4763,7 @@ IP多媒体系统调用模式。 ...@@ -4710,7 +4763,7 @@ IP多媒体系统调用模式。
| VONR_STATE_OFF | 0 | 关闭状态 | | VONR_STATE_OFF | 0 | 关闭状态 |
| VONR_STATE_ON | 1 | 打开状态 | | VONR_STATE_ON | 1 | 打开状态 |
## AudioDevice<sup>8+</sup> ## AudioDevice<sup>10+</sup>
音频设备。 音频设备。
...@@ -4718,13 +4771,10 @@ IP多媒体系统调用模式。 ...@@ -4718,13 +4771,10 @@ IP多媒体系统调用模式。
**系统能力**：SystemCapability.Telephony.CallManager **系统能力**：SystemCapability.Telephony.CallManager
| 名称 | 值 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------------------- | ---- | ------------ | | --------------------------------- | ------------------------------------- | ---- | ---------------- |
| DEVICE_EARPIECE | 0 | 耳机设备 | | deviceType <sup>10+</sup> | [AudioDeviceType](#audiodevicetype10) | 是 | 音频设备类型。 |
| DEVICE_SPEAKER | 1 | 扬声器设备 | | address <sup>10+</sup> | string | 否 | 音频设备地址。 |
| DEVICE_WIRED_HEADSET | 2 | 有线耳机设备 |
| DEVICE_BLUETOOTH_SCO | 3 | 蓝牙SCO设备 |
| DEVICE_MIC | 4 | 麦克风设备 |
## AudioDeviceType<sup>10+</sup> ## AudioDeviceType<sup>10+</sup>
...@@ -4751,8 +4801,8 @@ IP多媒体系统调用模式。 ...@@ -4751,8 +4801,8 @@ IP多媒体系统调用模式。
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------------------------- | ------------------------------------- | ---- | ---------------- | | --------------------------------- | ------------------------------------- | ---- | ---------------- |
| audioDeviceList <sup>10+</sup> | [Array\<AudioDevice\>](#audiodevice8) | 是 | 音频设备列表。 | | audioDeviceList <sup>10+</sup> | [Array\<AudioDevice\>](#audiodevice10) | 是 | 音频设备列表。 |
| currentAudioDevice <sup>10+</sup> | [AudioDevice](#audiodevice8) | 是 | 音频设备类型。 | | currentAudioDevice <sup>10+</sup> | [AudioDevice](#audiodevice10) | 是 | 音频设备类型。 |
| isMuted <sup>10+</sup> | boolean | 是 | 是否静音。 | | isMuted <sup>10+</sup> | boolean | 是 | 是否静音。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或