保利威文档中心

幫助中心

模組事件

更新時間:2026-01-19 09:16:42

一、頻道安裝失敗

說明: 安裝 channel 模組失敗時會觸發該事件

Event 事件: ChannelEvents.ChannelSetupFail

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
failReason 頻道安裝失敗原因 ChannelSetupFailReason
failMessage 頻道安裝失敗資訊 string

二、直播狀態改變事件

說明: 當主講開始/結束直播後,頻道的直播狀態都會改變,透過該事件監聽直播狀態改變

Event 事件: ChannelEvents.LiveStatusChange

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
liveStatus 新的直播狀態 LiveStatus
newLiveStatus 新的直播狀態 LiveStatus
oldLiveStatus 舊的直播狀態 LiveStatus

範例:

watchCore.channel.eventEmitter.on(ChannelEvents.LiveStatusChange, (data) => {
  console.log('频道状态改变,新状态:', data.liveStatus);
});

三、場次號改變事件

說明: 主講開新的一次直播後,都會生成一個新的直播場次號,可以透過頻道模組的該事件監聽直播場次號改變。

Event 事件: ChannelEvents.SessionIdChange

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
sessionId 新的場次號 string

範例:

watchCore.channel.eventEmitter.on(ChannelEvents.LiveStatusChange, (data) => {
  console.log('频道状态改变,新状态:', data.liveStatus);
});

四、研討會主持加入分組討論事件

Event 事件: ChannelEvents.SeminarHostJoinInGroup

五、研討會主持離開分組討論事件

Event 事件: ChannelEvents.SeminarHostLeaveGroup

六、觀眾累計觀看時長

Event 事件: ChannelEvents.ViewerWatchDuration

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
duration 累計觀看時長,單位秒 number

範例:

watchCore.channel.eventEmitter.on(ChannelEvents.ViewerWatchDuration, (data) => {
  console.log('观众累计观看时长', data.duration);
});

七、轉播雙師房間切換

Event 事件: ChannelEvents.TransmitDoubleRoomChange

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
to 切換到哪個類型的房間: main(主房間),child(子房間) 'main' | 'child'
roomId 房間 Id string

八、關聯轉播狀態變更

Event 事件: ChannelEvents.TransmitChannelSwitch

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
enabled 開關 boolean

九、管理員公告跑馬燈

Event 事件: ChannelEvents.ManagerBulletinMarquee

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
enabled 開關 boolean

十、測試模式變更

Event 事件: ChannelEvents.TestModeChange

回調參數: Object 物件,詳細類型說明如下

屬性名 說明 類型
inTestMode 當前是否處於測試模式 boolean

十一、授權過期

Event 事件: ChannelEvents.AuthExpired

联系客服,在线咨询