muteLocalVideoStream abstract method
取消或恢复发布本端视频主流。
调用该方法取消发布本地视频主流后,SDK 不再发送本地视频主流。
使用前提
一般在通过 enableLocalVideo 接口开启本地视频采集并发送后调用该方法。
调用时机
请在初始化后调用该方法,且该方法在加入房间前后均可调用。
说明
- 调用该方法取消发布本地视频流时,设备仍然处于工作状态。
- 该方法设置内部引擎为启用状态,在 leaveChannel 后设置失效,将恢复至默认,即默认发布本地视频流。
- 该方法与 enableLocalVideo 的区别在于,enableLocalVideo会关闭本地摄像头设备,muteLocalVideoStream 方法不禁用摄像头,不会影响本地视频流采集且响应速度更快。
参数说明
mute
是否取消发布本地视频流:
- true: 取消发布本地视频流。
- false : 恢复发布本地视频流。 相关回调
调用此接口成功后,远端会触发 NERtcChannelEventCallback.onUserVideoMute 回调,通知有用户暂停或恢复发送视频主流。
返回值
- 0(OK):方法调用成功。
- 其他:方法调用失败。
- 30005(invalidState):状态错误,比如引擎尚未初始化。
- 30004(notSupported):不支持的操作,比如当前使用的是纯音频 SDK。
Implementation
Future<int> muteLocalVideoStream(bool mute,
{int streamType = NERtcVideoStreamType.main});