Overview of TKRoomUser.h
TKRoomUserManager
The TKRoomUserManager class is the user management class in TKRoomSDK.
Below are the properties and methods defined in this class:
- MAIN PROPERTIES:
Property Name | Property Description |
---|---|
myID | Own User ID (NSString) |
localUser | Local User Object (TKRoomUser) |
- MAIN METHODS
Method Name | Method Description |
---|---|
getUserWithPeerID | Retrieve a user object based on the user ID |
TKRoomUser
The TKRoomUser class is the user class in TKRoomSDK. It defines the properties related to a user.
Below are the properties and methods defined in this class:
- MAIN PROPERTIES:
Property Name | Property Description |
---|---|
peerID | User ID(NSString) |
nickName | User Nickname (NSString) |
role | User Role (NSString) |
hasAudio | Whether has Microphone (NSString) |
hasVideo | Whether has Camera (NSString) |
canDraw | Whether has Whiteboard Drawing Permission (NSString) |
publishState | Publication Status (NSString) |
properties | Other Customizable Properties (NSString) |
disableVideo | Whether the camera disabled (NSString) |
disableAudio | Whether the microphone disabled (NSString) |
- MAIN METHODS
Property Name | Property Description |
---|---|
initWithPeerId | Initialize a user object |
getPublishStateForDeviceId | Get the publishing status of the video |
enableDualStream | Whether the dual-stream mode enabled |