electron-krtc-sdk-callback

KrtcSdkCallback

---

new KrtcSdkCallback()

callback定义，仅参考，未导出接口，需用户自行实现(需回调函数名和参数与文档完全一致)

Methods

---

onAudioControlPlayoutMute(playoutMute, isLocalSet)

用于接收静音事件的回调，终端或者平台控制时都会触发

Parameters:

Name	Type	Description
playoutMute	boolean	true为静音
isLocalSet	boolean	true为终端本地设置，false为远端设置

---

onAudioControlRecordMute(recordMute, isLocalSet)

用于接收哑音事件的回调，终端或者平台控制时都会触发

Parameters:

Name	Type	Description
recordMute	boolean	true为哑音
isLocalSet	boolean	true为终端本地设置，false为远端设置

---

onAudioLevelIndication(userVolumes, speakerNumber)

远端音频能量回调

Parameters:

Name	Type	Description
userVolumes	Array.<Object>	远端用户音频能量
userVolumes[].id	string	远端用户id
userVolumes[].level	number	远端音量等级
speakerNumber	number	userVolumes数组大小

---

onCancelCall(roomId, roomName)

呼叫被取消

Parameters:

Name	Type	Description
roomId	string
roomName	string

---

onConfPasswordReq()

平台要求参会者输入会议密码指令

---

onError(errorType, content)

错误信息回调

Parameters:

Name	Type	Description
errorType	number
content	string

---

onIncomingCall(roomId, roomName)

收到呼叫回调

Parameters:

Name	Type	Description
roomId	string
roomName	string

---

onJoinRoom(result, ExtraInfo)

加入会议回调

Parameters:

Name	Type	Description
result	number
ExtraInfo	string

---

onLeaveRoom(result)

离开会议回调

Parameters:

Name	Type	Description
result	number

---

onLocalAudioStatistics(state)

本地音频流统计信息回调，进入房间且发布后2s触发一次

Parameters:

Name	Type	Description
state	object	网络统计信息 Properties Name Type Description bitrate number 音频码率（bps） lossRate number 丢包率（%）

---

onLocalStatistics(state)

本地网络统计信息回调，进入房间后2s触发一次

Parameters:

Name	Type	Description
state	object	网络统计信息 Properties Name Type Description bytesSent number 累计发送（Byte） bytesReceived number 累计接收（Byte） bitrateSend number 上行总码率（bps） bitrateRecv number 下行总码率（bps） lossRateSend number 上行总丢包率（％） lossRateRecv number 下行总丢包率（％）

---

onLocalVideoStatistics(type, mediaIndex, state)

本地视频流统计信息回调，进入房间且发布后2s触发一次

Parameters:

Name	Type	Description
type	number	码流类型
mediaIndex	number	同类型码流索引
state	object	网络统计信息 Properties Name Type Description width number ///< 视频宽度 height number ///< 视频高度 frameRate number ///< 视频帧率（fps） bitrate number ///< 视频码率（bps） lossRate number ///< 丢包率（%） freezeCount number ///< 视频卡顿帧数 totalFreezesDuration number ///< 视频卡顿时长

---

onLogout(result)

登出KrtcSdk回调

Parameters:

Name	Type	Description
result	number

---

onPausePublishStream(type, mediaIndex, pauseOrResume, result)

暂停、恢复发布回调

Parameters:

Name	Type	Description
type	number	码流类型
mediaIndex	number	码流索引，音频和辅流填0即可
pauseOrResume	boolean	true：暂停 false：恢复
result	number	SDK_NO_ERROR：成功 SDK_PARAMETER_ERROR：参数错误

---

onPauseSubscribeStream(id, type, mediaIndex, pauseOrResume, result)

暂停、恢复订阅回调

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型
mediaIndex	number	码流索引，音频和辅流填0即可
pauseOrResume	boolean	true：暂停 false：恢复
result	number	SDK_NO_ERROR：成功 SDK_SERVER_ERROR：服务器异常 SDK_PARAMETER_ERROR：参数错误

---

onPublishStream(type, mediaIndex, result)

发布流回调

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型
mediaIndex	number	码流索引，音频和辅流填0即可
result	number	SDK_NO_ERROR：成功 SDK_PARAMETER_ERROR：参数错误 SDK_UNKNOWN_ERROR：未知错误

---

onRecommendEncodingParam(type, mediaIndex, layerIndex, param)

设置编码参数

Parameters:

