通过阅读本文,您可以了解Electron SDK回调及监听的接口详情。
目录
详情
- onJoinChannelResult:加入频道结果的回调。
on(event: "onJoinChannelResult", listener: (result: number, channel: string, elapsed: number) => {}): void;
参数 类型 描述 result number 加入频道结果,成功返回0,失败返回错误码。 channel string 频道ID。 elapsed number 加入频道耗时,单位:毫秒。 - onLeaveChannelResult:离开频道结果的回调。
on(event: "onLeaveChannelResult", listener: (result: number) => {}): void;
参数 类型 描述 result number 成功返回0,失败返回错误码信息。 - onRemoteUserOnLineNotify:远端用户上线的回调。
on(event: "onRemoteUserOnLineNotify", listener: (uid: string, elapsed: number) => {}): void;
参数 类型 描述 uid string 远端用户ID。 elapsed number 用户加入频道时的耗时,单位:毫秒。 - onRemoteUserOffLineNotify:远端用户下线的回调。
on(event: "OnRemoteUserOffLineNotify", listener: (uid: string, reason: AliEngineUserOfflineReason) => {}): void;
参数 类型 描述 uid string 远端用户ID。 reason AliEngineUserOfflineReason 用户离线的原因。 - onAudioPublishStateChanged:音频推流变更的回调。
on(event: "onAudioPublishStateChanged", listener: (oldState: AliEnginePublishState, newState: AliEnginePublishState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 oldState AliEnginePublishState 上一次推流状态。 newState AliEnginePublishState 当前的推流状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onVideoPublishStateChanged:视频推流变更的回调。
on(event: "onVideoPublishStateChanged", listener: (oldState: AliEnginePublishState, newState: AliEnginePublishState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 oldState AliEnginePublishState 上一次推流状态。 newState AliEnginePublishState 当前的推流状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onDualStreamPublishStateChanged:次要流推流变更的回调。
on(event: "onDualStreamPublishStateChanged", listener: (oldState: AliEnginePublishState, newState: AliEnginePublishState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 oldState AliEnginePublishState 上一次推流状态。 newState AliEnginePublishState 当前的推流状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onScreenSharePublishStateChangedWithInfo:屏幕分享推流变更的回调。
on(event: "onRemoteUserOnLineNotify", listener: (oldState: AliEnginePublishState, newState: AliEnginePublishState, elapseSinceLastState: number, channel: string, screenShareInfo: AliEngineScreenShareInfo) => {}): void;
名称 类型 描述 oldState AliEnginePublishState 上一次推流状态。 newState AliEnginePublishState 当前的推流状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 screenShareInfo AliEngineScreenShareInfo 本次屏幕共享推流信息。 - onRemoteTrackAvailableNotify:远端用户音视频流发生变化时的回调。
on(event: "onRemoteTrackAvailableNotify", listener: (uid: string, audioTrack: AliEngineAudioTrack, videoTrack: AliEngineVideoTrack) => {}): void;
名称 类型 描述 uid string 远端用户ID。 audioTrack AliEngineAudioTrack 远端用户发生变化后的音频流。 videoTrack AliEngineVideoTrack 远端用户发生变化后的视频流。 - onAudioSubscribeStateChanged:音频订阅情况变更的回调。
on(event: "onAudioSubscribeStateChanged", listener: (uid: string, oldState: AliEngineSubscribeState, newState: AliEngineSubscribeState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 uid string 远端用户ID。 oldState AliEngineSubscribeState 上一次订阅状态。 newState AliEngineSubscribeState 当前的订阅状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onVideoSubscribeStateChanged:相机流订阅情况变更的回调。
on(event: "onVideoSubscribeStateChanged", listener: (uid: string, oldState: AliEngineSubscribeState, newState: AliEngineSubscribeState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 uid string 远端用户ID。 oldState AliEngineSubscribeState 上一次订阅状态。 newState AliEngineSubscribeState 当前的订阅状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onScreenShareSubscribeStateChanged:屏幕分享流订阅情况变更的回调。
on(event: "onScreenShareSubscribeStateChanged", listener: (uid: string, oldState: AliEngineSubscribeState, newState: AliEngineSubscribeState, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 uid string 远端用户ID。 oldState AliEngineSubscribeState 上一次订阅状态。 newState AliEngineSubscribeState 当前的订阅状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onSubscribeStreamTypeChanged:大小流订阅情况变更的回调。
on(event: "onSubscribeStreamTypeChanged", listener: (uid: string, oldState: AliEngineVideoStreamType, newState: AliEngineVideoStreamType, elapseSinceLastState: number, channel: string) => {}): void;
名称 类型 描述 uid string 远端用户ID。 oldStreamType AliEngineVideoStreamType 上一次订阅状态。 newStreamType AliEngineVideoStreamType 当前的订阅状态。 elapseSinceLastState number 状态变更时间间隔,单位:毫秒。 channel string 当前频道ID。 - onOccurWarning:警告回调。
on(event: "onOccurWarning", listener: (warn: number, msg: string) => {}): void;
参数 类型 描述 warn number 警告类型。 msg string 警告说明。 - onOccurError:错误回调。
on(event: "onOccurError", listener: (error: number, msg: string) => {}): void;
参数 类型 描述 error number 错误类型。 说明 当参数error为16908812或33620229时,您需要先释放实例,重新创建SDK实例,再调用joinChannel加入频道。msg string 错误说明。 - onBye:被服务器踢出或者频道关闭时的回调。
on(event: "onBye", listener: (code: AliEngineOnByeType) => {}): void;
参数 类型 描述 code AliEngineOnByeType OnBye类型。 - onAudioDeviceStateChanged:音频设备状态变更的回调。
on(event: "onAudioDeviceStateChanged", listener: (deviceInfo: AliEngineDeviceInfo, deviceType: AliEngineExternalDeviceType, deviceState: AliEngineExternalDeviceState) => {}): void;
参数 类型 描述 deviceInfo AliEngineDeviceInfo 外接设备信息。 deviceType AliEngineExternalDeviceType 外接设备类型。 deviceState AliEngineExternalDeviceState 外接设备状态。 - onVideoDeviceStateChanged:视频设备状态变更的回调。
on(event: "onVideoDeviceStateChanged", listener: (deviceInfo: AliEngineDeviceInfo, deviceType: AliEngineExternalDeviceType, deviceState: AliEngineExternalDeviceState) => {}): void;
参数 类型 描述 deviceInfo AliEngineDeviceInfo 外接设备信息。 deviceType AliEngineExternalDeviceType 外接设备类型。 deviceState AliEngineExternalDeviceState 外接设备状态。 - onNetworkQualityChanged:网络质量变化时的回调。
on(event: "onNetworkQualityChanged", listener: (uid: string, upQuality: AliEngineNetworkQuality, downQuality: AliEngineNetworkQuality) => {}): void;
参数 类型 描述 uid string 网络质量发生变化的用户ID,用户ID为空表示本地,其他表示远端。 upQuality AliEngineNetworkQuality 上行网络质量。 downQuality AliEngineNetworkQuality 下行网络质量。 - onUserAudioMuted:对端用户停止音频数据发送的通知。
on(event: "onUserAudioMuted", listener: (uid: string, isMute: boolean) => {}): void;
名称 类型 描述 uid string 执行muteLocalMic的用户。 isMute boolean 是否静音。取值: - true:静音。
- false:未静音。
- onUserVideoMuted:对端用户发送视频黑帧数据发送的通知。
on(event: "onUserVideoMuted", listener: (uid: string, isMute: boolean) => {}): void;
名称 类型 描述 uid string 执行enableLocalVideo的用户。 isMute boolean 是否打开相机流采集。取值: - true:打开相机流采集。
- false:关闭相机流采集。
- onUpdateRoleNotify:用户角色发生改变时的回调。
on(event: "onUpdateRoleNotify", listener: (oldRole: AliEngineClientRole, newRole: AliEngineClientRole) => {}): void;
参数 类型 描述 oldRole AliEngineClientRole 切换前的角色。 newRole AliEngineClientRole 切换后的角色。 - onAudioPlayingStateChanged:伴奏播放的回调。
on(event: "onAudioPlayingStateChanged", listener: (type: AliEngineAudioPlayingType, errorCode: AliEngineAudioPlayingErrorCode) => {}): void;
名称 类型 描述 type AliEngineAudioPlayingType 当前播放状态。 errorCode AliEngineAudioPlayingErrorCode 错误码。 - onLastmileDetectResultWithQuality:网络质量探测的回调。
on(event: "onLastmileDetectResultWithQuality", listener: (networkQuality: AliEngineNetworkQuality) => {}): void;
参数 类型 描述 networkQuality AliEngineNetworkQuality 网络质量。 - onAudioDeviceRecordLevel:音频采集设备测试的回调。
on(event: "onAudioDeviceRecordLevel", listener: (level: number) => {}): void;
参数 类型 描述 level number 音频采集设备音量值。 - onAudioDevicePlayoutLevel:音频播放设备测试回调。
on(event: "onAudioDevicePlayoutLevel", listener: (level: number) => {}): void;
参数 类型 描述 level number 音频播放设备音量值。 - onAudioDevicePlayoutEnd:音频播放设备测试结束(音频文件播放完毕)时的回调。
on(event: "onAudioDevicePlayoutEnd", listener: () => {}): void;
- onStats:当前会话统计信息回调(2s触发一次)。
on(event: "onStats", listener: (stats: AliEngineStats) => {}): void;
参数 类型 描述 stats AliEngineStats 会话统计信息。 - onLocalVideoStats:本地视频统计信息回调(2s触发一次)。
on(event: "onLocalVideoStats", listener: (localVideoStats: AliEngineLocalVideoStats) => {}): void;
参数 类型 描述 localVideoStats AliEngineLocalVideoStats 本地视频统计信息。 - onRemoteVideoStats:远端视频统计信息回调(2s触发一次)。
on(event: "onRemoteVideoStats", listener: (remoteVideoStats: AliEngineRemoteVideoStats) => {}): void;
参数 类型 描述 remoteVideoStats AliEngineRemoteVideoStats 远端视频统计信息。 - onLocalAudioStats:本地音频统计信息回调(2s触发一次)。
on(event: "onLocalAudioStats", listener: (localAudioStats: AliEngineLocalAudioStats) => {}): void;
参数 类型 描述 localAudioStats AliEngineLocalAudioStats 本地音频统计信息。 - onRemoteAudioStats:远端音频统计信息回调(2s触发一次)。
on(event: "onRemoteAudioStats", listener: (remoteAudioStats: AliEngineRemoteAudioStats) => {}): void;
参数 类型 描述 remoteAudioStats AliEngineRemoteAudioStats 远端音频统计信息。 - onMediaRecordEvent:录制事件回调。
on(event: "onMediaRecordEvent", listener: (event: number, filePath: string) => {}): void;
参数 类型 说明 event number 录制事件。取值: - 0:录制开始。
- 1:录制结束。
- 2:打开文件失败。
- 3:写文件失败。
filePath string 录制文件路径。 - onAudioVolumeCallback:用户音量大小的回调。
on(event: "onAudioVolumeCallback", listener: (volumeInfo: AliEngineUserVolumeInfo) => {}): void;
参数 类型 描述 volumeInfo AliEngineUserVolumeInfo 说话人结构体信息。 说明 AliEngineUserVolumeInfo中uid为0表示本地推流音量,1表示远端混音音量,其他表示用户的音量。 - onActiveSpeaker:订阅的当前说话人。
on(event: "onActiveSpeaker", listener: (uid: string) => {}): void;
名称 类型 描述 uid string 用户ID。