Connect Mic Module
Updated: 2026-06-05 13:23:19
连麦模块(connectMic) is a control module based on Polyv 连麦SDK, used to implement the connect mic functionality between the audience and the host, such as applying to connect a mic and opening device debugging.
1. API Method Overview
| API Method | Description |
|---|---|
| getConnectMicInfo | Get connect mic information |
| isConnectMicing | Check if the connect mic status is currently connected |
| getNetworkInfo | Get connect mic network information |
| changeFacingMode | Switch between front and rear cameras |
| getConnectMicList | Get the connect mic list |
| supportConnectMic | Check if connect mic functionality is supported |
| setupConnectMic | Set up connect mic |
| joinAsAudience | Join the connect mic room as an audience member, only subscribe to the lecturer's stream without pushing local stream |
| leaveAudience | Leave audience mode |
| stopSmallClassStat | Stop statistics for small class scenario |
| isAudienceModeJoined | Check if currently in audience mode |
| toggleMirror | Toggle mirror switch state |
| getMirrorEnabled | Get mirror state |
| openDeviceSetting | Open device settings interface |
| closeDeviceSetting | Close device settings interface |
| openInviting | Open the invite to mic interface |
| closeInviting | Close the invite to mic interface |
| acceptInvite | Accept the lecturer's mic invitation |
| refuseInvite | Refuse the lecturer's mic invitation |
| getInviteCountDown | Get the invite to mic countdown |
| startPreview | Start local preview |
| stopPreview | Stop local preview |
| isPreviewing | Check if currently in local preview |
| getPreviewVolume | Get the current volume of local preview (0~1) |
| getLocalMuteStatus | Get the current local audio/video mute status |
| setLocalMuteStatus | Preset/adjust local audio/video switch |
| applyConnectMic | Audience applies to connect mic |
| cancelApplyConnectMic | Cancel connect mic application |
| publishLocalStream | Push local connect mic stream |
| endConnectMic | End connect mic |
| enabledVideo | Enable local camera |
| disabledVideo | Disable local camera |
| enabledAudio | Enable local microphone |
| disabledAudio | Disable local microphone |
| getScreenShareInfo | Get screen share information |
| setScreenShareConfig | Set screen share configuration |
| startScreenShare | Start screen sharing |
| stopScreenShare | Stop screen sharing |
| enterPip | Show user camera (picture-in-picture) |
| exitPip | Hide user camera (picture-in-picture) |
resumeAllStreams |
Resume all stream playback |
2. Event Overview
| Event | Description |
|---|---|
| ConnectMicEvents.ConnectMicInfoChange | Connect mic information changed |
| ConnectMicEvents.NetworkInfoChange | Connect mic network information changed |
| ConnectMicEvents.OpenConnectMic | Lecturer enables connect mic functionality |
| ConnectMicEvents.CloseConnectMic | Lecturer disables connect mic functionality |
| ConnectMicEvents.ConnectMicListChange | Connect mic list modified |
| ConnectMicEvents.TeacherHangUp | Lecturer hangs up on the current connected mic user |
| ConnectMicEvents.InviteConnectMic | Invite to mic |
| ConnectMicEvents.InviteConnectMicAnswer | Invite to mic reply |
| ConnectMicEvents.DeviceRecoverFail | Device capture failed |
| ConnectMicEvents.ConnectMicOverLimit | Connect mic user limit reached |
| ConnectMicEvents.CurrentSpeakerStatusChanged | Current speaker status changed |
| ConnectMicEvents.AllowConnectMicApply | Lecturer approves connect mic application |
| ConnectMicEvents.LocalStreamInited | Local stream initialized successfully |
| ConnectMicEvents.PublishStreamSuccess | Local stream pushed successfully |
| ConnectMicEvents.LeaveConnectMicSuccess | Left connect mic successfully |
| ConnectMicEvents.RemoteAudioMuteChange | Remote connected mic user's microphone switch changed |
| ConnectMicEvents.RemoteVideoMuteChange | Remote connected mic user's camera switch changed |
| ConnectMicEvents.LocalAudioMuteChange | Local microphone switch changed |
| ConnectMicEvents.LocalVideoMuteChange | Local camera switch changed |
| ConnectMicEvents.SwitchMaster | Switch primary display |
| ConnectMicEvents.ScreenShareInfoChange | Screen share information changed |
| ConnectMicEvents.ScreenShareStart | Screen sharing started |
| ConnectMicEvents.ScreenShareStop | Screen sharing stopped |
| ConnectMicEvents.ApplyTimeOut | Hand-raise connect mic application timed out |
| ConnectMicEvents.FacingModeChange | Front/rear camera switched |
| ConnectMicEvents.UserStreamPlayFailed | User stream playback failed |
| ConnectMicEvents.InviteCountDown | Invite to mic countdown |
| ConnectMicEvents.LocalMuteStatusChange | Local audio/video switch changed (preset/preview stage) |
