ZegoAudioRoom
Public Member Functions | List of all members
ZEGO::AUDIOROOM::IAudioRoomCallback Class Referenceabstract

#include <AudioRoomCallback.h>

Public Member Functions

virtual void OnLoginRoom (int errorCode, const char *pszRoomID)=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 OnStreamUpdate (ZegoStreamUpdateType type, const ZegoStreamInfo &pStreamInfo, const char *pszRoomID)=0
 
virtual void OnUserUpdate (const ZegoUserInfo *pUserInfo, unsigned int userCount, ZegoUserUpdateType type)
 
virtual void OnStreamExtraInfoUpdated (ZegoStreamInfo *pStreamInfo, unsigned int streamCount, const char *pszRoomID)=0
 
virtual void OnCustomCommand (int errorCode, int requestSeq, const char *pszRoomID)
 
virtual void OnRecvCustomCommand (const char *pszUserId, const char *pszUserName, const char *pszContent, const char *pszRoomID)
 
virtual void OnTokenWillExpired (const char *pszRoomID, int remainTimeInSecond)
 
virtual ~IAudioRoomCallback ()
 

Constructor & Destructor Documentation

◆ ~IAudioRoomCallback()

virtual ZEGO::AUDIOROOM::IAudioRoomCallback::~IAudioRoomCallback ( )
inlinevirtual

Member Function Documentation

◆ OnCustomCommand()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnCustomCommand ( int  errorCode,
int  requestSeq,
const char *  pszRoomID 
)
inlinevirtual

发送自定义信令结果

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

◆ OnDisconnect()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnDisconnect ( int  errorCode,
const char *  pszRoomID 
)
pure virtual

与 server 断开通知

Parameters
errorCode错误码,0 表示无错误
roomID房间 ID
Attention
建议开发者在此通知中进行重新登录、推/拉流、报错、友好性提示等其他恢复逻辑
Note
与 server 断开连接后,SDK 会进行重试,重试失败抛出此错误。请注意,此时 SDK 与服务器的所有连接均会断开

◆ OnKickout()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnKickout ( int  reason,
const char *  pszRoomID,
const char *  pszCustomReason = "" 
)
pure virtual

因为使用同一个 UserId 登录,用户被挤出聊天室

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

◆ OnLoginRoom()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnLoginRoom ( int  errorCode,
const char *  pszRoomID 
)
pure virtual

登录房间成功回调

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

◆ OnLogoutRoom()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnLogoutRoom ( int  errorCode,
const char *  pszRoomID 
)
inlinevirtual

退出房间回调

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

◆ OnRecvCustomCommand()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnRecvCustomCommand ( const char *  pszUserId,
const char *  pszUserName,
const char *  pszContent,
const char *  pszRoomID 
)
inlinevirtual

收到自定义信令

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

◆ OnStreamExtraInfoUpdated()

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

流附加信息更新

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

◆ OnStreamUpdate()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnStreamUpdate ( ZegoStreamUpdateType  type,
const ZegoStreamInfo pStreamInfo,
const char *  pszRoomID 
)
pure virtual

流信息更新

Parameters
type更新类型
pStreamInfo直播流
pszRoomID房间 ID
Attention
房间内增加流、删除流,均会触发此更新
Note
建议对流增加和流删除分别采取不同的处理

◆ OnTokenWillExpired()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnTokenWillExpired ( const char *  pszRoomID,
int  remainTimeInSecond 
)
inlinevirtual

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

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

◆ OnUserUpdate()

virtual void ZEGO::AUDIOROOM::IAudioRoomCallback::OnUserUpdate ( const ZegoUserInfo pUserInfo,
unsigned int  userCount,
ZegoUserUpdateType  type 
)
inlinevirtual

用户状态更新

Parameters
pUserInfo用户信息
userCount用户数
type更新类型
Note
在登录成功之后,如果房间中有除自己外的其它用户,将会回调一次全量更新数据。之后再退出房间之前都将回调增量数据。
现在可以直接取此回调中的数据使用,SDK内部维护数据列表,外部不需要再维护相关数据

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