跳转至
400-881-9892

文档中心

官方文档,可查阅产品介绍、快速入门、用户指南、开发指南、API参考、SDK参考、帮助等信息。

文档中心 互动课堂

初始化和注册设置相关接口

最近更新时间:2022-01-25 14:39:47 星期二

instance

简要描述
- 创建一个 TKRoomManager 单例对象,必须通过此接口创建对象

接口名称
- + (instancetype)instance

方法示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
@interface RoomController : NSObject
@property (strong, nonatomic) TKRoomManager *roomMgr;
@end

@implementation RoomController
- (instancetype)init {
    self = [super init];
    if (self) {
        _roomMgr = [TKRoomManager instance];
    }
    return self;
}
@end
返回值说明

类型 说明
instancetype TKRoomManager类型的实例对象

destory

简要描述
- 销毁 TKRoomManager 单例对象,必须调用此接口

接口名称
- + (void)destory

方法示例

1
[TKRoomManager destory];
返回值说明

类型 说明

setLogLevel

简要描述
- 设置SDK日志打印等级,日志会写入沙盒。

接口名称
- - (int)setLogLevel:(TKLogLevel)level logPath:(NSString * _Nullable)logPath debugToConsole:(BOOL)debug

参数

参数名 必填 类型 说明
level TKLogLevel 日志等级
logPath NSString 日志写入沙盒的路径; 默认路径为:Libary/Caches/TKSDKLogs
debug BOOL 控制台是否输出日志,YES:表示控制台会打印日志,NO:表示控制台不打印日志

方法示例

1
2
3
4
5
6
7
8
- (instancetype)init {
    self = [super init];
    if (self) {
        _roomMgr = [TKRoomManager instance];
        [_roomMgr setLogLevel:TKLogLevelInfo logPath:nil debugToConsole:YES];
    }
    return self;
}
返回值说明

类型 说明
int 0:表示调用成功,非0:表示调用失败

initWithAppKey

简要描述
- 设置AppID,需要调用此接口初始化房间信息
需要传入 appKey,可在企业后台中查找appKey值

接口名称
- - (int)initWithAppID:(NSString *)appID optional:(TKRoomConfig *)config

参数

参数名 必填 类型 说明
appKey NSString 企业Key值
config TKRoomConfig 房间扩展信息,可根据自身的需求,在 TKRoomDefines.h 文件中查看 TKRoomConfig 定义的相关设置字段

方法示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
- (instancetype)init {
    self = [super init];
    if (self) {
        _roomMgr = [TKRoomManager instance]; 
        [_roomMgr setLogLevel:TKLogLevelInfo logPath:logPath debugToConsole:YES];

        TKRoomConfig *config = [[TKRoomConfig alloc] init];
        config.tk_use_secure_socket = YES;
        config.tk_host = self.host;
        config.tk_port = config.tk_use_secure_socket ? @"443" : @"80";
        [_roomMgr initWithAppKey:kAppkey optional:config];
    }
    return self;
}
返回值说明

类型 说明
int 0:表示调用成功,非0:表示调用失败

registerRoomManagerDelegate

简要描述
- 注册房间 TKRoomManagerDelegate 代理,用以接受房间信息回调。

接口名称
- - (int)registerRoomManagerDelegate:(id<TKRoomManagerDelegate> _Nullable)roomDelegate

参数

参数名 必填 类型 说明
roomDelegate id 实现 TKRoomManagerDelegate 代理的对象

方法示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
@interface RoomController : NSObject<TKRoomManagerDelegate>
@property (strong, nonatomic) TKRoomManager *roomMgr;
@end

@implementation RoomController
- (instancetype)init {
    self = [super init];
    if (self) {
        _roomMgr = [TKRoomManager instance]; 
        [_roomMgr setLogLevel:TKLogLevelInfo logPath:logPath debugToConsole:YES];

        TKRoomConfig *config = [[TKRoomConfig alloc] init];
        config.tk_use_secure_socket = YES;
        config.tk_host = self.host;
        config.tk_port = config.tk_use_secure_socket ? @"443" : @"80";
        [_roomMgr initWithAppKey:kAppkey optional:config];
        [_roomMgr registerRoomManagerDelegate:self];
    }
    return self;
}
@end
返回值说明

类型 说明
int 0:表示调用成功,非0:表示调用失败

registerMediaDelegate

简要描述
- 设置音视频数据 TKMediaFrameDelegate 的代理,可以接受到本地和远端音视频数据的回调。

接口名称
- - (int)registerMediaDelegate:(id<TKMediaFrameDelegate> _Nullable)mediaDelegate

参数

参数名 必填 类型 说明
mediaDelegate id 实现了TKMediaFrameDelegate代理的对象

方法示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
@interface RoomController : NSObject<TKRoomManagerDelegateTKMediaFrameDelegate>
@property (strong, nonatomic) TKRoomManager *roomMgr;
@end

@implementation RoomController
- (instancetype)init {
    self = [super init];
    if (self) {
        _roomMgr = [TKRoomManager instance]; 
        [_roomMgr setLogLevel:TKLogLevelInfo logPath:logPath debugToConsole:YES];

        TKRoomConfig *config = [[TKRoomConfig alloc] init];
        config.tk_use_secure_socket = YES;
        config.tk_host = self.host;
        config.tk_port = config.tk_use_secure_socket ? @"443" : @"80";
        [_roomMgr initWithAppKey:kAppkey optional:config];
        [_roomMgr registerRoomManagerDelegate:self];
        [_roomMgr registerMediaDelegate:self];
    }
    return self;
}
返回值说明

类型 说明
int 0:表示调用成功,1:表示调用失败

备注