diff --git a/zh-cn/application-dev/media/audio-interruptmode.md b/zh-cn/application-dev/media/audio-interruptmode.md new file mode 100644 index 0000000000000000000000000000000000000000..121cf5677b935d0991e6ba78305bef055ab1049f --- /dev/null +++ b/zh-cn/application-dev/media/audio-interruptmode.md @@ -0,0 +1,54 @@ +# 音频焦点模式开发指导 + +## 场景介绍 + +音频应用可以在AudioRenderer下设置独立焦点模式、共享焦点模式。
+当设置在共享的模式下,多个音频可以进行同时共存播放;独立焦点模式下,仅支持一个音频; + +### 异步操作 + +为保证UI线程不被阻塞,大部分AudioRenderer调用都是异步的。对于每个API均提供了callback函数和Promise函数,以下示例均采用Promise函数。 + +## 开发步骤 + +详细API含义可参考:[音频管理API文档AudioRenderer](../reference/apis/js-apis-audio.md#audiorenderer8) + + +1. 使用createAudioRenderer()创建一个AudioRenderer实例。
+ 在audioCapturerOptions中设置相关参数。
+ 该实例可用于音频渲染、控制和获取采集状态,以及注册通知回调。
+ + ```js + var audioStreamInfo = { + samplingRate: audio.AudioSamplingRate.SAMPLE_RATE_44100, + channels: audio.AudioChannel.CHANNEL_1, + sampleFormat: audio.AudioSampleFormat.SAMPLE_FORMAT_S16LE, + encodingType: audio.AudioEncodingType.ENCODING_TYPE_RAW + } + + var audioRendererInfo = { + content: audio.ContentType.CONTENT_TYPE_SPEECH, + usage: audio.StreamUsage.STREAM_USAGE_VOICE_COMMUNICATION, + rendererFlags: 1 + } + + var audioRendererOptions = { + streamInfo: audioStreamInfo, + rendererInfo: audioRendererInfo + } + + let audioRenderer = await audio.createAudioRenderer(audioRendererOptions); + ``` + +2. 调用。 + + 启动完成后,可以进行焦点模式调用。
+ + ```js + var mode_ = audio.InterruptMode.SHARE_MODE; + await this.audioRenderer.setInterruptMode(mode_).then((value)=>{ + console.log('[JSAR] [audioRenderer.SetInterruptMode] value : ' + value); + console.log('[JSAR] [SetInterruptMode] 设置: ' + (mode == 0 ? "共享模式":"独立焦点模式") + "成功" ); + }); + ``` + diff --git a/zh-cn/application-dev/reference/apis/js-apis-audio.md b/zh-cn/application-dev/reference/apis/js-apis-audio.md index b139f5d85819888d663b04029172408e5f1dc921..03151c7ed33ee09b7dc11a3e259ea8111790cfae 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-audio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-audio.md @@ -246,6 +246,17 @@ audio.createAudioRenderer(audioCapturerOptions).then((data) => { | VOICE_ASSISTANT8+ | 9 | 语音助手。 | +## InterruptMode + +枚举,焦点模型类型。 + +**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.Audio.InterruptMode + +| 名称 | 默认值 | 描述 | +| ---------------------------- | ------ | ---------- | +| SHARE_MODE8+ | 0 | 共享焦点模式。 | +| INDEPENDENT_MODE8+| 1 | 独立焦点模式。 | + ## DeviceFlag 枚举,可获取的设备种类。 @@ -2477,7 +2488,33 @@ audioRenderer.getRenderRate().then((renderRate) => { console.log('ERROR: '+err.message); }); ``` +### setInterruptMode9+ + +setInterruptMode(interruptType: InterruptType): Promise<void> + +设置指定流的音量,使用Promise方式异步返回结果。 + +**系统能力:** SystemCapability.Multimedia.Audio.Renderer + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| ---------- | ----------------------------------- | ---- | -------------------------------------------------------- | +| interruptType | [InterruptType](#InterruptMode) | 是 | 焦点模型类型。 | + +**返回值:** + +| 类型 | 说明 | +| ------------------- | ----------------------------- | +| Promise<void> | Promise回调表示成功还是失败。 | + +**示例:** +``` +audioManager.setInterruptMode(audio.InterruptType.SHARE_MODE).then(() => { + console.log('Promise returned to indicate a successful volume setting.'); +}); +``` ### on('interrupt')9+ on(type: 'interrupt', callback: Callback\): void