保利威文档中心

帮助中心

连麦模块

更新时间:2026-06-05 13:23:19

连麦模块(connectMic) 是基于保利威 连麦SDK 实现的一个控制模块,用于实现观众与主讲之间的连麦功能,如:申请连麦,打开设备调试等。

一、Api 方法概览

Api 方法 说明
getConnectMicInfo 获取连麦信息
isConnectMicing 判断连麦状态是否处于连麦中
getNetworkInfo 获取连麦网络信息
changeFacingMode 切换前后摄像头
getConnectMicList 获取连麦列表
supportConnectMic 是否支持连麦功能
setupConnectMic 设置连麦
joinAsAudience 以观众模式加入连麦房间, 仅订阅讲师流,不推本地流
leaveAudience 离开观众模式
stopSmallClassStat 小班课场景停止统计
isAudienceModeJoined 当前是否为观众模式
toggleMirror 切换镜像开关状态
getMirrorEnabled 获取镜像状态
openDeviceSetting 打开设备设置界面
closeDeviceSetting 关闭设备设置界面
openInviting 打开邀请上麦界面
closeInviting 关闭邀请上麦界面
acceptInvite 接受讲师上麦邀请
refuseInvite 拒绝讲师上麦邀请
getInviteCountDown 获取邀请上麦倒计时
startPreview 开启本地预览
stopPreview 停止本地预览
isPreviewing 是否正在本地预览
getPreviewVolume 获取本地预览的当前音量(0~1)
getLocalMuteStatus 获取当前本地音视频静音状态
setLocalMuteStatus 预设/调整本地音视频开关
applyConnectMic 观众申请连麦
cancelApplyConnectMic 取消连麦申请
publishLocalStream 推送本地连麦流
endConnectMic 结束连麦
enabledVideo 开启本地摄像头
disabledVideo 关闭本地摄像头
enabledAudio 开启本地麦克风
disabledAudio 关闭本地麦克风
getScreenShareInfo 获取屏幕共享信息
setScreenShareConfig 设置屏幕共享配置
startScreenShare 开始屏幕共享
stopScreenShare 停止屏幕共享
enterPip 显示用户摄像头(画中画)
exitPip 隐藏用户摄像头(画中画)
resumeAllStreams 恢复所有流播放

二、Event 事件概览

Event 事件 说明
ConnectMicEvents.ConnectMicInfoChange 连麦信息改变
ConnectMicEvents.NetworkInfoChange 连麦网络信息改变
ConnectMicEvents.OpenConnectMic 讲师开启连麦功能
ConnectMicEvents.CloseConnectMic 讲师关闭连麦功能
ConnectMicEvents.ConnectMicListChange 连麦列表修改
ConnectMicEvents.TeacherHangUp 讲师挂断当前连麦者
ConnectMicEvents.InviteConnectMic 邀请上麦
ConnectMicEvents.InviteConnectMicAnswer 邀请上麦回复
ConnectMicEvents.DeviceRecoverFail 设备采集失败
ConnectMicEvents.ConnectMicOverLimit 连麦人数到达上限
ConnectMicEvents.CurrentSpeakerStatusChanged 当前主讲状态改变
ConnectMicEvents.AllowConnectMicApply 讲师同意连麦申请
ConnectMicEvents.LocalStreamInited 本地流初始化成功
ConnectMicEvents.PublishStreamSuccess 本地流推送成功
ConnectMicEvents.LeaveConnectMicSuccess 离开连麦成功
ConnectMicEvents.RemoteAudioMuteChange 远端连麦用户麦克风开关改变
ConnectMicEvents.RemoteVideoMuteChange 远端连麦用户摄像头开关改变
ConnectMicEvents.LocalAudioMuteChange 本地麦克风开关改变
ConnectMicEvents.LocalVideoMuteChange 本地摄像头开关改变
ConnectMicEvents.SwitchMaster 切换第一画面
ConnectMicEvents.ScreenShareInfoChange 屏幕共享信息改变
ConnectMicEvents.ScreenShareStart 屏幕共享开始
ConnectMicEvents.ScreenShareStop 屏幕共享结束
ConnectMicEvents.ApplyTimeOut 举手申请连麦超时
ConnectMicEvents.FacingModeChange 前后摄像头切换
ConnectMicEvents.UserStreamPlayFailed 用户流播放失败
ConnectMicEvents.InviteCountDown 邀请上麦倒计时
ConnectMicEvents.LocalMuteStatusChange 本地音视频开关变更(预设 / 预览阶段)
联系客服,在线咨询