ZegoLiveRoom
Public Member Functions | List of all members
ZEGO::LIVEROOM::IRoomCallback Class Referenceabstract

#include <LiveRoomCallback.h>

Public Member Functions

virtual void OnInitSDK (int nError)
 
virtual void OnLogWillOverwrite ()
 
virtual void OnLogUploadResult (int errorCode)
 
virtual void OnLoginRoom (int errorCode, const char *pszRoomID, const ZegoStreamInfo *pStreamInfo, unsigned int streamCount)=0
 
virtual void OnLogoutRoom (int errorCode, const char *pszRoomID)
 
virtual void OnKickOut (int reason, const char *pszRoomID, const char *pszCustomReason="")=0
 
virtual void OnDisconnect (int errorCode, const char *pszRoomID)=0
 
virtual void OnReconnect (int errorCode, const char *pszRoomID)
 
virtual void OnTempBroken (int errorCode, const char *pszRoomID)
 
virtual void OnStreamUpdated (ZegoStreamUpdateType type, ZegoStreamInfo *pStreamInfo, unsigned int streamCount, const char *pszRoomID)=0
 
virtual void OnStreamExtraInfoUpdated (ZegoStreamInfo *pStreamInfo, unsigned int streamCount, const char *pszRoomID)=0
 
virtual void OnCustomCommand (int errorCode, int requestSeq, const char *pszRoomID)=0
 
virtual void OnRecvCustomCommand (const char *pszUserId, const char *pszUserName, const char *pszContent, const char *pszRoomID)=0
 
virtual void OnRoomInfoUpdated (const ZegoRoomInfo &info, const char *pszRoomID)
 
virtual void OnNetworkQuality (const char *pszUserId, int txQuality, int rxQuality)
 
virtual void OnCustomTokenWillExpired (const char *pszRoomID, int remainTimeInSecond)
 
virtual ~IRoomCallback ()
 

Constructor & Destructor Documentation

◆ ~IRoomCallback()

virtual ZEGO::LIVEROOM::IRoomCallback::~IRoomCallback ( )
inlinevirtual

Member Function Documentation

◆ OnCustomCommand()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnCustomCommand ( int  errorCode,
int  requestSeq,
const char *  pszRoomID 
)
pure virtual

发送自定义信令结果

Parameters
errorCode错误码,0 表示无错误
requestSeq请求 seq
pszRoomID房间 ID

◆ OnCustomTokenWillExpired()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnCustomTokenWillExpired ( const char *  pszRoomID,
int  remainTimeInSecond 
)
inlinevirtual

设置的token即将过期回调,登录成功后在设置的token剩余时间小于等于30秒时会收到此回调

Parameters
pszRoomID房间 ID
remainTimeInSecond剩余时间 单位为秒

◆ OnDisconnect()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnDisconnect ( int  errorCode,
const char *  pszRoomID 
)
pure virtual

与 server 断开通知

Parameters
errorCode错误码,0 表示无错误
roomID房间 ID
Attention
建议开发者在此通知中进行重新登录、推/拉流、报错、友好性提示等其他恢复逻辑
Note
  1. 一般客户端网络断开且超过超时重试时间的时候会回调此方法,ZEGO SDK 内部有重试逻辑,一般情况网络不可用时SDK内部会重试300s左右,若超过重试时间,则会通过此方法告知App业务层
  2. 当收到此回调时,ZEGO SDK 已经做了重连尝试,业务侧收到此回调时可在UI界面给出友好提示,或者有限次的重连动作
  3. 当收到此回调后,表示 SDK 已断开房间信令服务, 将不再有推/拉流状态回调。

◆ OnInitSDK()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnInitSDK ( int  nError)
inlinevirtual

InitSDK成功回调

Parameters
errorCode错误码,0 表示无错误

◆ OnKickOut()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnKickOut ( int  reason,
const char *  pszRoomID,
const char *  pszCustomReason = "" 
)
pure virtual

