このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

TUILiveConnectionManager

Copyright (c) 2024 Tencent. All rights reserved.
Module:   TUILiveConnectionManager @ TUIKitEngine
Function: Live-Connection APIS, the functions on this webpage only support to ﻿TUIRoomTypeLive﻿ room type.
﻿
TUILiveConnectionManager
TUILiveConnectionObserver
FuncList
DESC
onConnectionUserListChanged:joinedList:leavedList:
Callback for connected users changed.
onConnectionRequestReceived:inviteeList:extensionInfo:
Callback for received the connection invitation
onConnectionRequestCancelled:
Callback for canceled the connection invitation
onConnectionRequestAccept:
Callback for accepted the connection invitation
onConnectionRequestReject:
Callback for rejected the connection invitation
onConnectionRequestTimeout:invitee:
Callback for timeout the connection invitation
TUILiveConnectionManager
FuncList
DESC
addObserver:
Add event callback
removeObserver:
Remove event callback
requestConnection:timeout:extensionInfo:onSuccess:onError:
Request connection invitation
cancelConnectionRequest:onSuccess:onError:
Cancel request about connection invitation
acceptConnection:onSuccess:onError:
Accept the connection invitation
rejectConnection:onSuccess:onError:
Reject the connection invitation
disconnect:onError:
Exit the connection.
StructType
FuncList
DESC
TUIConnectionUser
Connection User Info
EnumType
EnumType
DESC
TUIConnectionCode
Connection Request Status
onConnectionUserListChanged:joinedList:leavedList:
onConnectionUserListChanged:joinedList:leavedList:
- (void)onConnectionUserListChanged:
(NSArray<﻿TUIConnectionUser﻿*> *)connectedList
joinedList:
(NSArray<﻿TUIConnectionUser﻿*> *)joinedList
leavedList:
(NSArray<﻿TUIConnectionUser﻿*> *)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:inviteeList:extensionInfo:
onConnectionRequestReceived:inviteeList:extensionInfo:
- (void)onConnectionRequestReceived:
(﻿TUIConnectionUser﻿ *)inviter
inviteeList:
(NSArray<﻿TUIConnectionUser﻿*> *)inviteeList
extensionInfo:
(NSString*)extensionInfo
Callback for received the connection invitationParam
DESC
extensionInfo
Extension info。
inviteeList
The list of ﻿TUIConnectionUser﻿ about the invitee in current connection.
inviter
The ﻿TUIConnectionUser﻿ about the inviter.
onConnectionRequestCancelled:
onConnectionRequestCancelled:
- (void)onConnectionRequestCancelled:
(﻿TUIConnectionUser﻿ *)inviter
Callback for canceled the connection invitationParam
DESC
inviter
The ﻿TUIConnectionUser﻿ about the inviter.
onConnectionRequestAccept:
onConnectionRequestAccept:
- (void)onConnectionRequestAccept:
(﻿TUIConnectionUser﻿ *)invitee
Callback for accepted the connection invitationParam
DESC
invitee
The ﻿TUIConnectionUser﻿ about the invitee.
onConnectionRequestReject:
onConnectionRequestReject:
- (void)onConnectionRequestReject:
(﻿TUIConnectionUser﻿ *)invitee
Callback for rejected the connection invitationParam
DESC
invitee
The ﻿TUIConnectionUser﻿ about the invitee.
onConnectionRequestTimeout:invitee:
onConnectionRequestTimeout:invitee:
- (void)onConnectionRequestTimeout:
(﻿TUIConnectionUser﻿ *)inviter
invitee:
(﻿TUIConnectionUser﻿ *)invitee
Callback for timeout the connection invitationParam
DESC
invitee
The ﻿TUIConnectionUser﻿ about the invitee.
inviter
The ﻿TUIConnectionUser﻿ about the inviter.
addObserver:
addObserver:
- (void)addObserver:
(id<﻿TUILiveConnectionObserver﻿>)observer
Add event callbackParam
DESC
observer
The instance being listened to.
removeObserver:
removeObserver:
- (void)removeObserver:
(id<﻿TUILiveConnectionObserver﻿>)observer
Remove event callbackParam
DESC
observer
The instance being listened to.
requestConnection:timeout:extensionInfo:onSuccess:onError:
requestConnection:timeout:extensionInfo:onSuccess:onError:
- (void)requestConnection:
(NSArray<NSString *> *)roomIdList
timeout:
(NSTimeInterval)timeout
extensionInfo:
(NSString*)extensionInfo
onSuccess:
(TUIConnectionRequestBlock)onSuccess
onError:
(TUIErrorBlock)onError
Request connection invitationParam
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:onSuccess:onError:
cancelConnectionRequest:onSuccess:onError:
- (void)cancelConnectionRequest:
(NSArray<NSString *> *)roomIdList
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
Cancel request about connection invitationParam
DESC
roomIdList
The list of room IDs whose connection requests will be canceled.
acceptConnection:onSuccess:onError:
acceptConnection:onSuccess:onError:
- (void)acceptConnection:
(NSString *)roomId
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
Accept the connection invitationParam
DESC
roomId
The room ID of the inviter about connection invitation.
rejectConnection:onSuccess:onError:
rejectConnection:onSuccess:onError:
- (void)rejectConnection:
(NSString *)roomId
onSuccess:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
Reject the connection invitationParam
DESC
roomId
The room ID of the inviter about connection invitation.
disconnect:onError:
disconnect:onError:
- (void)disconnect:
(TUISuccessBlock)onSuccess
onError:
(TUIErrorBlock)onError
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 StatusEnum
Value
DESC
TUIConnectionCodeUnknown
-1
default.
TUIConnectionCodeSuccess
0
Request success.
TUIConnectionCodeRoomNotExist
1
Request room not exist.
TUIConnectionCodeConnecting
2
The room you are invited to connect to is already in the invitation list or is already connected.
TUIConnectionCodeConnectingOtherRoom
3
The room you are invited to connect to is connecting with other rooms.
TUIConnectionCodeFull
4
The current number of connections has reached the maximum limit.
TUIConnectionCodeRetry
5
Please try again.
TUIConnectionUser
TUIConnectionUser
Connection User InfoEnumType
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.

