设置回调

---

模块说明

Express Electron SDK的回调在多个模块进行管理。模块及其实例获取方式如下：

1. ZegoExpressEngine

   创建 SDK 实例 zegoEngine

   // 创建 SDK 实例 
   const zgEngine = window.require('zego-express-engine-electron/ZegoExpressEngine');

2. ZegoExpressMediaPlayer

   createMediaPlayer --- 创建媒体播放器实例 zgMediaPlayer

   // 创建媒体播放器实例
   const zgMediaPlayer = zgEngine.createMediaPlayer();

3. ZegoExpressAudioEffectPlayer

   createAudioEffectPlayer --- 创建音频效果播放器实例 zgAudioEffectPlayer

   // 创建音频效果播放器实例
   const zgAudioEffectPlayer = zgEngine.createAudioEffectPlayer();

4. ZegoExpressScreenCaptureSource

   createScreenCaptureSource --- 创建屏幕捕获源实例 zgScreenCaptureSource

   // 创建屏幕捕获源实例
   // sourceId  {number}指定的屏幕 ID 或窗口 ID
   // sourceType  {ZegoScreenCaptureSourceType} 指定的 screen 源类型。
   const zgScreenCaptureSource = zgEngine.createScreenCaptureSource(sourceId, sourceType);

注册回调

ZegoExpressEngine

onDebugError

使用示例：

zgEngine.on("onDebugError",({errorCode,funcName,info})=>{
  console.log(`onDebugError: ${errorCode},${funcName},${info}`)
})

onEngineStateUpdate

使用示例：

zgEngine.on("onEngineStateUpdate",({state})=>{
  console.log(`onEngineStateUpdate: ${state}`)
})

onRecvExperimentalAPI

使用示例：

zgEngine.on("onRecvExperimentalAPI",({content})=>{
  console.log(`onRecvExperimentalAPI: ${content}`)
})

onRoomStateUpdate

使用示例：

zgEngine.on("onRoomStateUpdate",({roomID,state,errorCode,extendedData})=>{
  console.log(`onRoomStateUpdate: ${roomID},${state},${errorCode},${extendedData}`)
})

onRoomStateChanged

使用示例：

zgEngine.on("onRoomStateChanged",({roomID,reason,errorCode,extendedData})=>{
  console.log(`onRoomStateChanged: ${roomID},${reason},${errorCode},${extendedData}`)
})

onRoomUserUpdate

使用示例：

zgEngine.on("onRoomUserUpdate",({roomID,updateType,userList})=>{
  console.log(`onRoomUserUpdate: ${roomID},${updateType},${userList}`)
})

onRoomOnlineUserCountUpdate

使用示例：

zgEngine.on("onRoomOnlineUserCountUpdate",({roomID,count})=>{
  console.log(`onRoomOnlineUserCountUpdate: ${roomID},${count}`)
})

onRoomStreamUpdate

使用示例：

zgEngine.on("onRoomStreamUpdate",({roomID,updateType,streamList,extendedData})=>{
  console.log(`onRoomStreamUpdate: ${roomID},${updateType},${streamList},${extendedData}`)
})

onRoomStreamExtraInfoUpdate

使用示例：

zgEngine.on("onRoomStreamExtraInfoUpdate",({roomID,streamList})=>{
  console.log(`onRoomStreamExtraInfoUpdate: ${roomID},${streamList}`)
})

onRoomExtraInfoUpdate

使用示例：

zgEngine.on("onRoomExtraInfoUpdate",({roomID,roomExtraInfoList})=>{
  console.log(`onRoomExtraInfoUpdate: ${roomID},${roomExtraInfoList}`)
})

onRoomTokenWillExpire

使用示例：

zgEngine.on("onRoomTokenWillExpire",({roomID,remainTimeInSecond})=>{
  console.log(`onRoomTokenWillExpire: ${roomID},${remainTimeInSecond}`)
})

onPublisherStateUpdate

使用示例：

zgEngine.on("onPublisherStateUpdate",({streamID,state,errorCode,extendedData})=>{
  console.log(`onPublisherStateUpdate: ${streamID},${state},${errorCode},${extendedData}`)
})

onPublisherQualityUpdate

使用示例：

zgEngine.on("onPublisherQualityUpdate",({streamID,quality})=>{
  console.log(`onPublisherQualityUpdate: ${streamID},${quality}`)
})

onPublisherCapturedAudioFirstFrame

使用示例：

zgEngine.on("onPublisherCapturedAudioFirstFrame",()=>{
  console.log(`onPublisherCapturedAudioFirstFrame: `)
})

onPublisherCapturedVideoFirstFrame

使用示例：

zgEngine.on("onPublisherCapturedVideoFirstFrame",({channel})=>{
  console.log(`onPublisherCapturedVideoFirstFrame: ${channel}`)
})

