Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 eb764bc3 编写于 作者: W wangzx0705
浏览文件
操作

modify md doc format 

Signed-off-by: Nwangzx0705 <wangzx0705@thundersoft.com>
上级 f5d82986
隐藏空白更改
内联 并排
Showing with 81 addition and 29 deletion
zh-cn/application-dev/reference/apis/js-apis-audio.md
浏览文件 @ eb764bc3
...@@ -3000,8 +3000,8 @@ isVolumeUnadjustable(): boolean ...@@ -3000,8 +3000,8 @@ isVolumeUnadjustable(): boolean
**示例：** **示例：**
```js ```js
bool switch = audioVolumeGroupManager.isVolumeUnadjustable(); bool volumeAdjustSwitch = audioVolumeGroupManager.isVolumeUnadjustable();
console.info(`Whether it is volume unadjustable: ${switch}.`); console.info(`Whether it is volume unadjustable: ${volumeAdjustSwitch}.`);
``` ```
### adjustVolumeByStep<sup>10+</sup> ### adjustVolumeByStep<sup>10+</sup>
...@@ -3025,6 +3025,15 @@ adjustVolumeByStep(adjustType: VolumeAdjustType, callback: AsyncCallback&lt;void ...@@ -3025,6 +3025,15 @@ adjustVolumeByStep(adjustType: VolumeAdjustType, callback: AsyncCallback&lt;void
| adjustType | [VolumeAdjustType](#volumeadjusttype10) | 是 | 音量调节方向。 | | adjustType | [VolumeAdjustType](#volumeadjusttype10) | 是 | 音量调节方向。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调表示成功还是失败。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调表示成功还是失败。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
```js ```js
...@@ -3063,6 +3072,15 @@ adjustVolumeByStep(adjustType: VolumeAdjustType): Promise&lt;void&gt; ...@@ -3063,6 +3072,15 @@ adjustVolumeByStep(adjustType: VolumeAdjustType): Promise&lt;void&gt;
| ------------------- | ----------------------------- | | ------------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise回调表示成功还是失败。 | | Promise&lt;void&gt; | Promise回调表示成功还是失败。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
```js ```js
...@@ -3095,6 +3113,15 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy ...@@ -3095,6 +3113,15 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy
| adjustType | [VolumeAdjustType](#volumeadjusttype10) | 是 | 音量调节方向。 | | adjustType | [VolumeAdjustType](#volumeadjusttype10) | 是 | 音量调节方向。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调表示成功还是失败。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调表示成功还是失败。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
```js ```js
...@@ -3133,6 +3160,15 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy ...@@ -3133,6 +3160,15 @@ adjustSystemVolumeByStep(volumeType: AudioVolumeType, adjustType: VolumeAdjustTy
| ------------------- | ----------------------------- | | ------------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise回调表示成功还是失败。 | | Promise&lt;void&gt; | Promise回调表示成功还是失败。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
```js ```js
...@@ -3160,7 +3196,16 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De ...@@ -3160,7 +3196,16 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De
| volumeType | [AudioVolumeType](#audiovolumetype) | 是 | 音量流类型。 | | volumeType | [AudioVolumeType](#audiovolumetype) | 是 | 音量流类型。 |
| volumeLevel | number | 是 | 音量等级。 | | volumeLevel | number | 是 | 音量等级。 |
| device | [DeviceType](#devicetype) | 是 | 设备类型。 | | device | [DeviceType](#devicetype) | 是 | 设备类型。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 回调返回对应的音量增益DB值。 | | callback | AsyncCallback&lt;number&gt; | 是 | 回调返回对应的音量增益dB值。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
...@@ -3177,7 +3222,7 @@ audioVolumeGroupManager.getSystemVolumeInDb(audio.AudioVolumeType.MEDIA, 3, audi ...@@ -3177,7 +3222,7 @@ audioVolumeGroupManager.getSystemVolumeInDb(audio.AudioVolumeType.MEDIA, 3, audi
getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: DeviceType): Promise&lt;number&gt; getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: DeviceType): Promise&lt;number&gt;
获取音量增益DB值，使用Promise方式异步返回结果。 获取音量增益dB值，使用Promise方式异步返回结果。
**系统接口：** 该接口为系统接口 **系统接口：** 该接口为系统接口
...@@ -3195,7 +3240,16 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De ...@@ -3195,7 +3240,16 @@ getSystemVolumeInDb(volumeType: AudioVolumeType, volumeLevel: number, device: De
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------------------- | | --------------------- | ---------------------------------- |
| Promise&lt;number&gt; | Promise回调返回对应的音量增益DB值。 | | Promise&lt;number&gt; | Promise回调返回对应的音量增益dB值。 |
**错误码：**
以下错误码的详细介绍请参见[音频错误码](../errorcodes/errorcode-audio.md)。
| 错误码ID | 错误信息 |
| ------- | --------------------------------------------|
| 6800101 | Invalid parameter error |
| 6800301 | System error |
**示例：** **示例：**
...@@ -5520,7 +5574,7 @@ getMinStreamVolume(): Promise&lt;number&gt; ...@@ -5520,7 +5574,7 @@ getMinStreamVolume(): Promise&lt;number&gt;
**示例：** **示例：**
```js ```js
audioRenderer.getMinStreamVolume().then(value => { audioRenderer.getMinStreamVolume().then((value) => {
console.info(`Get min stream volume Success! ${value}`); console.info(`Get min stream volume Success! ${value}`);
}).catch((err) => { }).catch((err) => {
console.error(`Get min stream volume Fail: ${err}`); console.error(`Get min stream volume Fail: ${err}`);
...@@ -5569,7 +5623,7 @@ getMaxStreamVolume(): Promise&lt;number&gt; ...@@ -5569,7 +5623,7 @@ getMaxStreamVolume(): Promise&lt;number&gt;
**示例：** **示例：**
```js ```js
audioRenderer.getMaxStreamVolume().then(value => { audioRenderer.getMaxStreamVolume().then((value) => {
console.info(`Get max stream volume Success! ${value}`); console.info(`Get max stream volume Success! ${value}`);
}).catch((err) => { }).catch((err) => {
console.error(`Get max stream volume Fail: ${err}`); console.error(`Get max stream volume Fail: ${err}`);
...@@ -5618,7 +5672,7 @@ getUnderflowCount(): Promise&lt;number&gt; ...@@ -5618,7 +5672,7 @@ getUnderflowCount(): Promise&lt;number&gt;
**示例：** **示例：**
```js ```js
audioRenderer.getUnderflowCount().then(value => { audioRenderer.getUnderflowCount().then((value) => {
console.info(`Get underflow count Success! ${value}`); console.info(`Get underflow count Success! ${value}`);
}).catch((err) => { }).catch((err) => {
console.error(`Get underflow count Fail: ${err}`); console.error(`Get underflow count Fail: ${err}`);
...@@ -5644,16 +5698,16 @@ getCurrentOutputDevices(callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;): ...@@ -5644,16 +5698,16 @@ getCurrentOutputDevices(callback: AsyncCallback&lt;AudioDeviceDescriptors&gt;):
```js ```js
audioRenderer.getCurrentOutputDevices((err, deviceInfo) => { audioRenderer.getCurrentOutputDevices((err, deviceInfo) => {
if (err) { if (err) {
console.error(`getCurrentOutputDevices Fail: ${err}`); console.error(`getCurrentOutputDevices Fail: ${err}`);
} else { } else {
console.info(`DeviceInfo id: ${deviceInfo.id}`); console.info(`DeviceInfo id: ${deviceInfo.id}`);
console.info(`DeviceInfo type: ${descriptor.deviceType}`); console.info(`DeviceInfo type: ${descriptor.deviceType}`);
console.info(`DeviceInfo role: ${descriptor.deviceRole}`); console.info(`DeviceInfo role: ${descriptor.deviceRole}`);
console.info(`DeviceInfo name: ${descriptor.name}`); console.info(`DeviceInfo name: ${descriptor.name}`);
console.info(`DeviceInfo address: ${descriptor.address}`); console.info(`DeviceInfo address: ${descriptor.address}`);
console.info(`DeviceInfo samplerates: ${descriptor.sampleRates[0]}`); console.info(`DeviceInfo samplerates: ${descriptor.sampleRates[0]}`);
console.info(`DeviceInfo channelcounts: ${descriptor.channelCounts[0]}`); console.info(`DeviceInfo channelcounts: ${descriptor.channelCounts[0]}`);
console.info(`DeviceInfo channelmask: ${descriptor.channelMasks}`); console.info(`DeviceInfo channelmask: ${descriptor.channelMasks}`);
} }
}); });
``` ```
...@@ -5669,12 +5723,12 @@ getCurrentOutputDevices(): Promise&lt;AudioDeviceDescriptors&gt; ...@@ -5669,12 +5723,12 @@ getCurrentOutputDevices(): Promise&lt;AudioDeviceDescriptors&gt;
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------- | | ------------------- | ----------------------------- |
| Promise&lt;AudioDeviceDescriptors&gt;| Promise回调返回音频流的输出设备描述符。| | Promise&lt;AudioDeviceDescriptors&gt;| Promise回调返回音频流的输出设备描述信息 |
**示例：** **示例：**
```js ```js
audioRenderer.getCurrentOutputDevices().then(deviceInfo => { audioRenderer.getCurrentOutputDevices().then((deviceInfo) => {
console.info(`DeviceInfo id: ${deviceInfo.id}`); console.info(`DeviceInfo id: ${deviceInfo.id}`);
console.info(`DeviceInfo type: ${descriptor.deviceType}`); console.info(`DeviceInfo type: ${descriptor.deviceType}`);
console.info(`DeviceInfo role: ${descriptor.deviceRole}`); console.info(`DeviceInfo role: ${descriptor.deviceRole}`);
...@@ -5925,7 +5979,6 @@ on(type: 'outputDeviceChange', callback: Callback<AudioDeviceDescriptors\>): voi ...@@ -5925,7 +5979,6 @@ on(type: 'outputDeviceChange', callback: Callback<AudioDeviceDescriptors\>): voi
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 401 | if input parameter type or number mismatch |
| 6800101 | if input parameter value error | | 6800101 | if input parameter value error |
**示例：** **示例：**
...@@ -5933,10 +5986,10 @@ on(type: 'outputDeviceChange', callback: Callback<AudioDeviceDescriptors\>): voi ...@@ -5933,10 +5986,10 @@ on(type: 'outputDeviceChange', callback: Callback<AudioDeviceDescriptors\>): voi
```js ```js
audioRenderer.on('outputDeviceChange', (deviceChangeInfo) => { audioRenderer.on('outputDeviceChange', (deviceChangeInfo) => {
if (err) { if (err) {
console.error(`Subscribes output device change event callback Fail: ${err}`); console.error(`Subscribes output device change event callback Fail: ${err}`);
} else { } else {
console.info(`Subscribes output device change event callback Success!`); console.info(`Subscribes output device change event callback Success!`);
} }
}); });
``` ```
### off('outputDeviceChange') <sup>10+</sup> ### off('outputDeviceChange') <sup>10+</sup>
...@@ -5958,7 +6011,6 @@ off(type: 'outputDeviceChange', callback?: Callback<AudioDeviceDescriptors\>): v ...@@ -5958,7 +6011,6 @@ off(type: 'outputDeviceChange', callback?: Callback<AudioDeviceDescriptors\>): v
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ------- | --------------------------------------------| | ------- | --------------------------------------------|
| 401 | if input parameter type or number mismatch |
| 6800101 | if input parameter value error | | 6800101 | if input parameter value error |
**示例：** **示例：**
...@@ -5966,10 +6018,10 @@ off(type: 'outputDeviceChange', callback?: Callback<AudioDeviceDescriptors\>): v ...@@ -5966,10 +6018,10 @@ off(type: 'outputDeviceChange', callback?: Callback<AudioDeviceDescriptors\>): v
```js ```js
audioRenderer.off('outputDeviceChange', (deviceChangeInfo) => { audioRenderer.off('outputDeviceChange', (deviceChangeInfo) => {
if (err) { if (err) {
console.error(`Unsubscribes output device change event callback Fail: ${err}`); console.error(`Unsubscribes output device change event callback Fail: ${err}`);
} else { } else {
console.info(`Unsubscribes output device change event callback Success!`); console.info(`Unsubscribes output device change event callback Success!`);
} }
}); });
``` ```
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或