TUILiveConnectionManager
Copyright (c) 2024 Tencent. All rights reserved.
Module: TUILiveConnectionManager @ TUIKitEngine
Function: 直播连线相关接口
TUILiveConnectionManager
TUILiveConnectionManager
函数列表 | 描述 |
收到连线用户列表发生变化 | |
接收端收到连线邀请的回调 | |
邀请取消回调 | |
邀请被接受回调 | |
邀请被拒绝回调 | |
邀请超时回调 | |
添加事件回调 | |
移除事件回调 | |
发起连线请求 | |
取消连线请求 | |
接受连线邀请 | |
拒绝连线邀请 | |
退出房间连线 |
结构体类型
函数列表 | 描述 |
连线用户信息 |
枚举类型
枚举类型 | 描述 |
连线邀请状态 |
onConnectionUserListChanged
onConnectionUserListChanged
void onConnectionUserListChanged | |
| |
|
收到连线用户列表发生变化
参数 | 描述 |
connectedList | 已连线的用户列表。 |
joinedList | 新加入连线的用户列表。 |
leavedList | 退出连线的用户列表。 |
onConnectionRequestReceived
onConnectionRequestReceived
void onConnectionRequestReceived | |
| |
| String extensionInfo) |
接收端收到连线邀请的回调
参数 | 描述 |
extensionInfo | 透传信息。 |
inviteeList | 被邀请连线的用户列表。 |
inviter | 邀请者信息。 |
onConnectionRequestCancelled
onConnectionRequestCancelled
void onConnectionRequestCancelled |
邀请取消回调
参数 | 描述 |
inviter | 邀请者信息。 |
onConnectionRequestAccept
onConnectionRequestAccept
void onConnectionRequestAccept |
邀请被接受回调
参数 | 描述 |
invitee | 被邀请者的用户信息。 |
onConnectionRequestReject
onConnectionRequestReject
void onConnectionRequestReject |
邀请被拒绝回调
参数 | 描述 |
invitee | 被邀请者的用户信息。 |
onConnectionRequestTimeout
onConnectionRequestTimeout
void onConnectionRequestTimeout | |
|
邀请超时回调
参数 | 描述 |
invitee | 被邀请者的用户信息。 |
inviter | 邀请者信息。 |
addObserver
addObserver
void addObserver | (Observer observer) |
添加事件回调
参数 | 描述 |
observer | 监听的实例。 |
removeObserver
removeObserver
void removeObserver | (Observer observer) |
移除事件回调
参数 | 描述 |
observer | 监听的实例。 |
requestConnection
requestConnection
void requestConnection | (List<String> roomIdList |
| int timeout |
| String extensionInfo |
| ConnectionRequestCallback callback) |
发起连线请求
参数 | 描述 |
extensionInfo | 扩展信息。 |
roomIdList | 待邀请的连线房间ID列表。 |
timeout | 超时时间。 |
cancelConnectionRequest
cancelConnectionRequest
void cancelConnectionRequest | (List<String> roomIdList |
| TUIRoomDefine.ActionCallback callback) |
取消连线请求
参数 | 描述 |
roomIdList | 被取消连线请求的房间Id列表。 |
acceptConnection
acceptConnection
void acceptConnection | (String roomId |
| TUIRoomDefine.ActionCallback callback) |
接受连线邀请
参数 | 描述 |
roomId | 房间Id。 |
rejectConnection
rejectConnection
void rejectConnection | (String roomId |
| TUIRoomDefine.ActionCallback callback) |
拒绝连线邀请
参数 | 描述 |
roomId | 房间Id。 |
disconnect
disconnect
void disconnect | (TUIRoomDefine.ActionCallback callback) |
退出房间连线
调用该接口会退出房间连线状态,仅限已连线的状态下调用。
TUIConnectionCode
TUIConnectionCode
连线邀请状态
枚举 | 取值 | 描述 |
UNKNOWN | -1 | 默认状态。 |
SUCCESS | 0 | 连线请求发送成功。 |
ROOM_NOT_EXISTS | 1 | 邀请连线的房间不存在。 |
CONNECTING | 2 | 被邀请连线的房间已在邀请列表或者已连线。 |
CONNECTING_OTHER_ROOM | 3 | 被邀请连线的房间与其他房间连线中。 |
CONNECTION_FULL | 4 | 当前连线人数已达最大限制。 |
RETRY | 5 | 内部错误,推荐重试一次。 |
TUIConnectionUser
TUIConnectionUser
连线用户信息
枚举类型 | 描述 |
avatarUrl | 连线的用户头像地址。 |
joinConnectionTime | 连线开始标记时间戳。 |
roomId | 连线的房间id。 |
userId | 连线的用户id。 |
userName | 连线的用户昵称。 |
- TUILiveConnectionManager
- 结构体类型
- 枚举类型
- onConnectionUserListChanged
- onConnectionRequestReceived
- onConnectionRequestCancelled
- onConnectionRequestAccept
- onConnectionRequestReject
- onConnectionRequestTimeout
- addObserver
- removeObserver
- requestConnection
- cancelConnectionRequest
- acceptConnection
- rejectConnection
- disconnect
- TUIConnectionCode
- TUIConnectionUser