• TKRoomUser类
  • 概览
    • 属性
    • 实例方法

TKRoomUser类

说明	类型
Inherits from	NSObject
Declared in	TKRoomUser.h

概览

用户实例对象类

属性

peerID

用户ID
@property (nonatomic, copy) NSString *peerID;

nickName

用户昵称
@property (nonatomic, copy) NSString *nickName;

role

用户身份，0：老师；1：助教；2：学生；3：旁听；4：隐身用户
@property (nonatomic, assign) TKUserRoleType role;

hasAudio

用户是否开启音频设备权限
@property (nonatomic, assign) BOOL hasAudio;

hasVideo

用户是否开启视频设备权限
@property (nonatomic, assign) BOOL hasVideo;

canDraw

该用户是否有权在白板和文档上进行绘制
@property (nonatomic, assign) BOOL canDraw;

publishState

用户的发布状态，0：未发布，1：发布音频；2：发布视频；3：发布音视频
@property (nonatomic, assign) TKPublishState publishState;

properties

用户属性
@property (nonatomic, strong) NSMutableDictionary *properties;

disableVideo

用户是否禁用视频设备
@property (nonatomic, assign) BOOL disableVideo;

disableAudio

用户是否禁用音频设备 @property (nonatomic, assign) BOOL disableAudio;

实例方法

initWithPeerId

简要描述
- 初始化一个用户

接口名称
- - (instancetype)initWithPeerId:(NSString *)peerID;

参数

参数名	必填	类型	说明
peerID	是	NSString	用户ID

方法示例

TKRoomUser *user = [[TKRoomUser alloc] initWithPeerId:peerId]];

返回值说明

类型	说明
TKRoomUser	用户实例对象

initWithPeerId

简要描述
- 初始化一个用户

接口名称
- - (instancetype)initWithPeerId:(NSString *)peerID;
- (instancetype)initWithPeerId:(NSString *)peerID AndProperties:(NSDictionary*)properties;

参数

参数名	必填	类型	说明
peerID	是	NSString	用户ID
properties	是	NSDictionary	用户属性

方法示例

TKRoomUser *user = [[TKRoomUser alloc] initWithPeerId:peerId]];
TKRoomUser *user = [[TKRoomUser alloc] initWithPeerId:peerId AndProperties:@{@"role":@2}];

返回值说明

类型	说明
TKRoomUser	用户实例对象

getPublishStateForDeviceId

简要描述
- 获取 某个视频设备的视频发布状态(该用户的设备支持多摄像头，并同时开启了多流功能)

接口名称
- - (TKPublishState)getPublishStateForDeviceId:(NSString *)deviceId;

参数

参数名	必填	类型	说明
deviceId	是	NSString	视频设备ID

方法示例

TKPublishState state = [_user getPublishStateForDeviceId:@"ad-d123"]; 

返回值说明

类型	说明
TKPublishState	发布状态

getCameraTypeWithDeviceID

简要描述
- 用户开启双摄像头时，获取摄像头是主摄像头（@"tk_maincamera"）\辅摄像头（@"tk_vicecamera"）

接口名称
- - (NSString *)getCameraTypeWithDeviceID:(NSString *)deviceId;

参数

参数名	必填	类型	说明
deviceId	是	NSString	视频设备ID

方法示例

NSString *maincamera = [_user getCameraTypeWithDeviceID:@"ad-d123"];

返回值说明

类型	说明
NSString	@"tk_maincamera" 表示主摄像头

enableDualStream

简要描述
- 是否开启了多码流

接口名称
- - (BOOL)enableDualStream;

参数
无

方法示例

BOOL ret = [_user enableDualStream];

返回值说明

类型	说明
BOOL	YES：表示开启，NO：表示未开启