onPublisherSendAudioFirstFrame

使用示例：

zgEngine.on("onPublisherSendAudioFirstFrame",({channel})=>{
  console.log(`onPublisherSendAudioFirstFrame: ${channel}`)
})

onPublisherSendVideoFirstFrame

使用示例：

zgEngine.on("onPublisherSendVideoFirstFrame",({channel})=>{
  console.log(`onPublisherSendVideoFirstFrame: ${channel}`)
})

onPublisherVideoSizeChanged

使用示例：

zgEngine.on("onPublisherVideoSizeChanged",({width,height,channel})=>{
  console.log(`onPublisherVideoSizeChanged: ${width},${height},${channel}`)
})

onPublisherRelayCDNStateUpdate

使用示例：

zgEngine.on("onPublisherRelayCDNStateUpdate",({streamID,infoList})=>{
  console.log(`onPublisherRelayCDNStateUpdate: ${streamID},${infoList}`)
})

onVideoObjectSegmentationStateChanged

使用示例：

zgEngine.on("onVideoObjectSegmentationStateChanged",({state,channel,errorCode})=>{
  console.log(`onVideoObjectSegmentationStateChanged: ${state},${channel},${errorCode}`)
})

onPlayerStateUpdate

使用示例：

zgEngine.on("onPlayerStateUpdate",({streamID,state,errorCode,extendedData})=>{
  console.log(`onPlayerStateUpdate: ${streamID},${state},${errorCode},${extendedData}`)
})

onPlayerQualityUpdate

使用示例：

zgEngine.on("onPlayerQualityUpdate",({streamID,quality})=>{
  console.log(`onPlayerQualityUpdate: ${streamID},${quality}`)
})

onPlayerMediaEvent

使用示例：

zgEngine.on("onPlayerMediaEvent",({streamID,event})=>{
  console.log(`onPlayerMediaEvent: ${streamID},${event}`)
})

onPlayerRecvAudioFirstFrame

使用示例：

zgEngine.on("onPlayerRecvAudioFirstFrame",({streamID})=>{
  console.log(`onPlayerRecvAudioFirstFrame: ${streamID}`)
})

onPlayerRecvVideoFirstFrame

使用示例：

zgEngine.on("onPlayerRecvVideoFirstFrame",({streamID})=>{
  console.log(`onPlayerRecvVideoFirstFrame: ${streamID}`)
})

onPlayerRenderVideoFirstFrame

使用示例：

zgEngine.on("onPlayerRenderVideoFirstFrame",({streamID})=>{
  console.log(`onPlayerRenderVideoFirstFrame: ${streamID}`)
})

onPlayerVideoSizeChanged

使用示例：

zgEngine.on("onPlayerVideoSizeChanged",({streamID,width,height})=>{
  console.log(`onPlayerVideoSizeChanged: ${streamID},${width},${height}`)
})

onPlayerRecvSEI

使用示例：

zgEngine.on("onPlayerRecvSEI",({streamID,data})=>{
  console.log(`onPlayerRecvSEI: ${streamID},${data}`)
})

onPlayerSyncRecvSEI

使用示例：

zgEngine.on("onPlayerSyncRecvSEI",({streamID,data})=>{
  console.log(`onPlayerSyncRecvSEI: ${streamID},${data}`)
})

onAudioDeviceStateChanged

使用示例：

zgEngine.on("onAudioDeviceStateChanged",({updateType,deviceType,deviceInfo})=>{
  console.log(`onAudioDeviceStateChanged: ${updateType},${deviceType},${deviceInfo}`)
})

onAudioDeviceVolumeChanged

使用示例：

zgEngine.on("onAudioDeviceVolumeChanged",({deviceType,deviceID,volume})=>{
  console.log(`onAudioDeviceVolumeChanged: ${deviceType},${deviceID},${volume}`)
})

onVideoDeviceStateChanged

使用示例：

zgEngine.on("onVideoDeviceStateChanged",({updateType,deviceInfo})=>{
  console.log(`onVideoDeviceStateChanged: ${updateType},${deviceInfo}`)
})

onCapturedSoundLevelUpdate

使用示例：

zgEngine.on("onCapturedSoundLevelUpdate",({soundLevel})=>{
  console.log(`onCapturedSoundLevelUpdate: ${soundLevel}`)
})

onCapturedSoundLevelInfoUpdate

使用示例：

zgEngine.on("onCapturedSoundLevelInfoUpdate",({soundLevelInfo})=>{
  console.log(`onCapturedSoundLevelInfoUpdate: ${soundLevelInfo}`)
})

onRemoteSoundLevelUpdate

使用示例：

zgEngine.on("onRemoteSoundLevelUpdate",({soundLevels})=>{
  console.log(`onRemoteSoundLevelUpdate: ${soundLevels}`)
})

