回调接口

on_roomjoined

简要描述

成功进入房间的回调 调用joinroom 或者 joinRoomEx 接口进入房间，成功后会回调此函数. 房间内存在其他用户，这些用户会收到void on_roomuserjoined(struct roomclient *, const char* peerid, bool inList)的回调失败则会以void on_roomerror(struct roomclient *, int err, const char* errmsg)回调。
接口详情

void(*on_roomjoined)(struct roomclient *);

on_roomleaved

简要描述

离开房间的回调。调用 leaveroom 接口离开房间会触发此回调。 如果房间内存在其他的用户，这些用户会收到void on_roomuserleft的回调
接口详情

void(*on_roomleaved)(struct roomclient *);

on_roomerror

简要描述

joinroom，发布，订阅，取消发布，取消订阅的回调中的错误
接口详情

void(*on_roomerror)(struct roomclient *, int err, const char* errmsg);

参数	说明
err	错误码（详情请见TK_ERROR_C）
errmsg	错误信息

on_warning

简要描述

SDK出现警告的回调
接口详情

void (*on_warning)(struct roomclient*, int warningCode);

参数	说明
warningCode	警告码（详情请见TK_WARNING_C）

on_roomuserjoined

简要描述

有用户进入房间
接口详情

void(*on_roomuserjoined)(struct roomclient *, const char* peerid, bool inList);

参数	说明
peerid	用户ID
inList	YES：表示该用户是在我之前进入房间，NO：表示该用户是在我之后进入房间

on_roomuserleft

简要描述

有用户离开房间时回调
接口详情

void(*on_roomuserleft)(struct roomclient *, const char* peerid);

参数	说明
peer	用户ID

on_roomkickedout

简要描述

我自己被踢出房间时回调
接口详情

void(*on_roomkickedout)(struct roomclient *,TK_KICKOUT_REASON_C reason);

参数	说明
reason（TK_KICKOUT_REASON_C）	被踢原因

on_roomuserchanged

简要描述

用户的属性发生变化时回调
接口详情

void(*on_roomuserchanged)(struct roomclient *, const char* peerid);

参数	说明
peerId(std::string)	用户ID

on_roomuservideostatus

简要描述

用户视频状态变化时回调（发布和停止发布） 单摄模式：用户视频状态变化时回调多摄模式：用户某一视频设备的视频状态变化回调
接口详情

（单个设备时有效） void (on_roomuservideostatus)( struct roomclient * , const char peerId , TK_MEDIA_STATUS_C state); （多个设备时有效） void (on_roomuservideostatuswithid)( struct roomclient * , const char peerId , const char* deviceId , TK_MEDIA_STATUS_C state);`

参数	说明
peerId(std::string)	用户ID
mediatype	媒体类型
state（TK_MEDIA_STATUS_C）	视频发布状态
deviceId	设备id

onUserAudioStatus

简要描述

用户音频状态变化时回调
接口详情

void (on_roomuseraudiostatus)( struct roomclient * , const char peerId , TK_MEDIA_STATUS_C state);

参数	说明
peerId(std::string)	用户ID
mediatype	媒体类型
state（TK_MEDIA_STATUS_C）	音频状态

on_roomremotepubmsg

简要描述

当某用户发送了发布信令消息 pubmsg/pubmsg_number/pubmsg_string/pubmsg_json，若我是该信令的接受对象时，即可收到用户发布的自定义信令的回调
接口详情

void(on_roomremotepubmsg)( struct roomclient * , const char msgid , const char name , long ts , const char fromId , const char* toid);

参数	说明
msgid	消息id
msgname	消息名
fromId	消息来源用户id
toId	消息接收者
ts	消息时间戳

on_roomremotedelmsg

简要描述

当某用户发送了删除信令消息 delMsg，若我是该信令的接受对象时，即可收到用户发送的自定义信令的回调
接口详情

void(on_roomremotedelmsg)( struct roomclient * , const char msgid , const char name , long ts , const char fromId , const char* toid);

参数	说明
msgid	消息id
msgname	消息名
fromId	消息来源用户id
toid	消息接收者
ts	消息时间戳

on_roommessagereceived

简要描述

当某用户调用sendmessage 或 sendmessage_json发送消息，若我是该消息的接受对象时，即可收到用户发送的消息
接口详情

void(on_roommessagereceived)( struct roomclient * , tkstring message , const char fromId);

参数	说明
fromId	来自谁的消息
message	接收到的消息

on_roomvideostatsreport

简要描述

自己订阅其他用户视频时的数据统计的回调，1秒/次
接口详情

void(on_roomvideostatsreport)( struct roomclient client , const char peerId , const VideoStats_C& stats , const char type);

参数	说明
peerId	用户ID，表示视频数据是该用户的
state（VideoStats_C）	通讯状态信息
type	媒体类型 (可以是媒体文件，屏幕，默认是空值)

on_roomaudiostatsreport

简要描述

自己订阅其他用户音频时的数据统计的回调，1秒/次
接口详情

void (on_roomaudiostatsreport)( struct roomclient client , const char* peerId , const AudioStats_C& stats , TK_MEDIATYPE_C mediaType);

参数	说明
state (AudioStats_C)	通讯状态信息
peerId	用户ID，表示音频数据是该用户的
mediaType（TK_MEDIATYPE_C）	媒体类型

on_roommicvolumereport

简要描述

本地麦克风音量统计的回调
接口详情

void (*on_roommicvolumereport)(struct roomclient* client, int vol);

参数	说明
vol	麦克风音量

on_roomremoteaudiovolume

简要描述

远程控制音量的回调
接口详情

void (*on_roomremoteaudiovolume)(struct roomclient* client, const char* peerId, int vol);

参数	说明
peerId	用户ID
vol	麦克风音量

on_roomaudioroomswitch

简要描述

房间模式发送变化的回调，纯音频与音视频房间切换 房间内所有的用户的视频都会消失
接口详情

void (*on_roomaudioroomswitch)(struct roomclient* client, const char* from, bool onlyAudio);

参数	说明
from	切换房间模式的用户ID，即信令发送者ID
onlyAudio	true：表示纯音频房间，false：表示音视频房间

on_firstvideoframe

简要描述

播放用户音视频时，收到第一帧视频数据的回调 播放某用户视频，渲染视频第一帧时，会收到回调；如果没有unplay某用户的视频，而再次play该用户视频时，不会再次收到此回调 单摄模式：播放用户视频，渲染视频第一帧回调 多摄模式：播放用户某一设备视频，渲染视频第一帧回调 默认是：单流模式。
接口详情

void (on_firstvideoframe)( struct roomclient client , const char peerId , const char mediaType , int width , int height);

参数	说明
width	视频宽
height	视频高
peerId	用户ID
mediaType	媒体类型

on_firstaudioframe

简要描述

播放用户音视频时，收到第一帧音频数据的回调
接口详情

void (on_firstaudioframe)( struct roomclient client , const char* peerId , TK_MEDIATYPE_C mediaType);

参数	说明
peerId	用户ID
mediaType（TK_MEDIATYPE_C）	媒体类型

on_videostatechanged

简要描述

观看用户音视频过程中，视频状态变化的回调
接口详情

void(on_videostatechanged)( struct roomclient client , const char connectionId, const char id, TK_MEDIA_STATE_C state);

参数	说明
connectionId	用户ID
id	媒体类型（media、screen、camera device id）
state	视频的状态（暂停和继续）详情请查看 TK_MEDIA_STATE

on_audiostatechanged

简要描述

观看用户音视频过程中，音频状态变化的回调
接口详情

void (on_audiostatechanged)( struct roomclient client , const char* connectionId , TK_MEDIATYPE_C mediaType , TK_MEDIA_STATE_C state)

参数	说明
connectionId	用户ID
mediaType（TK_MEDIATYPE_C）	媒体类型
state（TK_MEDIATYPE_C）	媒体状态

on_sharemediastate

简要描述

用户分享媒体流时，媒体流状态变化的回调 可调用 playmediafile 接口播放该媒体流调用startsharemediafile() 和 stopsharemediafile() 会触发此回调
接口详情

void (on_sharemediastate)(struct roomclient, const char* peerId, TK_MEDIA_STATUS_C state);

参数	说明
peerId	用户ID
mediaType（TK_MEDIA_STATUS_C）	媒体类型

on_sharescreenstate

简要描述

用户桌面共享时，状态变化的回调，playscreen 调用startsharescreen()和stopsharescreen()会触发次回调
接口详情

void (on_sharescreenstate)(struct roomclient, const char* peerId, TK_MEDIA_STATUS_C state);

参数	说明
peerId	用户ID
state（TK_MEDIA_STATUS_C）	媒体类型

on_roomvideosizechange

简要描述

视频分辨率发生变化回调
接口详情

void(on_roomvideosizechange)(struct roomclient client , const char* peerId , int w , int h);

参数	说明
peerId	用户ID
w	视频宽
h	视频高

注意

此回调接口目前没有实现

on_roommediafileprogress

简要描述

分享媒体进度回调 调用startsharemediafile()会触发回调
接口详情

void (on_roommediafileprogress)(struct roomclient client, uint64_t pos, uint64_t total);

参数	说明
pos	当前时长
total	总时长

on_videodevicestatechanged

简要描述

视频设备状态改变的回调 当视频设备状态改变（插入或移除）时，将调用该函数
接口详情

void (on_videodevicestatechanged)( struct roomclient client , const char* deviceId , TK_DEVICE_STATE_C deviceState);

参数	说明
deviceId	设备ID
deviceState（TK_DEVICE_STATE_C）	设备状态

on_audiodevicestatechanged

简要描述

音频设备状态改变的回调 当音频设备状态改变（插入或移除）时，将调用该函数
接口详情

void (on_audiodevicestatechanged)( struct roomclient client , const char* deviceId , TK_AUDIO_DEVICE_C deviceType , TK_DEVICE_STATE_C deviceState);

参数	说明
deviceId	设备ID
deviceType（TK_AUDIO_DEVICE_C）	设备类型(播放设备或录音设备)
deviceState（TK_DEVICE_STATE_C）	设备状态

on_roombecomebigroom

简要描述

进入大教室的回调 当用户数量达到一定数量时触发的房间事件
接口详情

void (on_roombecomebigroom)(struct roomclient client)

getusernumberbyroles

简要描述

通过角色列表获取用户数量的回调 调用getusernumberbyroles()函数得到结果会以这个回调的方式返回
接口详情

void (on_gotusernumber)(struct roomclient client, int num);

参数	说明
num	返回的数量

on_gotuserinfo

简要描述

通过角色列表获取用户信息
接口详情

void (on_gotuserinfo)(struct roomclient client, const char* jsonresult);

参数	说明
jsonResult	请求的用户信息

onShareScreenStateChanged

简要描述

桌面共享中所共享的窗口状态发生变化
接口详情

void(*on_sharescreenstatechanged)(struct roomclient* client, TK_SHARESCREENE_STATE_C state);

参数	说明
code（TK_SHARESCREENE_STATE）	返回的状态码

onSystemResourceReport

简要描述

系统信息的回调（目前只有CPU、内存信息）
接口详情

void(*onSystemResourceReport)(struct roomclient* client, const TKSystemResourceInfo& infos)

参数	说明
infos（TKSystemResourceInfo）	返回的信息值