TUILiveConnectionManager

Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveConnectionManager @ TUIKitEngine
Function: 直播连线相关接口,此页面中的函数仅支持直播房间类型(TUIRoomTypeLive)。

TUILiveConnectionManager

TUILiveConnectionObserver

函数列表
描述
收到连线用户列表发生变化
接收端收到连线邀请的回调
邀请取消回调
邀请被接受回调
邀请被拒绝回调
邀请超时回调

TUILiveConnectionManager

函数列表
描述
添加事件回调
移除事件回调
发起连线请求
取消连线请求
接受连线邀请
拒绝连线邀请
退出房间连线

结构体类型

函数列表
描述
连线用户信息
连线请求结果

枚举类型

枚举类型
描述
连线邀请状态

onConnectionUserListChanged

收到连线用户列表发生变化
OnConnectionUserListChanged onConnectionUserListChanged =
(List<TUIConnectionUser> connectedList,
List<TUIConnectionUser> joinedList,
List<TUIConnectionUser> leavedList) {};
参数
描述
connectedList
已连线的用户列表。
joinedList
新加入连线的用户列表。
leavedList
退出连线的用户列表。

onConnectionRequestReceived

接收端收到连线邀请的回调
OnConnectionRequestReceived onConnectionRequestReceived =
(TUIConnectionUser inviter,
List<TUIConnectionUser> inviteeList,
String extensionInfo) {};
参数
描述
inviter
邀请者信息。
inviteeList
被邀请连线的用户列表。
extensionInfo
透传信息。

onConnectionRequestCancelled

邀请取消回调
OnConnectionRequestCancelled onConnectionRequestCancelled =
(TUIConnectionUser inviter) {};
参数
描述
inviter
邀请者信息。

onConnectionRequestAccept

邀请被接受回调
OnConnectionRequestAccept onConnectionRequestAccept =
(TUIConnectionUser invitee) {};
参数
描述
invitee
被邀请者的用户信息。

onConnectionRequestReject

邀请被拒绝回调
OnConnectionRequestReject onConnectionRequestReject =
(TUIConnectionUser invitee) {};
参数
描述
invitee
被邀请者的用户信息。

onConnectionRequestTimeout

邀请超时回调
OnConnectionRequestTimeout onConnectionRequestTimeout =
(TUIConnectionUser inviter,
TUIConnectionUser invitee) {};
参数
描述
inviter
邀请者信息。
invitee
被邀请者的用户信息。

addObserver

添加事件回调
void addObserver(TUILiveConnectionObserver observer);
参数
描述
observer
监听的实例。

removeObserver

移除事件回调
void removeObserver(TUILiveConnectionObserver observer);
参数
描述
observer
监听的实例。

requestConnection

发起连线请求
Future<TUIValueCallBack<TUIConnectionRequestResult>> requestConnection
(List<String> roomIdList,
int timeout,
String extensionInfo);
参数
描述
roomIdList
待邀请的连线房间 ID 列表。
timeout
超时时间。
extensionInfo
扩展信息。

cancelConnectionRequest

取消连线请求
Future<TUIActionCallback> cancelConnectionRequest(List<String> roomIdList);
参数
描述
roomIdList
被取消连线请求的房间 ID 列表。

acceptConnection

接受连线邀请
Future<TUIActionCallback> acceptConnection(String roomId);
参数
描述
roomId
房间 ID。

rejectConnection

拒绝连线邀请
Future<TUIActionCallback> rejectConnection(String roomId);
参数
描述
roomId
房间 ID。

disconnect

退出房间连线
Future<TUIActionCallback> disconnect();
说明:
调用该接口会退出房间连线状态,仅限已连线的状态下调用。

TUIConnectionUser

连线用户信息
枚举类型
描述
roomId
连线的房间 ID。
userId
连线的用户 ID。
userName
连线的用户昵称。
avatarUrl
连线的用户头像地址。
joinConnectionTime
连线开始标记时间戳。

TUIConnectionRequestResult

枚举类型
描述
requestMap
连线请求结果 Map

TUIConnectionCode

连线邀请状态
枚举
取值
描述
unknown
-1
默认状态。
success
0
连线请求发送成功。
roomNotExists
1
邀请连线的房间不存在。
connecting
2
被邀请连线的房间已在邀请列表或者已连线。
connectingOtherRoom
3
被邀请连线的房间与其他房间连线中。
connetionFull
4
当前连线人数已达最大限制。
retry
5
内部错误,推荐重试一次。