回调接口

onRoomJoined

简要描述

成功进入房间的回调 调用joinRoomWithHost 或者 joinRoomEx 接口进入房间，成功后会回调此函数. 房间内存在其他用户，这些用户会收到- (void)onUserLeft:(TKUser *)user的回调失败则会以- (void)onError:(int)errorCode errorDes:(NSString *)errMsg;回调。
接口详情

- (void)onRoomJoined;

onRoomLeaved

简要描述

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

- (void)onRoomLeaved;

onError

简要描述

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

- (void)onError:(int)errorCode errorDes:(NSString *)errMsg;
参数

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

onWarning

简要描述

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

- (void)onWarning:(TKWarning)warning;
参数

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

onUserJoined

简要描述

有用户进入房间
接口详情

- (void)onUserJoined:(TKUser *)user inlist:(BOOL)inList;
参数

参数	说明
user	用户 [TKUser][3]
inList	YES：表示该用户是在我之前进入房间，NO：表示该用户是在我之后进入房间

onUserLeft

简要描述

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

- (void)onUserLeft:(TKUser *)user;
参数

参数	说明
user	用户 TKUser

onKickedout

简要描述

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

- (void)onKickedout:(TKKickOutReason)reason;
参数

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

onUserPropertyChanged

简要描述

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

- (void)onUserPropertyChanged:(NSString *)peerId key:(NSString *)key value:(NSObject *)value;
参数

参数	说明
peerId(NSString)	用户ID
key(NSString)	健
value(NSObject)	对应修改的值

onUserVideoStatus

简要描述

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

接口详情

（单个设备时有效）

1	`-(void)onUserVideoStatus:(NSString )peerId mediatype:(NSString )mediatype state:(TKMediaStatus)state;`

（多个设备时有效）

1	`-(void)onUserVideoStatus:(NSString )peerId mediatype:(NSString )mediatype deviceId:(NSString *)deviceId state:(TKMediaStatus)state;`

参数

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

onUserAudioStatus

简要描述

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

- (void)onUserAudioStatus:(NSString *)peerId mediatype:(NSString*)mediatype state:(TKMediaStatus)state;
参数

参数	说明
peerId(NSString)	用户ID
mediatype	媒体类型
state（[TKMediaStatus][7]）	音频状态

onRemotePubMsg

简要描述

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

接口详情

-(void)onRemotePubMsg:(NSString *)msgID
           messageName:(NSString *)msgName
                fromID:(NSString *)fromID
                  toID:(NSString *)toID
                  data:(NSObject *)data
      associatedUserID:(NSString *)associatedUserID
       associatedMsgID:(NSString *)associatedMsgID
                    ts:(long)ts;

参数

参数	说明
msgid	消息id
msgname	消息名
fromId	消息来源用户id
toId	消息接收者
data	消息
associatedUserID	绑定的UserID
associatedMsgID	绑定的MsgID
ts	消息时间戳

onRemoteDelMsg

简要描述

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

接口详情

-(void)onRemoteDelMsg:(NSString *)msgID
           messageName:(NSString *)msgName
                fromID:(NSString *)fromID
                  toID:(NSString *)toID
                  data:(NSObject *)data
      associatedUserID:(NSString *)associatedUserID
       associatedMsgID:(NSString *)associatedMsgID
                    ts:(long)ts;

参数

参数	说明
msgid	消息id
msgname	消息名
fromId	消息来源用户id
toid	消息接收者
data	消息
associatedUserID	绑定的UserID
associatedMsgID	绑定的MsgID
ts	消息时间戳

onMessageReceived

简要描述

当某用户调用sendMessage发送消息，若我是该消息的接受对象时，即可收到用户发送的消息

接口详情

1
2
3

-(void)onMessageReceived:(NSString *)peerId
                  message:(NSString *)message
                extendMsg:(NSDictionary *)extendJson;

参数

参数	说明
fromId	来自谁的消息
message	接收到的消息
extendJson	扩展的字段

onVideoStatsReport

简要描述

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

接口详情

-(void)onVideoStatsReport:
        (NSString *)peerId 
        stats:(TKVideoStats *)stats 
        type:(NSString *)type;

参数

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

onAudioStatsReport

简要描述

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

接口详情

-(void)onAudioStatsReport:
          (NSString *)peerId 
          stats:(TKAudioStats *)stats 
          type:(TKMediaType)type;

参数

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

onMicVolumeReport

简要描述

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

- (void)onMicVolumeReport:(int)volume;
参数

参数	说明
vol	麦克风音量

onRemoteAudioVolume

简要描述

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

- (void)onRemoteAudioVolume:(NSString *)peerId vol:(int)vol;
参数

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

onAudioRoomSwitch

简要描述

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

- (void)onAudioRoomSwitch:(NSString *)from onlyAudio:(BOOL)onlyAudio;
参数

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

onFirstVideoFrame

简要描述

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

接口详情

-(void)onFirstVideoFrame:
            (NSString *)peerId 
            mediaType:(NSString *)mediaType 
            width:(NSInteger)width 
            height:(NSInteger)height;

参数

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

onFirstAudioFrame

简要描述

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

- (void)onFirstAudioFrame:(NSString *)peerId mediaType:(TKMediaType)mediaType;
参数

参数	说明
peerId	用户ID
mediaType（[TKMediaType][11]）	媒体类型

onVideoStateChanged

简要描述

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

接口详情

-(void)onVideoStateChanged:
            (NSString *)peerId 
            mediaType:(NSString *)mediaType 
            state:(TKMediaState)state;

参数

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

onAudioStateChanged

简要描述

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

接口详情

-(void)onAudioStateChanged:
            (NSString *)peerId 
            mediaType:(TKMediaType)mediaType 
            state:(TKMediaState)state;

参数

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

onShareMediaState

简要描述

用户分享媒体流时，媒体流状态变化的回调 可调用 playMediafile 接口播放该媒体流调用[startShareMediaFile()][15] 和 stopShareMediaFile() 会触发此回调
接口详情

- (void)onShareMediaState:(NSString *)peerId state:(TKMediaStatus)state;
参数

参数	说明
peerId	用户ID
mediaType（[TKMediaStatus][17]）	媒体类型

onShareScreenState

简要描述

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

- (void)onShareScreenState:(NSString *)peerId state:(TKMediaStatus)state;
参数

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

onVideoSizeChange

简要描述

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

- (void)onVideoSizeChange:(NSString *)peerId width:(int)width heiht:(int)height;
参数

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

注意

此回调接口目前没有实现

onMediaFileProgress

简要描述

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

- (void)onMediaFileProgress:(uint64_t)pos total:(uint64_t)total;
参数

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

on_videodevicestatechanged

简要描述

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

-(void)onVideoDeviceStateChanged:(NSString *)deviceId deviceState:(TKDeviceState)deviceState;
参数

参数	说明
deviceId	设备ID
deviceState（[TKDeviceState][22]）	设备状态

onAudioDeviceStateChanged

简要描述

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

-(void)onAudioDeviceStateChanged: (NSString *)deviceId deviceType:(TKAudioDevice) deviceType deviceState:(TKDeviceState)deviceState;
参数

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

onBecomeBigRoom

简要描述

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

- (void)onBecomeBigRoom;

onGotUserNumber

简要描述

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

- (void)onGotUserNumber:(int)num;
参数

参数	说明
num	返回的数量

onGotUserInfo

简要描述

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

- (void)onGotUserInfo:(NSString *)jsonResult;
参数

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