FuncList	DESC
onConnectionUserListChanged:joinedList:leavedList:	Callback for connected users changed.
onConnectionRequestReceived:inviteeList:extensionInfo:	Callback for received the connection invitation
onConnectionRequestCancelled:	Callback for canceled the connection invitation
onConnectionRequestAccept:	Callback for accepted the connection invitation
onConnectionRequestReject:	Callback for rejected the connection invitation
onConnectionRequestTimeout:invitee:	Callback for timeout the connection invitation

FuncList	DESC
addObserver:	Add event callback
removeObserver:	Remove event callback
requestConnection:timeout:extensionInfo:onSuccess:onError:	Request connection invitation
cancelConnectionRequest:onSuccess:onError:	Cancel request about connection invitation
acceptConnection:onSuccess:onError:	Accept the connection invitation
rejectConnection:onSuccess:onError:	Reject the connection invitation
disconnect:onError:	Exit the connection.

- (void)onConnectionUserListChanged:	(NSArray<TUIConnectionUser> )connectedList
joinedList:	(NSArray<TUIConnectionUser> )joinedList
leavedList:	(NSArray<TUIConnectionUser> )leavedList

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

- (void)onConnectionRequestReceived:	(TUIConnectionUser *)inviter
inviteeList:	(NSArray<TUIConnectionUser> )inviteeList
extensionInfo:	(NSString*)extensionInfo

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

- (void)onConnectionRequestTimeout:	(TUIConnectionUser *)inviter
invitee:	(TUIConnectionUser *)invitee

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

- (void)requestConnection:	(NSArray<NSString > )roomIdList
timeout:	(NSTimeInterval)timeout
extensionInfo:	(NSString*)extensionInfo
onSuccess:	(TUIConnectionRequestBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)cancelConnectionRequest:	(NSArray<NSString > )roomIdList
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

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

- (void)acceptConnection:	(NSString *)roomId
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

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

- (void)rejectConnection:	(NSString *)roomId
onSuccess:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

- (void)disconnect:	(TUISuccessBlock)onSuccess
onError:	(TUIErrorBlock)onError

Enum	Value	DESC
TUIConnectionCodeUnknown	-1	default.
TUIConnectionCodeSuccess	0	Request success.
TUIConnectionCodeRoomNotExist	1	Request room not exist.
TUIConnectionCodeConnecting	2	The room you are invited to connect to is already in the invitation list or is already connected.
TUIConnectionCodeConnectingOtherRoom	3	The room you are invited to connect to is connecting with other rooms.
TUIConnectionCodeFull	4	The current number of connections has reached the maximum limit.
TUIConnectionCodeRetry	5	Please try again.

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.