TUILiveConnectionManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveConnectionManager @ TUIKitEngine
Functions: Relevant APIs for Live Connection. The functions on this page are only supported for live room type (TUIRoomTypeLive).
TUILiveConnectionManager
TUILiveConnectionObserver
Function List | Description |
Received that the connected user list has changed. | |
Callback that the recipient receives the connection invitation | |
Invitation cancellation callback | |
Invitation accepted callback | |
Invitation rejected callback | |
Invitation timeout callback |
TUILiveConnectionManager
Function List | Description |
Add event callback | |
Remove event callback | |
Initiate a connection request | |
Cancel a connection request | |
Accept a connection invitation | |
Reject a connection invitation | |
Leave the room connecting line |
Structure Data Type
Function List | Description |
Connected User Information | |
Connection request result |
Enumeration Types
Enumeration Types | Description |
Connection invitation status |
onConnectionUserListChanged
Received that the connected user list has changed.
OnConnectionUserListChanged onConnectionUserListChanged =(List<TUIConnectionUser> connectedList,List<TUIConnectionUser> joinedList,List<TUIConnectionUser> leavedList) {};
Parameter | Description |
connectedList | List of connected users. |
joinedList | List of newly joined users. |
leavedList | List of users who have exited the connection. |
onConnectionRequestReceived
Callback that the recipient receives the connection invitation
OnConnectionRequestReceived onConnectionRequestReceived =(TUIConnectionUser inviter,List<TUIConnectionUser> inviteeList,String extensionInfo) {};
Parameter | Description |
inviter | Inviter information. |
inviteeList | List of invited users for connection. |
extensionInfo | Transparent transmission of information. |
onConnectionRequestCancelled
Invitation cancellation callback
OnConnectionRequestCancelled onConnectionRequestCancelled =(TUIConnectionUser inviter) {};
Parameter | Description |
inviter | Inviter information. |
onConnectionRequestAccept
Invitation accepted callback
OnConnectionRequestAccept onConnectionRequestAccept =(TUIConnectionUser invitee) {};
Parameter | Description |
invitee | Invitee user information. |
onConnectionRequestReject
Invitation rejected callback
OnConnectionRequestReject onConnectionRequestReject =(TUIConnectionUser invitee) {};
Parameter | Description |
invitee | Invitee user information. |
onConnectionRequestTimeout
Invitation timeout callback
OnConnectionRequestTimeout onConnectionRequestTimeout =(TUIConnectionUser inviter,TUIConnectionUser invitee) {};
Parameter | Description |
inviter | Inviter information. |
invitee | Invitee user information. |
addObserver
Add event callback
void addObserver(TUILiveConnectionObserver observer);
Parameter | Description |
observer | Instances being listened to. |
removeObserver
Remove event callback
void removeObserver(TUILiveConnectionObserver observer);
Parameter | Description |
observer | Instances being listened to. |
requestConnection
Initiate a connection request
Future<TUIValueCallBack<TUIConnectionRequestResult>> requestConnection(List<String> roomIdList,int timeout,String extensionInfo);
Parameter | Description |
roomIdList | List of room IDs to be invited for connection. |
timeout | Timeout Time |
extensionInfo | Extended information. |
cancelConnectionRequest
Cancel a connection request
Future<TUIActionCallback> cancelConnectionRequest(List<String> roomIdList);
Parameter | Description |
roomIdList | List of room IDs for which the connection request has been canceled. |
acceptConnection
Accept a connection invitation
Future<TUIActionCallback> acceptConnection(String roomId);
Parameter | Description |
roomId | room ID. |
rejectConnection
Reject a connection invitation
Future<TUIActionCallback> rejectConnection(String roomId);
Parameter | Description |
roomId | room ID. |
disconnect
Leave the room connecting line
Future<TUIActionCallback> disconnect();
Note:
Calling this API will exit the room connecting line status. It can only be called in the connected status.
TUIConnectionUser
Connected User Information
Enumeration Types | Description |
roomId | Connecting room id. |
userId | id of the connected user. |
userName | User nickname of the connected user. |
avatarUrl | User Avatar Address of the connected user. |
joinConnectionTime | Mark the timestamp when the connection starts. |
TUIConnectionRequestResult
Enumeration Types | Description |
requestMap | Connection request result Map |
TUIConnectionCode
Connection invitation status
Error Example | Value | Description |
unknown | -1 | Default status. |
success | 0 | Connection request sent successfully. |
roomNotExists | 1 | The room for the connection invitation does not exist. |
connecting | 2 | The room invited for connection is already in the invitation list or has been connected. |
connectingOtherRoom | 3 | The invited room is connecting with other rooms. |
connetionFull | 4 | The current number of connections has reached the maximum limit. |
retry | 5 | Internal error, recommend retry once. |
