tencent cloud

文档反馈

UIKit API

最后更新时间:2024-09-24 17:23:06

    API 简介

    VoiceRoomKit 是语音聊天室组件的含UI接口,使用VoiceRoomKit API,您可以通过简单接口快速实现一个语音聊天室,如果您想要体验并调试语音聊天室效果,请阅读 Demo 快速跑通。如果您想把我们的功能直接集成到您的项目中,请阅读 快速接入(TUILiveKit)

    API 概述

    API
    描述
    获取一个 VoiceRoomKit 对象实例。
    创建一个语音聊天室直播间。
    enterRoom
    通过 roomId 进入一个语音聊天室直播间。

    API 详情

    createInstance

    获取一个 VoiceRoomKit 对象实例。
    static VoiceRoomKit createInstance(Context context)
    参数:
    参数
    类型
    说明
    默认值
    含义
    context
    Context
    必填
    -
    android 上下文对象
    返回值:VoiceRoomKit

    createRoom

    创建一个语音聊天室直播间。
    
    void createRoom(String roomId, VoiceRoomDefine.CreateRoomParams params);
    参数:
    参数
    类型
    说明
    默认值
    含义
    roomId
    String
    必填
    -
    直播间 ID
    params
    必填
    -
    创建直播间参数
    返回值:void

    enterRoom

    通过 roomId 进入一个语音聊天室直播间。
    void enterRoom(String roomId);
    参数:
    参数
    类型
    说明
    默认值
    含义
    roomId
    String
    必填
    -
    直播间 ID
    返回值:void

    VoiceRoomDefine 简介

    VoiceRoomKit 是语音聊天室的 UIKit 层 数据模型类,主要包含如下数据结构:

    CreateRoomParams

    创建语音聊天室直播间时的参数对象,主要包含如下配置参数:
    参数
    类型
    说明
    默认值
    含义
    roomName
    String
    
    ""
    语音聊天室名称
    maxAnchorCount
    int
    
    10
    最大上麦的用户数
    seatMode
    String
    必填
    
    上麦模式,分为如下两种:
    FREE_TO_TAKE(1):自由上麦模式,台下观众可以自由上麦,无需申请。
    APPLY_TO_TAKE(2):申请上麦模式,台下观众上麦需要房主或者管理员同意后才能上麦。
    联系我们

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

    技术支持

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

    7x24 电话支持