Docs Overview/
TUILiveConnectionManager/

TUILiveConnectionManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveConnectionManager @ TUIKitEngine
Function: Live-Connection APIs

TUILiveConnectionManager

TUILiveConnectionManager

FuncList
DESC
Callback for connected users changed.
Callback for received the connection invitation
Callback for canceled the connection invitation
Callback for accepted the connection invitation
Callback for rejected the connection invitation
Callback for timeout the connection invitation
Add event callback
Remove event callback
Request connection invitation
Cancel request about connection invitation
Accept the connection invitation
Reject the connection invitation
Exit the connection.

StructType

FuncList
DESC
Connection User Info

EnumType

EnumType
DESC
Connection Request Status

onConnectionUserListChanged

onConnectionUserListChanged
void onConnectionUserListChanged
(List<ConnectionUser> connectedList

List<ConnectionUser> joinedList

List<ConnectionUser> leavedList)

Callback for connected users changed.

Param
DESC
connectedList
List of connected users.
joinedList
List of joined connected users.
leavedList
List of leaved connected users.

onConnectionRequestReceived

onConnectionRequestReceived
void onConnectionRequestReceived
(ConnectionUser inviter

List<ConnectionUser> inviteeList

String extensionInfo)

Callback for received the connection invitation

Param
DESC
extensionInfo
Extension info。
inviteeList
The list of ConnectionUser about the invitee in current connection.
inviter
The ConnectionUser about the inviter.

onConnectionRequestCancelled

onConnectionRequestCancelled
void onConnectionRequestCancelled
(ConnectionUser inviter)

Callback for canceled the connection invitation

Param
DESC
inviter
The ConnectionUser about the inviter.

onConnectionRequestAccept

onConnectionRequestAccept
void onConnectionRequestAccept
(ConnectionUser invitee)

Callback for accepted the connection invitation

Param
DESC
invitee
The ConnectionUser about the invitee.

onConnectionRequestReject

onConnectionRequestReject
void onConnectionRequestReject
(ConnectionUser invitee)

Callback for rejected the connection invitation

Param
DESC
invitee
The ConnectionUser about the invitee.

onConnectionRequestTimeout

onConnectionRequestTimeout
void onConnectionRequestTimeout
(ConnectionUser inviter

ConnectionUser invitee)

Callback for timeout the connection invitation

Param
DESC
invitee
The ConnectionUser about the invitee.
inviter
The ConnectionUser about the inviter.

addObserver

addObserver
void addObserver
(Observer observer)

Add event callback

Param
DESC
observer
The instance being listened to.

removeObserver

removeObserver
void removeObserver
(Observer observer)

Remove event callback

Param
DESC
observer
The instance being listened to.

requestConnection

requestConnection
void requestConnection
(List<String> roomIdList

int timeout

String extensionInfo

ConnectionRequestCallback callback)

Request connection invitation

Param
DESC
extensionInfo
Extension info.
roomIdList
The list of room IDs will be invited.
timeout
Timeout time, in seconds. If it is set to 0, the SDK will not execute timeout detection and will not trigger a timeout callback.

cancelConnectionRequest

cancelConnectionRequest
void cancelConnectionRequest
(List<String> roomIdList

TUIRoomDefine.ActionCallback callback)

Cancel request about connection invitation

Param
DESC
roomIdList
The list of room IDs whose connection requests will be canceled.

acceptConnection

acceptConnection
void acceptConnection
(String roomId

TUIRoomDefine.ActionCallback callback)

Accept the connection invitation

Param
DESC
roomId
The room ID of the inviter about connection invitation.

rejectConnection

rejectConnection
void rejectConnection
(String roomId

TUIRoomDefine.ActionCallback callback)

Reject the connection invitation

Param
DESC
roomId
The room ID of the inviter about connection invitation.

disconnect

disconnect
void disconnect
(TUIRoomDefine.ActionCallback callback)

Exit the connection.

Calling this interface will exit the room connection state, and can only be called in the connected state.

TUIConnectionCode

TUIConnectionCode

Connection Request Status

Enum
Value
DESC
UNKNOWN
-1
default.
SUCCESS
0
Request success.
ROOM_NOT_EXISTS
1
Request room not exist.
CONNECTING
2
The room you are invited to connect to is already in the invitation list or is already connected.
CONNECTING_OTHER_ROOM
3
The room you are invited to connect to is connecting with other rooms.
CONNECTION_FULL
4
The current number of connections has reached the maximum limit.
RETRY
5
Please try again.

TUIConnectionUser

TUIConnectionUser

Connection User Info

EnumType
DESC
avatarUrl
The user avatar url of the connection user.
joinConnectionTime
The Timestamp of when the user joined the connection.
roomId
The room id of the connection user.
userId
The user id of the connection user.
userName
The user name of the connection user.