用户被踢出房间

Parameters
reason原因
pszRoomID房间 ID
Attention
可在该回调中处理用户被踢出房间后的下一步处理(例如报错、重新登录提示等)

◆ OnLoginRoom()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnLoginRoom ( int  errorCode,
const char *  pszRoomID,
const ZegoStreamInfo pStreamInfo,
unsigned int  streamCount 
)
pure virtual

登录房间成功回调

Parameters
errorCode错误码,0 表示无错误
pszRoomID房间 ID
pStreamInfo直播流列表
streamCount直播流个数

◆ OnLogoutRoom()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnLogoutRoom ( int  errorCode,
const char *  pszRoomID 
)
inlinevirtual

退出房间回调

Parameters
errorCode错误码,0 表示无错误
pszRoomID房间 ID

◆ OnLogUploadResult()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnLogUploadResult ( int  errorCode)
inlinevirtual

上传日志结果回调

Parameters
errorCode错误码

◆ OnLogWillOverwrite()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnLogWillOverwrite ( )
inlinevirtual

日志将要写满

◆ OnNetworkQuality()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnNetworkQuality ( const char *  pszUserId,
int  txQuality,
int  rxQuality 
)
inlinevirtual

房间内正在连麦的用户的网络质量回调

Parameters
pszUserId用户ID,nullptr表示本地用户
txQuality上行网络质量 参考 zego-api-defines.h 中 LiveStreamQuality 的定义
rxQuality下行网络质量 参考 zego-api-defines.h 中 LiveStreamQuality 的定义

◆ OnReconnect()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnReconnect ( int  errorCode,
const char *  pszRoomID 
)
inlinevirtual

与 server 重连成功通知

Parameters
errorCode错误码,0 表示无错误
pszRoomID房间 ID
Attention
可在该回调中处理自动重连成功的下一步处理(例如提示重连成功,恢复正常连接的页面布局等)
Note
非主动与 server 断开连接后,SDK 会进行重试,重试成功回调该方法。

◆ OnRecvCustomCommand()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnRecvCustomCommand ( const char *  pszUserId,
const char *  pszUserName,
const char *  pszContent,
const char *  pszRoomID 
)
pure virtual

收到自定义信令

Parameters
pszUserId发送者 UserId
pszUserName发送者 UserName
pszContent收到的信令内容
pszRoomID房间 ID

◆ OnRoomInfoUpdated()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnRoomInfoUpdated ( const ZegoRoomInfo info,
const char *  pszRoomID 
)
inlinevirtual

房间信息更新,登录成功,或者重连成功后,房间信息变化会收到此回调

Parameters
info参见ZegoRoomInfo
pszRoomID房间 ID

◆ OnStreamExtraInfoUpdated()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnStreamExtraInfoUpdated ( ZegoStreamInfo pStreamInfo,
unsigned int  streamCount,
const char *  pszRoomID 
)
pure virtual

流附加信息更新

Parameters
pStreamInfo附加信息更新的流列表
streamCount流个数
pszRoomID房间 ID

◆ OnStreamUpdated()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnStreamUpdated ( ZegoStreamUpdateType  type,
ZegoStreamInfo pStreamInfo,
unsigned int  streamCount,
const char *  pszRoomID 
)
pure virtual

流信息更新

Parameters
type更新类型
pStreamInfo直播流列表
streamCount直播流个数
pszRoomID房间 ID
Attention
房间内增加流、删除流,均会触发此更新。主播推流,自己不会收到此回调,房间内其他成员会收到。建议对流增加和流删除分别采取不同的处理

◆ OnTempBroken()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnTempBroken ( int  errorCode,
const char *  pszRoomID 
)
inlinevirtual

与 server 的连接被动断开通知

Parameters
errorCode错误码,0 表示无错误
pszRoomID房间 ID
Note
由于网络的波动造成连接暂时不可用

The documentation for this class was generated from the following file: