#include <LiveRoomCallback.h>

Public Member Functions
virtual void	OnInitSDK (int nError)

virtual void	OnFatalError (int error)

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	OnTokenWillExpired (const char *pszRoomID, int remainTimeInSecond)

virtual void	OnLoginRoomResult (int errorCode, const char pszRoomID, const ZegoStreamInfo pStreamInfo, unsigned int streamCount, int sendSeq)

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

◆ OnDisconnect()

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

pure virtual

与 server 断开通知

Parameters

errorCode	错误码，0 表示无错误
roomID	房间 ID

Attention: 建议开发者在此通知中进行重新登录、推/拉流、报错、友好性提示等其他恢复逻辑

Note

一般客户端网络断开且超过超时重试时间的时候会回调此方法，ZEGO SDK 内部有重试逻辑，一般情况网络不可用时SDK内部会重试300s左右，若超过重试时间，则会通过此方法告知App业务层
当收到此回调时，ZEGO SDK 已经做了重连尝试，业务侧收到此回调时可在UI界面给出友好提示，或者有限次的重连动作
当收到此回调后，表示 SDK 已断开房间信令服务, 将不再有推/拉流状态回调。

◆ OnFatalError()

virtual void ZEGO::LIVEROOM::IRoomCallback::OnFatalError ( int error )

inlinevirtual

发生致命错误的回调，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	直播流个数

◆ OnLoginRoomResult()

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

inlinevirtual

登录房间成功回调

Parameters

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

Attention: 用户不需要关注此回调

◆ 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 的定义

Note

只要发起推流或拉流，就会回调自身的网络质量
以 RTC 或 L3 方式拉流，且对应推流用户和本地用户在同一房间内，会收到对应用户的网络质量
用户在推流才有上行网络质量，拉流才有下行网络质量，否则网络质量为未知。

◆ 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: 由于网络的波动造成连接暂时不可用

◆ OnTokenWillExpired()

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

inlinevirtual

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

Parameters

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

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

LiveRoomCallback.h

Public Member Functions

Constructor & Destructor Documentation

◆ ~IRoomCallback()

Member Function Documentation

◆ OnCustomCommand()

◆ OnDisconnect()

◆ OnFatalError()

◆ OnInitSDK()

◆ OnKickOut()

◆ OnLoginRoom()

◆ OnLoginRoomResult()

◆ OnLogoutRoom()

◆ OnLogUploadResult()

◆ OnLogWillOverwrite()

◆ OnNetworkQuality()

◆ OnReconnect()

◆ OnRecvCustomCommand()

◆ OnRoomInfoUpdated()

◆ OnStreamExtraInfoUpdated()

◆ OnStreamUpdated()

◆ OnTempBroken()

◆ OnTokenWillExpired()