对应文件 tkroommanager_oc.h
关于进房间的简要概述
-
关于房间ID:
普通房间:需要优先在后台 创建房间,获取到房间ID后,调用 joinroom 进房间。 即时房间:无需优先在后台创建房间,可直接调用 joinRoomEx 接口,传入房间ID,即可进入房间。
-
关于用户ID问题:
roomparamjson 若传入了用户ID,SDK会使用传入的userId,若不传入用户ID, SDK会自动生成一个userId。
-
关于进房间的流程及回调:
- 调用joinroom接口后,sdk就进入了 进房间流程 :
- checkroom:检测房间, 检查 房间ID、用户密码 等信息。成功后可以获取该房间基础信息和用户基础信息;
- configroom:房间配置, 成功后获取房间链路IP地址和文档服务器地址;
- connectsocket:链接socket, 根据获取到的链路IP地址去链接socket;
- joinroom:进房间, socket成功后,开始进入房间,并返回房间信息(包括房间人数、房间消息、已发布的流信息等)。
- 回调 :
- 流程回调:此过程中用户会收到 (void)onerror()或者 - (void)onwarning(int warningCode) 的代理回调。根据在代理回调中返回的警告码或者错误码,可以了解到各个流程是成功或者失败。
- joinroom回调:成功进入房间后,有 - (void)on_roomjoined 回调
joinRoomWithHost
-
简要描述
进入普通房间,房间需要在后台创建后才能进入
-
函数原型
1 2 3 4 5 6
-(int)joinRoomWithHost:(NSString *)host port:(int)port nickname:(NSString *)nickname thirdUid:(NSString *)third_uid roomParams:(NSDictionary *)roomjsonparams userParams:(NSDictionary *)userjsonparams;
- 参数
参数 | 说明 |
---|---|
host | 服务器地址,通常是默认是https::global.talk-cloud.net |
port | 服务器http端口, 通常是443 |
nickname | 本地用户的昵称 |
third_uid | 用户可指定id 如果传空 sdk会随机生成 |
roomjsonparams | 房间配置参数 |
userjsonparams | 用户属性参数(可为null ,用户自定义属性) |
- 使用示例
1 2 3 4 5 6 7 8 9 10 11
[_roomMgr joinRoomWithHost:@"global.talk-cloud.net" port:@"443" nickName:@"iOS" roomParams:@{ TKJoinRoomParamsRoomIDKey : @"1473793911", //房间ID TKJoinRoomParamsUserRoleKey : @"0", //用户角色 TKJoinRoomParamsPasswordKey : @"1", //密码 TKJoinRoomParamsUserIDKey : @"ade123456", //用户ID @"clientType" : @(3) } userParams:nil];
joinRoomEx
-
简要描述
进入即时房间,房间无需在后台创建
-
函数原型
-(int)joinRoomEx:(NSString )roomId nickname:(NSString )nickname thirdUid:(NSString )third_uid userParams:(NSDictionary )userjsonparams;
-
使用示例
参考joinroom的使用方法
leaveRoom
-
简要描述
离开房间 调用接口后,我和房间其他用户会收到相应的 回调。 1、我会接收到自己离开房间的回调:onRoomLeaved 2、在房间其他用户收到我离开房间的回调:onUserLeft
-
函数原型
- (int)leaveRoom;
setRoomProfile
-
简要描述
设置房间类型
-
函数原型
- (int)setRoomProfile:(TKRoomProfile)profile;
TKRoomProfile详情请点击参考定义
getRoomProperties
-
简要描述
获取房间属性 需在调用 joinroom 接口后调用才能获取有效结果。 返回房间相关的所有信息,例如房间ID、房间类型、配置项等。 配置项:表示该房间是否开启了教学辅助功能,例如自动下课、答题器等等教学互动功能。
-
函数原型
- (NSDictionary *)getRoomProperties;
参数 | 说明 |
---|---|
NSDictionary | 房间相关信息的字典 |
getServerList
-
简要描述
获取服务器列表 可用于切换链接的服务器。 需在调用 joinroom 接口后调用才能获取有效结果。
-
函数原型
- (NSArray <TKServerInfo *>*)getServerList;
TKServerInfo
参数 | 说明 |
---|---|
NSArray | 若存在可用的服务器,则返回 NSArray 数组对象,否则返回 nil。 |