tencent cloud

文档反馈

RoomKit API(iOS)

最后更新时间:2024-03-15 16:08:25

    简介

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

    TUIRoomKit 接口

    API
    描述
    初始化 TUIRoomKit 单例对象
    销毁 TUIRoomKit 单例对象
    设置用户信息(头像、昵称)(可选)
    创建房间
    enterRoom
    进入房间

    createInstance

    初始化 TUIRoomKit 单例对象。
    public class func createInstance() -> TUIRoomKit

    destroyInstance

    销毁 TUIRoomKit 单例对象。
    public class func destroyInstance() -> Void

    setSelfInfo(可选)

    设置用户信息(头像、昵称)。
    public func setSelfInfo(userName: String,
    avatarURL: String,
    onSuccess: @escaping TUISuccessBlock,
    onError: @escaping TUIErrorBlock) -> Void
    参数
    类型
    含义
    userName
    String
    用户名
    avatarURL
    String
    用户头像链接
    onSuccess
    TUISuccessBlock
    成功回调
    onError
    TUIErrorBlock
    失败回调

    createRoom

    创建房间。
    public func createRoom(roomInfo: TUIRoomInfo,
    onSuccess: @escaping TUISuccessBlock,
    onError: @escaping TUIErrorBlock) -> Void
    参数含义如下表所示:
    参数
    类型
    含义
    roomInfo
    房间基本信息
    onSuccess
    TUISuccessBlock
    成功回调
    onError
    TUIErrorBlock
    失败回调

    enterRoom

    进入房间。
    public func enterRoom(roomId: String,
    enableAudio: Bool,
    enableVideo: Bool,
    isSoundOnSpeaker: Bool,
    onSuccess: @escaping TUISuccessBlock,
    onError: @escaping TUIErrorBlock) -> Void
    参数含义如下表所示:
    参数
    类型
    含义
    roomId
    String
    房间号字符串
    enableAudio
    Bool
    进入房间是否开启音频
    enableVideo
    Bool
    进入房间是否开启视频
    isSoundOnSpeaker
    Bool
    进入房间是否开启扬声器
    onSuccess
    TUISuccessBlock
    成功回调
    onError
    TUIErrorBlock
    失败回调
    
    联系我们

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

    技术支持

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

    7x24 电话支持