tencent cloud

文档反馈

TUIRoomKit

最后更新时间:2023-10-20 10:13:48

    简介

    TUIRoomKit 是多人视频会议 SDK 提供的上层 UI 开源套件,目前 iOS 平台仅支持 Swift 语言,通过简单 API 调用即可唤起会议 UI。

    TUIRoomKit 接口

    API
    描述
    初始化 TUIRoomKit 单例对象
    login
    初始化用户信息接口,您需要先初始化用户信息后才能进入房间,并进行一系列的操作
    logout
    退出登录接口,会有主动离开房间操作、销毁资源
    设置用户信息(头像、昵称)进入准备页面(可选)
    进入准备页面(可选)
    创建房间
    enterRoom
    进入房间
    添加 TUIRoomKit 事件回调

    sharedInstance

    初始化 TUIRoomKit 单例对象。
    static let sharedInstance: TUIRoomKit

    login(sdkAppId:,userId:,userSig:)

    初始化用户信息接口,设置 SDK 必要参数,SDKAPPID,用户ID,用户签名。您需要先初始化用户信息后才能进入房间,并进行一系列的操作。
    public func login(sdkAppId: Int, userId: String, userSig: String) -> Void
    参数含义如下表所示:
    参数
    类型
    含义
    sdkAppId
    Int
    您可以在实时音视频控制台>应用管理> 应用信息中查看 SDKAppID
    userId
    String
    当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)
    userSig
    String
    腾讯云设计的一种安全保护签名,获取方式请参见 如何计算及使用 UserSig

    logout

    退出登录接口,会有主动离开房间操作、销毁资源。
    public func logout()

    setSelfInfo

    设置用户信息(头像、昵称)。
    public func setSelfInfo(userName: String, avatarURL: String) -> Void
    参数
    类型
    含义
    userName
    String
    用户名
    avatarURL
    String
    用户头像链接

    enterPrepareView

    进入准备页面(可选)。
    public func enterPrepareView(enablePreview: Bool) -> Void
    参数
    类型
    含义
    enablePreview
    Bool
    是否开启视频预览画面,true 表示开启

    createRoom(roomInfo:,scene:)

    创建房间。
    public func createRoom(roomInfo: RoomInfo, scene: RoomScene) -> Void
    参数含义如下表所示:
    参数
    类型
    含义
    roomInfo
    RoomInfo
    房间信息
    roomInfo.roomId
    String
    房间字符串
    roomInfo.name
    String
    房间名称
    roomInfo.isOpenCamera
    Bool
    进入房间前设置是否打开摄像头
    roomInfo.isOpenMicrophone
    Bool
    进入房间前设置是否打开麦克风
    roomInfo.isUseSpeaker
    Bool
    进入房间前设置是否打开扬声器
    roomInfo.speechMode
    TUISpeechMode
    麦控模式(自由发言模式、申请发言模式、上麦模式)
    scene
    RoomScene
    房间类型(会议、直播)

    enterRoom(roomInfo:, scene:)

    进入房间。
    public func enterRoom(roomInfo: RoomInfo) -> Void
    参数含义如下表所示:
    参数
    类型
    含义
    roomInfo
    RoomInfo
    房间信息
    roomInfo.roomId
    String
    房间字符串
    roomInfo.isOpenCamera
    Bool
    进入房间前设置是否打开摄像头
    roomInfo.isOpenMicrophone
    Bool
    进入房间前设置是否打开麦克风
    roomInfo.isUseSpeaker
    Bool
    进入房间前设置是否打开扬声器

    addListener(listener:)

    添加 TUIRoomKit 事件回调。
    
    public func addListener(listener: TUIRoomKitListener) -> Void
    参数
    类型
    含义
    listener
    TUIRoomKitListener
    TUIRoomKit 回调事件

    TUIRoomKit 事件回调 TUIRoomKitListener

    回调
    含义
    onLogin
    用户登录回调
    创建房间回调
    进入房间回调
    销毁房间回调
    退出房间回调

    onLogin

    登录回调。
    参数
    类型
    含义
    code
    Int
    错误码,成功时为0
    message
    String
    回调信息

    onRoomCreate

    创建房间回调。
    参数
    类型
    含义
    code
    Int
    错误码,成功时为0
    message
    String
    回调信息

    onRoomEnter

    进入房间回调。
    参数
    类型
    含义
    code
    Int
    错误码,成功时为0
    message
    String
    回调信息

    onDestroyRoom

    销毁房间回调。

    onExitRoom

    退出房间回调。
    
    联系我们

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

    技术支持

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

    7x24 电话支持