tencent cloud

文档反馈

TUILiveConnectionManager

最后更新时间:2024-08-30 17:39:30
    Copyright (c) 2024 Tencent. All rights reserved.
    Module: TUILiveConnectionManager @ TUIKitEngine
    Function: 直播连线相关接口
    
    TUILiveConnectionManager

    TUILiveConnectionObserver

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

    TUILiveConnectionManager

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

    结构体类型

    函数列表
    描述
    连线用户信息

    枚举类型

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

    onConnectionUserListChanged:joinedList:leavedList:

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

    收到连线用户列表发生变化

    参数
    描述
    connectedList
    已连线的用户列表。
    joinedList
    新加入连线的用户列表。
    leavedList
    退出连线的用户列表。

    onConnectionRequestReceived:inviteeList:extensionInfo:

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

    接收端收到连线邀请的回调

    参数
    描述
    extensionInfo
    透传信息。
    inviteeList
    被邀请连线的用户列表。
    inviter
    邀请者信息。

    onConnectionRequestCancelled:

    onConnectionRequestCancelled:
    - (void)onConnectionRequestCancelled:
    (TUIConnectionUser *)inviter

    邀请取消回调

    参数
    描述
    inviter
    邀请者信息。

    onConnectionRequestAccept:

    onConnectionRequestAccept:
    - (void)onConnectionRequestAccept:
    (TUIConnectionUser *)invitee

    邀请被接受回调

    参数
    描述
    invitee
    被邀请者的用户信息。

    onConnectionRequestReject:

    onConnectionRequestReject:
    - (void)onConnectionRequestReject:
    (TUIConnectionUser *)invitee

    邀请被拒绝回调

    参数
    描述
    invitee
    被邀请者的用户信息。

    onConnectionRequestTimeout:invitee:

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

    邀请超时回调

    参数
    描述
    invitee
    被邀请者的用户信息。
    inviter
    邀请者信息。

    addObserver:

    addObserver:
    - (void)addObserver:
    (id<TUILiveConnectionObserver>)observer

    添加事件回调

    参数
    描述
    observer
    监听的实例。

    removeObserver:

    removeObserver:
    - (void)removeObserver:
    (id<TUILiveConnectionObserver>)observer

    移除事件回调

    参数
    描述
    observer
    监听的实例。

    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

    发起连线请求

    参数
    描述
    extensionInfo
    扩展信息。
    roomIdList
    待邀请的连线房间ID列表。
    timeout
    超时时间。

    cancelConnectionRequest:onSuccess:onError:

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

    取消连线请求

    参数
    描述
    roomIdList
    被取消连线请求的房间Id列表。

    acceptConnection:onSuccess:onError:

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

    接受连线邀请

    参数
    描述
    roomId
    房间Id。

    rejectConnection:onSuccess:onError:

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

    拒绝连线邀请

    参数
    描述
    roomId
    房间Id。

    disconnect:onError:

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

    退出房间连线

    调用该接口会退出房间连线状态,仅限已连线的状态下调用。

    TUIConnectionCode

    TUIConnectionCode

    连线邀请状态

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

    TUIConnectionUser

    TUIConnectionUser

    连线用户信息

    枚举类型
    描述
    avatarUrl
    连线的用户头像地址。
    joinConnectionTime
    连线开始标记时间戳。
    roomId
    连线的房间id。
    userId
    连线的用户id。
    userName
    连线的用户昵称。
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持