mutePlayStreamAudio method

Future<void> mutePlayStreamAudio(
  1. String streamID,
  2. bool mute
)

拉流是否可接收指定音频数据。

支持版本:1.1.0 及以上。 详情描述:在实时音视频互动过程中,本地用户可根据需要,通过此函数控制拉流时是否接收指定远端用户的音频数据,当开发者不接收音频收据时,可降低硬件和网络的开销。 业务场景:当开发者需要快速关闭、恢复远端音频时,可调用此函数。相比重新拉流,能极大降低耗时,提升互动体验。 调用时机:在调用 createEngine 后可调用此函数。 注意事项:

  1. muteAllPlayAudioStreams 一起使用时,可以互相覆盖配置。
  2. muteAllPlayStreamAudio 一起使用时,只有当 muteAllPlayStreamAudio 函数设置为 “false”时,此函数才有效。
  3. 停止拉流后对此条流此前设置的属性如 setPlayVolumemutePlayStreamAudiomutePlayStreamVideo 等拉流相关的配置都会失效,需要在下次拉流之前重新设置。 相关接口:可调用 muteAllPlayStreamAudio 函数控制是否接收所有音频数据。必须当 muteAllPlayStreamAudiomutePlayStreamAudio 两个函数同时设置为 "false" 时,本地用户拉流时才能接收远端用户的音频数据:1. 当调用 muteAllPlayStreamAudio(true) 函数时,全局生效,即本地用户会禁止接收所有远端用户的音频数据,此时无论在 muteAllPlayStreamAudio 之前还是之后调用 mutePlayStreamAudio 函数都不生效。2. 当调用 muteAllPlayStreamAudio(false) 函数时,本地用户可以接收所有远端用户的音频数据,此时可再通过 mutePlayStreamAudio 函数控制是否接收单条音频数据。调用 mutePlayStreamAudio(true, streamID) 函数则本地用户可以接收该 "streamID" 之外的其他音频数据;调用 mutePlayStreamAudio(false, streamID) 函数则本地用户可以接收 "streamID" 的音频数据。
  • streamID 流 ID。
  • mute 拉流时是否可以接收指定远端用户的音频数据,“true” 表示禁止,“false” 表示接收,默认值为 “false”。

Implementation

Future<void> mutePlayStreamAudio(String streamID, bool mute) async {
  return await ZegoExpressImpl.instance.mutePlayStreamAudio(streamID, mute);
}