Name	Type	Description
type	number	码流类型
mediaIndex	number	同类型码流索引
layerIndex	number	simulcast分辨率层
param	object	视频编码参数 Properties Name Type Description width number 帧宽 height number 帧高 bitrate number 码率，kbps frameRate number 帧率 keyframeInterval number 关键帧间隔 profilev number H264画质级别

---

onRemoteAudioStatistics(id, type, state)

远端音频流统计信息回调，进入房间后2s触发一次回调

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型（用户音频或混音器音频）
state	object	流信息 Properties Name Type Description bitrate number 音频码率（bps） lossRate number 丢包率（%）

---

onRemoteUserJoinRoom(id, nickName)

远端用户加入房间

Parameters:

Name	Type	Description
id	string	远端用户id
nickName	string	远端用户别名

---

onRemoteUserPublishStream(id, param)

远端用户发布流

Parameters:

Name	Type	Description
id	string	远端用户id
param	object	流信息 Properties Name Type Description stream_type number 码流类型, 0:主流视频; 1: 辅流视频; 2: 音频; 3: 画面合成码流; 4: 混音流 mediaIndex number 发布多条辅流时每个视频源的索引号 layerCount number 分辨率层数 width number 最大分辨率宽度 height number 最大分辨率高度 maxFps number 最大帧率 maxBitrate number 最大码率

---

onRemoteUserUnpublishStream(id, type, mediaIndex)

远端用户取消发布流

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型
mediaIndex	number	同类型码流索引

---

onRemoteVideoStatistics(id, type, mediaIndex, state)

远端视频流统计信息回调，进入房间后2s触发一次回调

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型
mediaIndex	number	同类型码流索引
state	object	网络统计信息 Properties Name Type Description width number ///< 视频宽度 height number ///< 视频高度 frameRate number ///< 视频帧率（fps） bitrate number ///< 视频码率（bps） lossRate number ///< 丢包率（%） freezeCount number ///< 视频卡顿帧数 totalFreezesDuration number ///< 视频卡顿时长

---

onReplyCall(answerOrHanup, roomId, result)

呼叫应答回调

Parameters:

Name	Type	Description
answerOrHanup	boolean
roomId	string
result	number

---

onRequestKeyFrame(id, type, mediaIndex, result)

请求关键帧回调

Parameters:

Name	Type	Description
id	string	远端用户id
type	number	码流类型
mediaIndex	number	码流索引，音频和辅流填0即可
result	number	SDK_NO_ERROR：成功 SDK_PARAMETER_ERROR：参数错误 SDK_UNKNOWN_ERROR：未知错误

---

onSubscribeStream(id, type, mediaIndex, result)

订阅远端用户流回调

Parameters:

Name	Type	Description
id	string	用户id
type	number	码流类型
mediaIndex	number	码流索引
result	number	SDK_NO_ERROR：成功 SDK_NOT_JOIN_ROOM_ERROR：未进入房间 SDK_SERVER_ERROR：服务器异常 SDK_PARAMETER_ERROR：参数错误 SDK_SUBSCRIBESTREAM_SPEAKER_ERROR：扬声器开启失败

---

onUnpublishStream(type, mediaIndex, result)

取消发布流回调

Parameters:

Name	Type	Description
type	number	码流类型
mediaIndex	number	码流索引
result	number	SDK_NO_ERROR：成功 SDK_UNKNOWN_ERROR：未知错误

---

onUnpublishStreamNotify(type, mediaIndex)

取消发布流通知回调

Parameters:

Name	Type	Description
type	number	码流类型
mediaIndex	number	码流索引，音频和辅流填0即可

---

onUnsubscribeStream(uid, type, mediaIndex, result)

取消订阅流回调

Parameters:

Name	Type	Description
uid	string	用户id
type	number	码流类型
mediaIndex	number	码流索引
result	number	SDK_NO_ERROR：成功 SDK_SERVER_ERROR：服务器异常 SDK_PARAMETER_ERROR：参数错误

---

onUpdateStreamLayer(id, type, mediaIndex, layerIndex, result)

设置优先层回调

Parameters:

Name	Type	Description
id	string	用户id
type	number	码流类型
mediaIndex	number	码流索引
layerIndex	number	码流层数
result	number	SDK_NO_ERROR：成功 SDK_SERVER_ERROR：服务器异常 SDK_PARAMETER_ERROR：参数错误 SDK_UNKNOWN_ERROR：未知错误

---

onWarning(warningType, content)

告警信息回调

Parameters:

Name	Type	Description
warningType	number
content	string