TUILiveConnectionManager

Live Connection relevant APIs. Functions on this page only support the live room type (LIVE).
TUIRoomEngine version 3.0.5 is supported.
TUILiveConnectionManager
Function API
Description
﻿requestConnection﻿
Request cross-room connection.
﻿cancelConnectionRequest﻿
Cancel cross-room connection request.
﻿acceptConnection﻿
Agree to connection request.
﻿rejectConnection﻿
Reject connection request.
﻿disconnect﻿
Disconnect live connection.
﻿on﻿
Listen to TUILiveConnectionManagerEvents event.
﻿off﻿
Cancel TUILiveConnectionManagerEvents event monitoring.
TUILiveConnectionManagerEvents
Event API
Description
﻿onConnectionRequestReceived﻿
Receiving a connection request monitoring event.
﻿onConnectionUserListChanged﻿
Monitoring event for changes in the number of anchors in the connecting line room.
﻿onConnectionRequestCancelled﻿
Connection request canceled monitoring event.
﻿onConnectionRequestAccept﻿
Connection request approved monitoring event.
﻿onConnectionRequestReject﻿
Connection request rejected monitoring event.
﻿onConnectionRequestTimeout﻿
Invitation timeout monitoring event.
Type Definition
Type
Description
﻿TUILiveConnectionUser﻿
Live Connection user information.
Function API Description
requestConnection
Request cross-room connection.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.requestConnection({
  roomIdList: ['roomId1','roomId2'], 
  timeout: 10,
  extensionInfo: 'extension info'
});
﻿
Parameter
Type
Required or Not
Default Value
Description
options
Object
Yes
-
Request cross-room connection parameters.
options.roomIdList
Array<String>
Yes
-
List of room IDs for pending invitation connections.
options.timeOut
Number
Yes
-
Request timeout interval, in seconds.
options.extensionInfo
String
No
''
Extended information.
Return value: Promise<void>
cancelConnectionRequest
Cancel cross-room connection request.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.cancelConnectionRequest({
  roomIdList: ['roomId1', 'roomId2']
});
Parameter
Type
Required or Not
Default Value
Description
options
Object
Yes
-
Parameters for canceling cross-room connection request.
options.roomIdList
Array<String>
Yes
-
List of room IDs with canceled connection requests.
Return value: Promise<void>
acceptConnection
Agree to connection request.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.acceptConnection({
  roomId: 'roomId'
});
Parameter
Type
Required or Not
Default Value
Description
options
Object
Yes
-
Parameters for agreeing to connection request.
options.roomId
String
Yes
-
Live streaming room ID.
Return value: Promise<void>
rejectConnection
Reject connection request.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.rejectConnection({
  roomId: 'roomId'
});
Parameter
Type
Required or Not
Default Value
Description
options
Object
Yes
-
Parameters to reject connection request.
options.roomId
String
Yes
-
Live streaming room ID.
Return value: Promise<void>
disconnect
Disconnect live connection.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
await liveConnectionManager.disconnect();
﻿
Return value: Promise<void>
on
Listen to TUILiveConnectionManagerEvents event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
const callback = ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
};
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, callback);
﻿
Parameter
Type
Required or Not
Default Value
Description
eventName
﻿TUILiveConnectionManagerEvents﻿
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler
off
Cancel TUILiveConnectionManagerEvents event monitoring.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
const callback = ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
};
liveConnectionManager.off(TUILiveConnectionManagerEvents.onConnectionRequestReceived, callback);
﻿
Parameter
Type
Required or Not
Default Value
Description
eventName
﻿TUILiveConnectionManagerEvents﻿
Yes
-
Event name.
func
(...args: any[]) => void
Yes
-
event handler
Event API Description
onConnectionRequestReceived
Receiving a connection request monitoring event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ inviter, inviteeList, extensionInfo }) => {
  console.log('liveConnectionManager.onConnectionRequestReceived', inviter, inviteeList, extensionInfo);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.inviter
﻿TUILiveConnectionUser﻿
Connection inviter.
options.inviteeList
Array<TUILiveConnectionUser>
Connecting line invitee list.
options.extensionInfo
String
Extended information.
onConnectionUserListChanged
Monitoring event for changes in the number of anchors in the connecting line room.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionUserListChanged, ({ connectedList, joinedList, leavedList }) => {
  console.log('liveConnectionManager.onConnectionUserListChanged', connectedList, joinedList, leavedList);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.connectedList
Array<TUILiveConnectionUser>
Room connecting line anchor list.
options.joinedList
Array<TUILiveConnectionUser>
Event change this time: add anchor list to the connecting line room.
options.leavedList
Array<TUILiveConnectionUser>
Event change this time: anchor list left the connecting line room.
onConnectionRequestCancelled
Connection request canceled monitoring event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestCancelled', inviter);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.inviter
﻿TUILiveConnectionUser﻿
Connection inviter.
onConnectionRequestAccept
Connection request approved monitoring event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ invitee }) => {
  console.log('liveConnectionManager.onConnectionRequestAccept', invitee);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.invitee
﻿TUILiveConnectionUser﻿
Connecting line invitee.
onConnectionRequestReject
Connection request rejected monitoring event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ invitee }) => {
  console.log('liveConnectionManager.onConnectionRequestReject', invitee);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.invitee
﻿TUILiveConnectionUser﻿
Connection invitee.
onConnectionRequestTimeout
Invitation timeout monitoring event.
const roomEngine = new TUIRoomEngine();
const liveConnectionManager = roomEngine.getLiveConnectionManager();
liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, ({ invitee, inviter }) => {
  console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
});
﻿
Parameter
Type
Description
options
Object
Parameter Options.
options.inviter
﻿TUILiveConnectionUser﻿
Connection inviter.
options.invitee
﻿TUILiveConnectionUser﻿
Connecting line invitee.
Type Definition Details
TUILiveConnectionUser
Attribute
Type
Description
roomId
String
Room ID.
userId
String
user ID.
userName
String
Username.
avatarUrl
String
user avatar URL.
joinConnectionTime
Number
Join connecting line time.
﻿

Function API	Description
requestConnection	Request cross-room connection.
cancelConnectionRequest	Cancel cross-room connection request.
acceptConnection	Agree to connection request.
rejectConnection	Reject connection request.
disconnect	Disconnect live connection.
on	Listen to TUILiveConnectionManagerEvents event.
off	Cancel TUILiveConnectionManagerEvents event monitoring.

Event API	Description
onConnectionRequestReceived	Receiving a connection request monitoring event.
onConnectionUserListChanged	Monitoring event for changes in the number of anchors in the connecting line room.
onConnectionRequestCancelled	Connection request canceled monitoring event.
onConnectionRequestAccept	Connection request approved monitoring event.
onConnectionRequestReject	Connection request rejected monitoring event.
onConnectionRequestTimeout	Invitation timeout monitoring event.

Type	Description
TUILiveConnectionUser	Live Connection user information.

Parameter	Type	Required or Not	Default Value	Description
options	Object	Yes	-	Request cross-room connection parameters.
options.roomIdList	Array<String>	Yes	-	List of room IDs for pending invitation connections.
options.timeOut	Number	Yes	-	Request timeout interval, in seconds.
options.extensionInfo	String	No	''	Extended information.

Attribute	Type	Description
roomId	String	Room ID.
userId	String	user ID.
userName	String	Username.
avatarUrl	String	user avatar URL.
joinConnectionTime	Number	Join connecting line time.