onLocalCaptureVideoData

使用示例：

zgEngine.on("onLocalCaptureVideoData",({videoParam})=>{
  console.log(`onLocalCaptureVideoData: ${videoParam}`)
})

onRemotePlayVideoData

使用示例：

zgEngine.on("onRemotePlayVideoData",({videoParam})=>{
  console.log(`onRemotePlayVideoData: ${videoParam}`)
})

onRemoteSoundLevelInfoUpdate

使用示例：

zgEngine.on("onRemoteSoundLevelInfoUpdate",({soundLevelInfos})=>{
  console.log(`onRemoteSoundLevelInfoUpdate: ${soundLevelInfos}`)
})

onCapturedAudioSpectrumUpdate

使用示例：

zgEngine.on("onCapturedAudioSpectrumUpdate",({audioSpectrum})=>{
  console.log(`onCapturedAudioSpectrumUpdate: ${audioSpectrum}`)
})

onRemoteAudioSpectrumUpdate

使用示例：

zgEngine.on("onRemoteAudioSpectrumUpdate",({audioSpectrums})=>{
  console.log(`onRemoteAudioSpectrumUpdate: ${audioSpectrums}`)
})

onLocalDeviceExceptionOccurred

使用示例：

zgEngine.on("onLocalDeviceExceptionOccurred",({exceptionType,deviceType,deviceID})=>{
  console.log(`onLocalDeviceExceptionOccurred: ${exceptionType},${deviceType},${deviceID}`)
})

onRemoteCameraStateUpdate

使用示例：

zgEngine.on("onRemoteCameraStateUpdate",({streamID,state})=>{
  console.log(`onRemoteCameraStateUpdate: ${streamID},${state}`)
})

onRemoteMicStateUpdate

使用示例：

zgEngine.on("onRemoteMicStateUpdate",({streamID,state})=>{
  console.log(`onRemoteMicStateUpdate: ${streamID},${state}`)
})

onRemoteSpeakerStateUpdate

使用示例：

zgEngine.on("onRemoteSpeakerStateUpdate",({streamID,state})=>{
  console.log(`onRemoteSpeakerStateUpdate: ${streamID},${state}`)
})

onAudioVADStateUpdate

使用示例：

zgEngine.on("onAudioVADStateUpdate",({type,state})=>{
  console.log(`onAudioVADStateUpdate: ${type},${state}`)
})

onIMRecvBroadcastMessage

使用示例：

zgEngine.on("onIMRecvBroadcastMessage",({roomID,messageList})=>{
  console.log(`onIMRecvBroadcastMessage: ${roomID},${messageList}`)
})

onIMRecvBarrageMessage

使用示例：

zgEngine.on("onIMRecvBarrageMessage",({roomID,messageList})=>{
  console.log(`onIMRecvBarrageMessage: ${roomID},${messageList}`)
})

onIMRecvCustomCommand

使用示例：

zgEngine.on("onIMRecvCustomCommand",({roomID,fromUser,command})=>{
  console.log(`onIMRecvCustomCommand: ${roomID},${fromUser},${command}`)
})

onCapturedDataRecordStateUpdate

使用示例：

zgEngine.on("onCapturedDataRecordStateUpdate",({state,errorCode,config,channel})=>{
  console.log(`onCapturedDataRecordStateUpdate: ${state},${errorCode},${config},${channel}`)
})

onCapturedDataRecordProgressUpdate

使用示例：

zgEngine.on("onCapturedDataRecordProgressUpdate",({progress,config,channel})=>{
  console.log(`onCapturedDataRecordProgressUpdate: ${progress},${config},${channel}`)
})

onNetworkModeChanged

使用示例：

zgEngine.on("onNetworkModeChanged",({mode})=>{
  console.log(`onNetworkModeChanged: ${mode}`)
})

onNetworkSpeedTestError

使用示例：

zgEngine.on("onNetworkSpeedTestError",({errorCode,type})=>{
  console.log(`onNetworkSpeedTestError: ${errorCode},${type}`)
})

onNetworkSpeedTestQualityUpdate

使用示例：

zgEngine.on("onNetworkSpeedTestQualityUpdate",({quality,type})=>{
  console.log(`onNetworkSpeedTestQualityUpdate: ${quality},${type}`)
})

onDownloadProgressUpdate

使用示例：

zgEngine.on("onDownloadProgressUpdate",({resourceID,progressRate})=>{
  console.log(`onDownloadProgressUpdate: ${resourceID},${progressRate}`)
})

onCurrentPitchValueUpdate

使用示例：

zgEngine.on("onCurrentPitchValueUpdate",({resourceID,currentDuration,pitchValue})=>{
  console.log(`onCurrentPitchValueUpdate: ${resourceID},${currentDuration},${pitchValue}`)
})

