TUIRoomKit
Last updated: 2023-10-23 11:31:27Download PDF
TUIRoomKit Interface
API | Description |
Create Instance of TUIRoomKit | |
Login to TUIRoomKit | |
Logout of TUIRoomKit | |
Set User Info (Avatar, Nickname) | |
Enter Prepare View (Optional) | |
Create Room | |
Enter Room | |
Add TUIRoomKit Event Callback |
sharedInstance
Create Instance of TUIRoomKit
public static TUIRoomKit sharedInstance();
Parameter | Description |
context | Android Context |
login
Login to TUIRoomKit
public abstract void login(int sdkAppId, String userId, String userSig);
Parameter | Description |
sdkAppId | You can view the SDKAppID in Tencent Real-Time Communication Console > Application Management > Application Info |
userId | Current User ID, String Type, Only Allowed to Contain English Letters (a-z and A-Z), Numbers (0-9), Hyphens (-) and Underscores (_) |
userSig | A security protection signature designed by Tencent Cloud, for how to calculate and use UserSig, please refer to How to Calculate and Use UserSig |
logout
Logout of TUIRoomKit
public abstract void logout();
setSelfInfo
public abstract void setSelfInfo(String userName, String avatarURL);
Parameter | Description |
userName | Username |
avatarURL | User Avatar URL |
enterPrepareView
public abstract void enterPrepareView(boolean enablePreview);
Parameter | Description |
enablePreview | Whether to enable video preview screen, true means enabled |
createRoom
Create Room
public abstract void createRoom(RoomInfo roomInfo, RoomScene scene);
Parameter | Description |
roomInfo | Create Room Parameters, including Room ID, Room Number, etc. |
scene | Room Type |
enterRoom
Enter Room
public abstract void enterRoom(RoomInfo roomInfo);
Parameter | Description |
roomInfo | Enter Room Number |
addListener
Add TUIRoomKit Event Callback
public abstract void addListener(TUIRoomKitListener listener);
Parameter | Description |
listener | TUIRoomKit Callback Event |
TUIRoomKit Event Callback TUIRoomKitListener
Callback | Description |
User Login Callback | |
Create Room Callback | |
Entered room Callback | |
Destroy Room Callback | |
Exit Room Callback |
onLogin
User Login Callback
void onLogin(int code, String message);
Parameter | Description |
code | Error Code, Success is 0 |
message | Callback Information |
onRoomCreate
Create Room Callback
void onRoomCreate(int code, String message);
Parameter | Description |
code | Error Code, Success is 0 |
message | Callback Information |
onRoomEnter
Entered room Callback
void onRoomEnter(int code, String message);
Parameter | Description |
code | Error Code, Success is 0 |
message | Callback Information |
onDestroyRoom
Destroy Room Callback
void onDestroyRoom();
onExitRoom
Exit Room Callback
void onExitRoom();