提交 507628f4 编写于 作者: Z zhujie81

Add setInterruptMode interface of docs

Signed-off-by: Nzhujie81 <zhujie81@huawei.com>
上级 a6b2b103
# 音频焦点模式开发指导 # 音频焦点模式开发指导
## 场景介绍 ## 场景介绍
音频焦点模式指的是应用内,允许对多个声音的播放进行控制<br>
音频应用可以在AudioRenderer下设置独立焦点模式、共享焦点模式。<br> 音频应用可以在AudioRenderer下设置独立焦点模式、共享焦点模式。<br>
当设置在共享的模式下,多个音频可以进行同时共存播放;独立焦点模式下,仅支持一个音频; 当设置在共享的模式下,多个音频可以进行同时共存播放;独立焦点模式下,仅支持一个音频;
...@@ -24,7 +24,7 @@ ...@@ -24,7 +24,7 @@
var audioStreamInfo = { var audioStreamInfo = {
samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100,
channels: audio.AudioChannel.CHANNEL_1, channels: audio.AudioChannel.CHANNEL_1,
sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE,
encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW
} }
...@@ -42,14 +42,13 @@ ...@@ -42,14 +42,13 @@
let audioRenderer = await audio.createAudioRenderer(audioRendererOptions); let audioRenderer = await audio.createAudioRenderer(audioRendererOptions);
``` ```
2. 调用 2. 设置焦点模式
启动完成后,可以进行焦点模式调用。<br> 启动完成后,可以进行焦点模式调用。<br>
```js ```js
var mode_ = audio.InterruptMode.SHARE_MODE; var mode_ = audio.InterruptMode.SHARE_MODE;
await this.audioRenderer.setInterruptMode(mode_).then((value)=>{ await this.audioRenderer.setInterruptMode(mode_).then(()=>{
console.log('[JSAR] [audioRenderer.SetInterruptMode] value : ' + value);
console.log('[JSAR] [SetInterruptMode] 设置: ' + (mode == 0 ? "共享模式":"独立焦点模式") + "成功" ); console.log('[JSAR] [SetInterruptMode] 设置: ' + (mode == 0 ? "共享模式":"独立焦点模式") + "成功" );
}); });
``` ```
......
...@@ -246,16 +246,16 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { ...@@ -246,16 +246,16 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => {
| VOICE_ASSISTANT<sup>8+</sup> | 9 | 语音助手。 | | VOICE_ASSISTANT<sup>8+</sup> | 9 | 语音助手。 |
## InterruptMode ## InterruptMode<sup>9+</sup>
枚举,焦点模型类型 枚举,焦点模型。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.InterruptMode **系统能力:** SystemCapability.Multimedia.Audio.InterruptMode
| 名称 | 默认值 | 描述 | | 名称 | 默认值 | 描述 |
| ---------------------------- | ------ | ---------- | | ---------------------------- | ------ | ---------- |
| SHARE_MODE<sup>9+</sup> | 0 | 共享焦点模式。 | | SHARE_MODE | 0 | 共享焦点模式。 |
| INDEPENDENT_MODE<sup>9+</sup>| 1 | 独立焦点模式。 | | INDEPENDENT_MODE| 1 | 独立焦点模式。 |
## DeviceFlag ## DeviceFlag
...@@ -2490,9 +2490,9 @@ audioRenderer.getRenderRate().then((renderRate) => { ...@@ -2490,9 +2490,9 @@ audioRenderer.getRenderRate().then((renderRate) => {
``` ```
### setInterruptMode<sup>9+</sup> ### setInterruptMode<sup>9+</sup>
setInterruptMode(interruptType: InterruptType): Promise&lt;void&gt; setInterruptMode(interruptMode: InterruptMode): Promise&lt;void&gt;
设置指定流的音量,使用Promise方式异步返回结果 设置应用的焦点模型。使用Promise异步回调
**系统能力:** SystemCapability.Multimedia.Audio.Renderer **系统能力:** SystemCapability.Multimedia.Audio.Renderer
...@@ -2500,13 +2500,13 @@ setInterruptMode(interruptType: InterruptType): Promise&lt;void&gt; ...@@ -2500,13 +2500,13 @@ setInterruptMode(interruptType: InterruptType): Promise&lt;void&gt;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------- | ---- | -------------------------------------------------------- | | ---------- | ----------------------------------- | ---- | -------------------------------------------------------- |
| interruptType | [InterruptType](#InterruptMode) | 是 | 焦点模型类型。 | | interruptMode | [InterruptMode](#InterruptMode) | 是 | 焦点模型。 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ----------------------------- | | ------------------- | ----------------------------- |
| Promise&lt;void&gt; | Promise回调表示成功还是失败。 | | Promise&lt;void&gt; | 以Promise对象返回结果,设置成功时返回undefined,否则返回error。 |
**示例:** **示例:**
...@@ -2514,6 +2514,10 @@ setInterruptMode(interruptType: InterruptType): Promise&lt;void&gt; ...@@ -2514,6 +2514,10 @@ setInterruptMode(interruptType: InterruptType): Promise&lt;void&gt;
audioManager.setInterruptMode(audio.InterruptType.SHARE_MODE).then(() => { audioManager.setInterruptMode(audio.InterruptType.SHARE_MODE).then(() => {
console.log('Promise returned to indicate a successful volume setting.'); console.log('Promise returned to indicate a successful volume setting.');
}); });
audioManager.setInterruptMode(audio.InterruptType.SHARE_MODE,()=>{
console.log('Promise returned to indicate a successful volume setting.');
});
``` ```
### on('interrupt')<sup>9+</sup> ### on('interrupt')<sup>9+</sup>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册