ZegoExpressMediaPlayer

onMediaPlayerStateUpdate

使用示例：

zgMediaPlayer.on("onMediaPlayerStateUpdate",({state,errorCode})=>{
  console.log(`onMediaPlayerStateUpdate: ${state},${errorCode}`)
})

onMediaPlayerNetworkEvent

使用示例：

zgMediaPlayer.on("onMediaPlayerNetworkEvent",({networkEvent})=>{
  console.log(`onMediaPlayerNetworkEvent: ${networkEvent}`)
})

onMediaPlayerPlayingProgress

使用示例：

zgMediaPlayer.on("onMediaPlayerPlayingProgress",({millisecond})=>{
  console.log(`onMediaPlayerPlayingProgress: ${millisecond}`)
})

onMediaPlayerRenderingProgress

使用示例：

zgMediaPlayer.on("onMediaPlayerRenderingProgress",({millisecond})=>{
  console.log(`onMediaPlayerRenderingProgress: ${millisecond}`)
})

onMediaPlayerVideoSizeChanged

使用示例：

zgMediaPlayer.on("onMediaPlayerVideoSizeChanged",({width,height})=>{
  console.log(`onMediaPlayerVideoSizeChanged: ${width},${height}`)
})

onMediaPlayerLoadResource

使用示例：

zgMediaPlayer.on("onMediaPlayerLoadResource",({errorCode,seq})=>{
  console.log(`onMediaPlayerLoadResource: ${errorCode},${seq}`)
})

onMediaPlayerVideoData

使用示例：

zgMediaPlayer.on("onMediaPlayerVideoData",({videoParam})=>{
  console.log(`onMediaPlayerVideoData: ${videoParam}`)
})

onMediaPlayerRecvSEI

使用示例：

zgMediaPlayer.on("onMediaPlayerRecvSEI",({data})=>{
  console.log(`onMediaPlayerRecvSEI: ${data}`)
})

onMediaPlayerSoundLevelUpdate

使用示例：

zgMediaPlayer.on("onMediaPlayerSoundLevelUpdate",({soundLevel})=>{
  console.log(`onMediaPlayerSoundLevelUpdate: ${soundLevel}`)
})

onMediaPlayerFrequencySpectrumUpdate

使用示例：

zgMediaPlayer.on("onMediaPlayerFrequencySpectrumUpdate",({spectrumList})=>{
  console.log(`onMediaPlayerFrequencySpectrumUpdate: ${spectrumList}`)
})

onMediaPlayerFirstFrameEvent

使用示例：

zgMediaPlayer.on("onMediaPlayerFirstFrameEvent",({event})=>{
  console.log(`onMediaPlayerFirstFrameEvent: ${event}`)
})

onMediaPlayerLocalCache

使用示例：

zgMediaPlayer.on("onMediaPlayerLocalCache",({errorCode,resource,cachedFile})=>{
  console.log(`onMediaPlayerLocalCache: ${errorCode},${resource},${cachedFile}`)
})

ZegoExpressAudioEffectPlayer

onAudioEffectPlayStateUpdate

使用示例：

zgAudioEffectPlayer.on("onAudioEffectPlayStateUpdate",({audioEffectID,state,errorCode})=>{
  console.log(`onAudioEffectPlayStateUpdate: ${audioEffectID},${state},${errorCode}`)
})

ZegoExpressScreenCaptureSource

onExceptionOccurred

使用示例：

zgScreenCaptureSource.on("onExceptionOccurred",({exceptionType})=>{
  console.log(`onExceptionOccurred: ${exceptionType}`)
})

onWindowStateChanged

• 使用示例：

  zgScreenCaptureSource.on("onWindowStateChanged",({source,windowState,windowRect})=>{
    console.log(`onWindowStateChanged: ${source},${windowState},${windowRect}`)
  })

• 回调触发时机： 采集目标窗口状态发生改变。

• 参数信息：

onRectChanged

• 使用示例：

  zgScreenCaptureSource.on("onRectChanged",({source,captureRect})=>{
    console.log(`onRectChanged: ${source},${captureRect}`)
  })

• 回调触发时机： 采集区域发生改变。

• 参数信息：

取消回调

取消注册的回调，可以通过 off和 removeAllListeners 方法取消注册的回调。

取消回调示例

以下使用zgEngine的onDebugError事件为例，

使用off方法取消"onDebugError"注册的Listener回调。

const Listener = ({errorCode,funcName,info})=>{
  console.log(`onDebugError: ${errorCode},${funcName},${info}`)
}

zgEngine.on("onDebugError",Listener)

zgEngine.off("onDebugError",Listener)

使用removeAllListeners方法取消"onDebugError"所有注册的回调。

zgEngine.removeAllListeners("onDebugError")