IRTCEngineEvent - STMLink 文档

函数说明

事件回调接口，继承此接口并重写回调方法以接收 SDK 事件通知。

继承关系

无

回调方法

加入频道成功回调

virtual void onJoinChannel(const char* channel, int channelSize, const char* me, int meSize, const char* members, int memberSize, const char* opts, int optSize) = 0;

参数

参数	类型	说明
channel	const char*	频道 ID
channelSize	int	频道 ID 字符串长度
me	const char*	自身用户信息 JSON
meSize	int	自身用户信息长度
members	const char*	频道内所有成员信息 JSON 数组
memberSize	int	成员信息数组长度
opts	const char*	系统配置参数
optSize	int	系统配置参数长度

频道状态更新回调

virtual void onChannelUpdate(const char* channelId, const char* props, int propsSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
props	const char*	频道扩展属性 JSON
propsSize	int	扩展属性字符串长度

用户加入回调

virtual void onUserJoin(const char* channelId, const char* user, int userSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	加入用户的详细信息 JSON
userSize	int	用户信息字符串长度

用户信息更新回调

virtual void onUserUpdate(const char* channelId, const char* user, int userSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	更新后的用户信息 JSON
userSize	int	用户信息字符串长度

用户流添加回调

virtual void onUserStreamAdd(const char* channelId, const char* user, const char* stream, int streamSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	用户 ID
stream	const char*	流信息 JSON
streamSize	int	流信息字符串长度

用户流更新回调

virtual void onUserStreamUpdate(const char* channelId, const char* user, const char* stream, int streamSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	用户 ID
stream	const char*	更新后的流信息 JSON
streamSize	int	流信息字符串长度

用户流移除回调

virtual void onUserStreamRemove(const char* channelId, const char* user, const char* stream, int streamSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	用户 ID
stream	const char*	被移除的流信息 JSON
streamSize	int	流信息字符串长度

用户离开回调

virtual void onUserLeave(const char* channelId, const char* user, int userSize) = 0;

参数

参数	类型	说明
channelId	const char*	频道 ID
user	const char*	离开用户的详细信息 JSON
userSize	int	用户信息字符串长度

自定义消息回调

virtual void onCustomMessage2(const char* action, const char* senderid, const char* name, int name_len, const char* message, int messageSize) = 0;

参数

参数	类型	说明
action	const char*	消息类型/动作
senderid	const char*	发送者用户 ID
name	const char*	发送者昵称
name_len	int	昵称长度
message	const char*	消息内容
messageSize	int	消息内容长度

上行挡位变化回调

virtual void onUpLevel(int level) = 0;

参数

参数	类型	说明
level	int	挡位等级（0：好，1：中，2：差，3：极差）

下行挡位变化回调

virtual void onDownLevel(const char* id, int level) = 0;

参数

参数	类型	说明
id	const char*	成员用户 ID
level	int	挡位等级（0：好，1：中，2：差，3：极差）

上行统计回调

virtual void onUpStat(const char* upstat, int upstatsize) = 0;

参数

参数	类型	说明
upstat	const char*	上行统计数据 JSON
upstatsize	int	上行统计数据长度

下行统计回调

virtual void onDownStat(const char* downstat, int downstatsize) = 0;

参数

参数	类型	说明
downstat	const char*	下行统计数据 JSON
downstatsize	int	下行统计数据长度

帧超时回调

virtual void onFrameTimeOut(const char* uid, const char* track_id, const char* track_desc, int loading) = 0;

参数

参数	类型	说明
uid	const char*	用户 ID
track_id	const char*	轨道 ID
track_desc	const char*	轨道描述
loading	int	加载状态

音柱回调

virtual void onSpeakers(const char* Speakers) = 0;

参数

参数	类型	说明
Speakers	const char*	发言者能量数据 JSON 数组

网络探测结果回调

virtual void onProbeResult(int action, const char* result) = 0;

参数

参数	类型	说明
action	int	探测步骤标识
result	const char*	探测结果 JSON

设备变化回调

virtual void onDeviceChange(int type, int action, const char* name, int namesize) = 0;

参数

参数	类型	说明
type	int	设备类型（1：麦克风，2：扬声器，3：摄像头）
action	int	动作（1：插入，2：拔出）
name	const char*	设备名称
namesize	int	设备名称长度

默认设备变化回调

virtual void onDefDeviceChange(int type, const char* name, int namesize) = 0;

参数

参数	类型	说明
type	int	设备类型（1：麦克风，2：扬声器）
name	const char*	新默认设备名称
namesize	int	设备名称长度

设备状态变化回调

virtual void onDeviceStatusChange(int tp, int status) = 0;

参数

参数	类型	说明
tp	int	设备类型（1：麦克风，2：扬声器，3：摄像头）
status	int	状态（1：异常，2：恢复）

共享目标未找到回调

virtual void onShareTargetNotFind() = 0;

断开连接回调

virtual void onDisconnected(int reason, StatusCode code, const char* message, size_t message_size) = 0;

参数

参数	类型	说明
reason	int	断开原因（-1：异常，0：未知，1：主动离开，2：被踢出，3：被顶号，4：心跳超时，5：频道销毁）
code	StatusCode	错误码
message	const char*	错误描述信息
message_size	size_t	错误描述长度

重连成功回调

virtual void onReconnected(const char* channel, const char* options, size_t options_size) = 0;

参数

参数	类型	说明
channel	const char*	频道 ID
options	const char*	重连扩展信息
options_size	size_t	扩展信息长度

正在重连回调

virtual void onReconnecting() = 0;

IM 启用回调

virtual void onImEnabled(const char* uid, const char* sid) = 0;

参数

参数	类型	说明
uid	const char*	用户 ID
sid	const char*	会话 ID

IM 断开连接回调

virtual void onImDisconnected(int reason, StatusCode code, const char* message, size_t message_size) = 0;

参数

参数	类型	说明
reason	int	断开原因
code	StatusCode	错误码
message	const char*	错误描述信息
message_size	size_t	错误描述长度

IM 重连成功回调

virtual void onImReconnected() = 0;

IM 正在重连回调

virtual void onImReconnecting() = 0;

IM 消息回调

virtual void onImMessage2(const char* uid, const char* sid, const char* name, int name_size, const char* action, const char* content, size_t content_size) = 0;

参数

参数	类型	说明
uid	const char*	发送者用户 ID
sid	const char*	会话 ID
name	const char*	发送者昵称
name_size	int	昵称长度
action	const char*	消息类型/动作
content	const char*	消息内容
content_size	size_t	消息内容长度

录制状态变化回调

virtual void onRecordStatusChange(const char* key, LocalRecordStatusEnum status, const char* msg) = 0;

参数

参数	类型	说明
key	const char*	录制任务标识
status	LocalRecordStatusEnum	录制状态枚举
msg	const char*	状态描述信息

​函数说明

​继承关系

​回调方法

​加入频道成功回调

​频道状态更新回调

​用户加入回调

​用户信息更新回调

​用户流添加回调

​用户流更新回调

​用户流移除回调

​用户离开回调

​自定义消息回调

​上行挡位变化回调

​下行挡位变化回调

​上行统计回调

​下行统计回调

​帧超时回调

​音柱回调

​网络探测结果回调

​设备变化回调

​默认设备变化回调

​设备状态变化回调

​共享目标未找到回调

​断开连接回调

​重连成功回调

​正在重连回调

​IM 启用回调

​IM 断开连接回调

​IM 重连成功回调

​IM 正在重连回调

​IM 消息回调

​录制状态变化回调

函数说明

继承关系

回调方法

加入频道成功回调

频道状态更新回调

用户加入回调

用户信息更新回调

用户流添加回调

用户流更新回调

用户流移除回调

用户离开回调

自定义消息回调

上行挡位变化回调

下行挡位变化回调

上行统计回调

下行统计回调

帧超时回调

音柱回调

网络探测结果回调

设备变化回调

默认设备变化回调

设备状态变化回调

共享目标未找到回调

断开连接回调

重连成功回调

正在重连回调

IM 启用回调

IM 断开连接回调

IM 重连成功回调

IM 正在重连回调

IM 消息回调

录制状态变化回调