Connect Mic Module
Updated: 2024-10-10 17:27:10
连麦模块(connectMic) is a control module implemented based on Polyv 连麦SDK, used to implement the connection function between the audience and the host, such as: applying for a connection, opening device debugging, etc.
1. API Method Overview
| API Method | Description |
|---|---|
| getConnectMicInfo | Get connection mic information |
| getMicDatas | Get connection mic list |
| isConnectMicing | Check if currently in a connection mic session |
| supportConnectMic | Check if connection mic feature is supported |
| setupConnectMic | Set up connection mic |
| applyConnectMic | Audience applies for connection mic |
| cancelApplyConnectMic | Cancel connection mic application |
| endConnectMic | End connection mic |
| startStream | Start pushing local stream |
| enabledVideo | Enable local camera |
| disabledVideo | Disable local camera |
| enabledAudio | Enable local microphone |
| disabledAudio | Disable local microphone |
| switchCamera | Switch between front and rear cameras |
pusherEventHandler |
<live-pusher> event callback |
pusherNetStatusHandler |
<live-pusher> event callback |
pusherErrorHandler |
<live-pusher> event callback |
pusherBGMStartHandler |
<live-pusher> event callback |
pusherBGMProgressHandler |
<live-pusher> event callback |
pusherBGMCompleteHandler |
<live-pusher> event callback |
pusherAudioVolumeNotify |
<live-pusher> event callback |
playerEventHandler |
<live-player> event callback |
playerFullscreenChange |
<live-player> event callback |
playerNetStatus |
<live-player> event callback |
playerAudioVolumeNotify |
<live-player> event callback |
2. Event Overview
| Event | Description |
|---|---|
| ConnectMicEvents.ConnectMicInfoChange | Connection mic information changed |
| ConnectMicEvents.OpenConnectMic | Instructor enables connection mic feature |
| ConnectMicEvents.CloseConnectMic | Instructor disables connection mic feature |
| ConnectMicEvents.ConnectMicStatusChange | Connection mic status updated |
| ConnectMicEvents.ConnectMicDataChange | Connection mic list modified |
| ConnectMicEvents.TeacherHangUp | Instructor hangs up on current connection mic user |
| ConnectMicEvents.ConnectMicOverLimit | Connection mic user limit reached |
| ConnectMicEvents.CurrentSpeakerStatusChanged | Current speaker status changed |
| ConnectMicEvents.AllowConnectMicApply | Instructor approves connection mic application |
| ConnectMicEvents.RemoteAudioMuteChange | Remote connection mic user microphone toggle changed |
| ConnectMicEvents.RemoteVideoMuteChange | Remote connection mic user camera toggle changed |
| ConnectMicEvents.LocalAudioMuteChange | Local microphone toggle changed |
| ConnectMicEvents.LocalVideoMuteChange | Local camera toggle changed |
| ConnectMicEvents.LeaveConnectMicSuccess | Successfully left connection mic |
