文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>实时音视频>客户端 API>RTC Room Engine SDK>Web>TUILiveConnectionManager

TUILiveConnectionManager

最近更新时间：2025-08-25 11:02:01

我的收藏

本页目录：

Function: 直播连线相关接口，此页面中的函数仅支持直播房间类型（LIVE）。
TUIRoomEngine 3.0.5 版本开始支持。

TUILiveConnectionManager

函数接口
说明
请求跨房连线。
取消跨房连线请求。
同意连线请求。
拒绝连线请求。
断开直播连线。
on
监听 TUILiveConnectionManagerEvents 事件。
off
取消 TUILiveConnectionManagerEvents 事件监听。

TUILiveConnectionManagerEvents

事件接口
说明
接收到连线请求的监听事件。
连线房间主播人数变更的监听事件。
连线请求被取消的监听事件。
连线请求被同意的监听事件。
连线请求被拒绝的监听事件。
邀请超时的监听事件。

类型定义

类型
说明
直播连线用户信息。

函数接口详情

requestConnection

请求跨房连线。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.requestConnection({
  roomIdList: ['roomId1','roomId2'], 
  timeout: 10,
  extensionInfo: 'extension info'
});

参数
类型
是否必填
默认值
说明
options
Object
是
-
请求跨房连线的参数。
options.roomIdList
Array<String>
是
-
待邀请的连线房间 ID 列表。
options.timeOut
Number
是
-
请求超时时间，单位秒。
options.extensionInfo
String
否
''
扩展信息。
返回值：Promise<void>

cancelConnectionRequest

取消跨房连线请求。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.cancelConnectionRequest({
  roomIdList: ['roomId1', 'roomId2']
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
取消跨房连线请求的参数。
options.roomIdList
Array<String>
是
-
被取消连线请求的房间 ID 列表。
返回值：Promise<void>

acceptConnection

同意连线请求。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.acceptConnection({
  roomId: 'roomId'
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
同意连线请求的参数。
options.roomId
String
是
-
直播房间 ID。
返回值：Promise<void>

rejectConnection

拒绝连线请求。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.rejectConnection({
  roomId: 'roomId'
});
参数
类型
是否必填
默认值
说明
options
Object
是
-
拒绝连线请求的参数。
options.roomId
String
是
-
直播房间 ID。
返回值：Promise<void>

disconnect

断开直播连线。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.disconnect();

返回值：Promise<void>

on

监听 TUILiveConnectionManagerEvents 事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
const callback = ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
};
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, callback);

参数
类型
是否必填
默认值
说明
eventName
是
-
事件名。
func
(...args: any[]) => void
是
-
事件处理函数。

off

取消 TUILiveConnectionManagerEvents 事件监听。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
const callback = ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
};
liveConnectionManager.off(TUILiveConnectionManagerEvents.onConnectionRequestReceived, callback);

参数
类型
是否必填
默认值
说明
eventName
是
-
事件名。
func
(...args: any[]) => void
是
-
事件处理函数。

事件接口详情

onConnectionRequestReceived

接收到连线请求的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ inviter, inviteeList, extensionInfo }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter, inviteeList, extensionInfo);
});

参数
类型
说明
options
Object
参数选项。
options.inviter
连线邀请者。
options.inviteeList
连线被邀请者列表。
options.extensionInfo
String
扩展信息。

onConnectionUserListChanged

连线房间主播人数变更的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionUserListChanged, ({ connectedList, joinedList, leavedList }) => {
  console.log('liveConnectionManager.onConnectionUserListChanged', connectedList, joinedList, leavedList);
});

参数
类型
说明
options
Object
参数选项。
options.connectedList
包含连线房间所有主播列表。
options.joinedList
本次事件变更加入连线房间的主播列表。
options.leavedList
本次事件变更离开连线房间的主播列表。

onConnectionRequestCancelled

连线请求被取消的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestCancelled', inviter);
});

参数
类型
说明
options
Object
参数选项。
options.inviter
连线邀请者。

onConnectionRequestAccept

连线请求被同意的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ invitee }) => {
  console.log('liveConnectionManager.onConnectionRequestAccept', invitee);
});

参数
类型
说明
options
Object
参数选项。
options.invitee
连线被邀请者。

onConnectionRequestReject

连线请求被拒绝的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ invitee }) => {
  console.log('liveConnectionManager.onConnectionRequestReject', invitee);
});

参数
类型
说明
options
Object
参数选项。
options.invitee
连线被邀请者。

onConnectionRequestTimeout

邀请超时的监听事件。
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, ({ invitee, inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
});

参数
类型
说明
options
Object
参数选项。
options.inviter
连线邀请者。
options.invitee
连线被邀请者。

类型定义详情

TUILiveConnectionUser

属性
类型
说明
roomId
String
房间 ID。
userId
String
用户 ID。
userName
String
用户名称。
avatarUrl
String
用户头像 URL。
joinConnectionTime
Number
加入连线时间。


中国站
目录