模組事件

一、連麥資訊變更

說明： 連麥資訊透過 connectMic.getConnectMicInfo() 取得，當連麥資訊變更時會觸發該事件。

Event 事件： ConnectMicEvents.ConnectMicInfoChange

回呼參數： Object 物件，詳細型別說明如下

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.ConnectMicInfoChange, () => {
  const connectMicInfo = watchCore.connectMic.getConnectMicInfo();
  console.log('连麦信息更新', connectMicInfo);
});

二、講師開啟連麥功能

說明： 講師開啟連麥功能後，觸發該事件，開啟後頁面即可顯示連麥功能。

Event 事件： ConnectMicEvents.OpenConnectMic

回呼參數： Object 物件，詳細型別說明如下

範例：

import { ConnectMicType } from '@polyv/live-watch-miniprogram-sdk';
watchCore.connectMic.eventEmitter.on(ConnectMicEvents.OpenConnectMic, (data) => {
  const type = data.type === ConnectMicType.Video ? '视频' : '音频';
  toast.info(`讲师开启了${type}连麦，赶快和主播连麦互动吧～`);
});

三、講師關閉連麥功能

說明： 講師關閉連麥功能後觸發該事件

Event 事件： ConnectMicEvents.CloseConnectMic

回呼參數： Object 物件，詳細型別說明如下

範例：

import { ConnectMicType } from '@polyv/live-watch-miniprogram-sdk';
watchCore.connectMic.eventEmitter.on(ConnectMicEvents.CloseConnectMic, (data) => {
  const type = data.type === ConnectMicType.Video ? '视频' : '音频';
  toast.info(`讲师已结束${type}连麦`);
});

四、連麥狀態更新

Event 事件： ConnectMicEvents.ConnectMicStatusChange

回呼參數： Object 物件，詳細型別說明如下

五、連麥列表修改

說明： 當觀眾上下麥或用戶流加入/退出後，連麥列表改變，透過該事件監聽連麥用戶列表更新。

Event 事件： ConnectMicEvents.ConnectMicDataChange

回呼參數： Object 物件，詳細型別說明如下

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.ConnectMicDataChange, () => {
  const connectMicList = watchCore.connectMic.getMicDatas();
  console.log('连麦用户列表更新', connectMicList);
});

六、講師掛斷當前連麥者

說明： 當講師掛斷當前連麥用戶，連麥模組將回呼該事件。

Event 事件： ConnectMicEvents.TeacherHangUp

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.TeacherHangUp, () => {
  toast.info('讲师已挂断你的连麦');
});

七、連麥人數到達上限

說明： 觀眾點擊同意邀請上麥時，可能因連麥人數到達上限而連麥失敗，透過該事件監聽並頁面提示。

Event 事件： ConnectMicEvents.ConnectMicOverLimit

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.ConnectMicOverLimit, () => {
  toast.error('连麦失败，连麦人数已到达上限');
});

八、當前主講狀態改變

說明： 當講師授予/撤銷當前連麥用戶的主講權限時觸發該事件。

Event 事件： ConnectMicEvents.CurrentSpeakerStatusChanged

回呼參數： Object 物件，詳細型別說明如下

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.CurrentSpeakerStatusChanged, (data) => {
  if (data.currentIsSpeaker) {
    toast.info('讲师已授予您主讲权限');
  } else {
    toast.info('讲师已收回您的主讲权限');
  }
});

九、講師同意連麥申請

說明： 觀眾申請連麥，講師同意連麥申請後觸發該事件。

Event 事件： ConnectMicEvents.AllowConnectMicApply

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.AllowConnectMicApply, (data) => {
  toast.success('讲师已同意你的连麦申请');
});

十、遠端連麥用戶麥克風開關改變

Event 事件： ConnectMicEvents.RemoteAudioMuteChange

回呼參數： Object 物件，詳細型別說明如下

十一、遠端連麥用戶攝影機開關改變

Event 事件： ConnectMicEvents.RemoteVideoMuteChange

回呼參數： Object 物件，詳細型別說明如下

十二、本地麥克風開關改變

Event 事件： ConnectMicEvents.LocalAudioMuteChange

回呼參數： Object 物件，詳細型別說明如下

十三、本地攝影機開關改變

Event 事件： ConnectMicEvents.LocalVideoMuteChange

回呼參數： Object 物件，詳細型別說明如下

十四、離開連麥成功

說明： 本地連麥流離開後觸發該事件，觸發後連麥狀態為 ConnectMicStatus.NotConnect。

Event 事件： ConnectMicEvents.LeaveConnectMicSuccess

範例：

watchCore.connectMic.eventEmitter.on(ConnectMicEvents.LeaveConnectMicSuccess, () => {
  toast.success('你已下麦');
  const connectMicInfo = watchCore.connectMic.getConnectMicInfo();
  console.log('连麦状态', connectMicInfo.conncetMicStatus); // ConnectMicStatus.NotConnect
});