muteAllPlayStreamVideo method

Future<void> muteAllPlayStreamVideo(
  1. bool mute
)

拉流是否可接收所有视频数据

支持版本:2.4.0 及以上。 详情描述:在实时音视频互动过程中,本地用户可根据需要,通过此函数控制拉流时是否接收所有远端用户的视频数据(包括在调用该函数后新加入房间的用户所推的视频流)。默认情况下,用户加入房间后可以接收所有远端用户推送的视频数据。当开发者不接收视频数据时,可降低硬件和网络的开销。 业务场景:当开发者需要快速关闭、恢复观看远端视频画面时,可调用此函数。相比重新拉流,能极大降低耗时,提升互动体验。 调用时机:在调用 createEngine 后可调用此函数。 注意事项:

  1. 此接口在 SDK 生命周期内不能和 muteAllPlayVideoStreams 混用。
  2. 当指定不接收视频流数据时,视图默认保持在最后一帧,如果需要清除最后一帧,请联系 ZEGO 技术支持。 相关接口:可调用 mutePlayStreamVideo 函数控制是否接收单条视频数据。必须当 muteAllPlayStreamVideomutePlayStreamVideo 两个函数同时设置为 "false" 时,本地用户拉流时才能接收远端用户的视频数据: 1. 当调用 muteAllPlayStreamVideo(true) 函数时,全局生效,即本地用户会禁止接收所有远端用户的视频数据,此时无论在 muteAllPlayStreamVideo 之前还是之后调用 mutePlayStreamVideo 函数都不生效。 2. 当调用 muteAllPlayStreamVideo(false) 函数时,本地用户可以接收所有远端用户的视频数据,此时可再通过 mutePlayStreamVideo 函数控制是否接收单条视频数据。调用 mutePlayStreamVideo(true, streamID) 函数则本地用户可以接收该 "streamID" 之外的其他视频数据;调用 mutePlayStreamVideo(false, streamID) 函数则本地用户可以接收 "streamID" 的视频数据。 注意:此函数仅在 ZegoExpressVideo SDK 中有效!
  • mute 拉流时是否可以接收所有远端用户的视频数据,“true” 表示禁止,“false” 表示接收,默认值为 “false”。

Implementation

Future<void> muteAllPlayStreamVideo(bool mute) async {
  return await ZegoExpressImpl.instance.muteAllPlayStreamVideo(mute);
}