IRtkServiceEventHandler

最近更新时间:2023-02-21 10:39:53

Public 成员函数
virtual~IRtkServiceEventHandler ()
virtual voidonLoginSuccess ()
virtual voidonLoginFailure (LOGIN_ERR_CODE errorCode)
virtual voidonRenewTokenResult (const char *token, RENEW_TOKEN_ERR_CODE errorCode)
virtual voidonTokenWillExpire ()
virtual voidonTokenExpired ()
virtual voidonLogout (LOGOUT_ERR_CODE errorCode)
virtual voidonConnectionStateChanged (CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)
virtual voidonNetworkStatus (int upStatus, int downStatus)
virtual voidonTalkLocalMicAudioData (const charchanId, const charpData, int nSamples, int nSampleHz, int nChannel)
virtual voidonTalkLocalSpeakerAudioData (const charchanId, const charpData, int nSamples, int nSampleHz, int nChannel)
virtual voidonTalkRecordFile (const charchanId, const charstrFilePath)

构造及析构函数说明

~IRtkServiceEventHandler

virtual ~IRtkServiceEventHandler()

成员函数说明

onConnectionStateChanged

virtual void onConnectionStateChanged(CONNECTION_STATE state, CONNECTION_CHANGE_REASON reason)

SDK 与 anyRTC RTK 系统的连接状态发生改变回调。

参数

参数说明
state新连接状态。详见 CONNECTION_STATE
reason连接状态改变原因。详见 CONNECTION_CHANGE_REASON

onLoginFailure

virtual void onLoginFailure(LOGIN_ERR_CODE errorCode)

登录 anyRTC RTK 系统失败回调。

login 方法调用失败时,本地用户会收到此回调。 错误码详见 LOGIN_ERR_CODE

onLoginSuccess

virtual void onLoginSuccess()

登录 anyRTC RTK 系统成功回调。

当用户调用 login 方法成功加入频道时,本地用户会收到此回调。

onLogout

virtual void onLogout(LOGOUT_ERR_CODE errorCode)

登出 anyRTC RTK 服务回调。

当 SDK 调用 logout 方法时,本地用户会收到此回调。 有关状态,详见 LOGOUT_ERR_CODE

onRenewTokenResult

virtual void onRenewTokenResult(const char* token, RENEW_TOKEN_ERR_CODE errorCode)

报告 renewToken 方法的调用结果

参数

参数说明
token新的 Token
errorCode错误码。详见 RENEW_TOKEN_ERR_CODE

onTokenWillExpired

virtual void onTokenWillExpired()

在使用RTK过程中如果 Token 即将失效,SDK 会提前 30 秒触发该回调,提醒 app 更新 Token

收到该回调时,请尽快在你的业务服务端生成新的 Token,然后调用login重新登录。

onTokenExpired

virtual void onTokenExpired()

(SDK 断线重连时触发)当前使用的 RTK Token 已超过 24 小时的签发有效期

  • SDK 触发该回调提醒 App 当前 Token 即将过期,应即时获取新 Token。收到该回调后,你需要在服务端生成新 Token 并调用 renewToken 方法将该 Token 传给 SDK。
  • 如果调用 login 方法登录时传入的 Token 直至过期仍未更新,SDK 会断开连接,用户将下线。

onNetworkStatus

virtual void onNetworkStatus(int upStatus, int downStatus)

当前网络的上下行网络状态

参数

参数说明
upStatus上行网络状态
downStatus下行网络状态

onTalkLocalMicAudioData

virtual void onTalkLocalMicAudioData(const charchanId, const charpData, int nSamples, int nSampleHz, int nChannel)

本地录音音频数据回调

参数

参数说明
chanId频道ID
pData音频数据
nSamples音频数据采样点数
nSampleHz音频数据采样率
nChannel音频声道

onTalkLocalSpeakerAudioData

virtual void onTalkLocalSpeakerAudioData(const charchanId, const charpData, int nSamples, int nSampleHz, int nChannel)

本地播放其他人音频数据回调

参数

参数说明
chanId频道ID
pData音频数据
nSamples音频数据采样点数
nSampleHz音频数据采样率
nChannel音频声道

onTalkRecordFile

virtual void onTalkRecordFile(const charchanId, const charstrFilePath)

本地录音回调

参数

参数说明
chanId频道ID
strFilePath录音文件