tencent cloud

文档反馈

TUIRoomEngine

最后更新时间:2023-11-14 09:50:56

    TUIRoomEngine (无 UI 接口)

    TUIRoomEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。

    createInstance

    创建 TUIRoomEngine 实例
    static TUIRoomEngine createInstance()
    return:TUIRoomEngine 实例

    destroyInstance

    销毁TUIRoomEngine实例
    void destroyInstance()

    login

    登录 roomEngine 接口,您需要先初始化用户信息后才能进入房间,并进行一系列的操作
    说明:v1.0.0 该接口命名为 setup,v1.0.1 及其以上版本请使用 TUIRoomEnine.login 登录 TUIRoomEngine。
    void static login(Context context,
    int sdkAppId,
    String userId,
    String userSig,
    TUIRoomDefine.ActionCallback callback)
    参数:
    参数
    类型
    含义
    context
    Context
    Android上下文
    sdkAppId
    int
    应用信息中获取 sdkAppId 信息
    userId
    String
    用户 ID
    userSig
    String
    userSig 签名 计算 userSig 的方式请参考UserSig 相关
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    logout

    退出登录接口,会有主动离开房间操作、销毁资源
    static void logout(TUIRoomDefine.ActionCallback callback)
    参数:
    参数
    类型
    含义
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    setSelfInfo

    设置本地用户名称和头像
    static void setSelfInfo(String userName, String avatarURL, TUIRoomObserver.ActionCallback callback)
    参数:
    参数
    类型
    含义
    userName
    int
    用户名
    avatarUrl
    String
    用户头像
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    getSelfInfo

    获取本地用户登录的基本信息
    static TUIRoomDefine.LoginUserInfo getSelfInfo()
    return:用户登录信息

    addObserver

    添加TUIRoomEngine事件回调
    void addObserver(TUIRoomObserver observer)
    参数:
    参数
    类型
    含义
    observer
    TUIRoomObserver
    TUIRoomEngine 事件回调

    removeObserver

    移除TUIRoomEngine事件回调
    void removeObserver(TUIRoomObserver observer)
    参数
    类型
    含义
    observer
    TUIRoomObserver
    TUIRoomEngine 事件回调

    createRoom

    主持人创建房间,调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 ID,房间名称,以及房间是否允许加入用户开启音视频,发送消息等功能。
    void createRoom(TUIRoomDefine.RoomInfo roomInfo, TUIRoomDefine.ActionCallback callback)
    参数:
    参数
    类型
    含义
    roomInfo
    房间基本信息
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    destroyRoom

    销毁房间接口,销毁房间必须由房间所有者发起,销毁房间之后房间不可进入。
    void destroyRoom(TUIRoomDefine.ActionCallback callback)
    参数:
    参数
    类型
    含义
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    enterRoom

    进入房间接口
    void enterRoom(String roomId, TUIRoomDefine.GetRoomInfoCallback callback)
    参数:
    参数
    类型
    含义
    roomId
    String
    房间号,字符串类型
    callback
    TUIRoomDefine.GetRoomInfoCallback
    获取所进入的房间信息回调

    exitRoom

    离开房间接口,用户在执行 enterRoom 之后可通过 exitRoom 离开房间。
    void exitRoom(boolean isSyncWaiting, TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    isSyncWaiting
    boolean
    是否同步退出房间
    callback
    TUIRoomDefine.ActionCallback
    退出房间结果回调

    connectOtherRoom

    连接其他房间
    说明:
    用于直播场景下的申请跨房连麦
    TUIRoomDefine.Request connectOtherRoom(String roomId,
    String userId,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    参数:
    参数
    类型
    含义
    roomId
    String
    房间 ID
    userId
    String
    用户 ID
    timeout
    int
    时间
    callback
    TUIRoomDefine.RequestCallback
    连接其他房间请求回调
    Return:请求体

    disconnectOtherRoom

    断开与其他房间的连接
    说明:
    用于直播场景下的断开跨房连麦
    void disconnectOtherRoom(TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    callback
    TUIRoomDefine.ActionCallback
    断开与其他房间的连接结果回调

    
    fetchRoomInfo
    

    获取房间信息
    void fetchRoomInfo(TUIRoomDefine.GetRoomInfoCallback callback);
    参数:
    参数
    类型
    含义
    callback
    TUIRoomDefine.GetRoomInfoCallback
    获取房间信息回调

    
    updateRoomNameByAdmin
    

    更新房间名称
    void updateRoomNameByAdmin(String roomName, TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    roomName
    String
    房间名称
    callback
    TUIRoomDefine.ActionCallback
    更新操作结果回调

    updateRoomSpeechModeByAdmin

    设置房间管理模式(只有管理员或群主能够调用)
    void updateRoomSpeechModeByAdmin(TUIRoomDefine.SpeechMode mode, TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    mode
    房间模式
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    setLocalVideoView

    设置本地用户视频渲染的视图控件
    void setLocalVideoView(TUIRoomDefine.VideoStreamType streamType,
    TUIVideoView view);
    参数:
    参数
    类型
    含义
    streamType
    本地流类型
    view
    TUIVideoView
    待渲染 view,视频画面将渲染于此 view

    openLocalCamera

    打开本地摄像头,开始视频流采集
    void openLocalCamera(boolean isFront,
    TUIRoomDefine.VideoQuality quality,
    TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    isFront
    boolean
    是否使用前置摄像头
    quality
    视频质量
    callback
    TUIRoomDefine.ActionCallback
    打开摄像头结果回调

    closeLocalCamera

    关闭本地摄像头
    void closeLocalCamera();

    
    updateVideoQuality
    

    设置本地视频的参数
    void updateVideoQuality(TUIRoomDefine.VideoQuality quality);
    参数:
    参数
    类型
    含义
    quality
    视频质量

    startScreenSharing

    开始屏幕共享
    void startScreenSharing();

    stopScreenSharing

    停止屏幕共享
    void stopScreenSharing();

    startPushLocalVideo

    开始向远端推本地视频流
    void startPushLocalVideo();

    stopPushLocalVideo

    停止向远端推本地视频流
    void stopPushLocalVideo();

    openLocalMicrophone

    打开本地麦克风
    void openLocalMicrophone(TUIRoomDefine.AudioQuality quality, TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    quality
    音频质量
    callback
    TUIRoomDefine.ActionCallback
    打开麦克风结果回调

    closeLocalMicrophone

    关闭本地麦克风
    void closeLocalMicrophone();

    updateAudioQuality

    更新本地音频编码质量设置
    void updateAudioQuality(TUIRoomDefine.AudioQuality quality);
    参数:
    参数
    类型
    含义
    quality
    音频质量

    startPushLocalAudio

    开始向远端推本地音频流
    void startPushLocalAudio();

    stopPushLocalAudio

    停止向远端推本地音频流
    void stopPushLocalAudio();

    setRemoteVideoView

    设置远端用户视频渲染的视图控件
    void setRemoteVideoView(String userId,
    TUIRoomDefine.VideoStreamType streamType,
    TUIVideoView view);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    streamType
    用户流类型
    view
    TUIVideoView
    播放远端用户流的 view

    startPlayRemoteVideo

    开始播放远端用户视频流
    void startPlayRemoteVideo(String userId,
    TUIRoomDefine.VideoStreamType streamType,
    TUIRoomDefine.PlayCallback callback);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    streamType
    用户流类型
    callback
    TUIRoomDefine.PlayCallback
    播放结果回调

    stopPlayRemoteVideo

    停止播放远端用户视频流
    void stopPlayRemoteVideo(String userId,TUIRoomDefine.VideoStreamType streamType);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    streamType
    用户流类型

    muteRemoteAudioStream

    将远端用户禁音
    void muteRemoteAudioStream(String userId, boolean isMute);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    isMute
    boolean
    是否禁音

    getUserList

    获取当前房间用户列表,注意该接口一次拉取的用户列表量最大为 100 个
    void getUserList(long nextSequence, TUIRoomDefine.GetUserListCallback callback);
    参数:
    参数
    类型
    含义
    nextSequence
    long
    分页拉取标志,第一次拉取填0,回调成功如果 nextSeq 不为零,需要分页,传入 nextSeq 再次拉取,直至 callback 中 nextSeq 为0
    callback
    TUIRoomDefine.GetUserListCallback
    获取房间用户列表回调

    getUserInfo

    获取用户的详细信息
    void getUserInfo(String userId, TUIRoomEngineDef.GetUserInfoCallback callback);
    参数:
    参数
    类型
    含义
    userId
    String
    根据 userId 获取该用户的详细信息
    callback
    TUIRoomDefine.GetUserInfoCallback
    获取用户信息回调

    changeUserRole

    改变用户的角色,只有管理员或群主能够调用
    void changeUserRole(String userId,
    TUIRoomDefine.Role role,
    TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    role
    用户角色
    callback
    TUIRoomDefine.ActionCallback
    改变角色结果回调

    kickRemoteUserOutOfRoom

    将用户踢出房间,只有管理员或群主能够调用
    void kickRemoteUserOutOfRoom(String userId, TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    userId
    String
    用户 ID
    callback
    TUIRoomDefine.ActionCallback
    操作结果回调

    disableDeviceForAllUserByAdmin

    全体用户媒体设备管理,只有管理员或群主能够调用
    void disableDeviceForAllUserByAdmin(TUIRoomDefine.MediaDevice device,
    boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    device
    设备
    isDisable
    boolean
    是否禁用
    callback
    TUIRoomDefine.ActionCallback
    操作结果回调

    openRemoteDeviceByAdmin

    请求远端用户打开媒体设备,只有管理员或群主能够调用
    TUIRoomDefine.Request openRemoteDeviceByAdmin(String userId,
    TUIRoomDefine.MediaDevice device,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    参数
    类型
    含义
    userId
    String
    用户 ID
    device
    设备
    timeout
    int
    超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调
    callback
    TUIRoomDefine.ActionCallback
    操作结果回调

    closeRemoteDeviceByAdmin

    关闭远端用户媒体设备,只有管理员或群主能够调用
    void closeRemoteDeviceByAdmin(String userId,
    TUIRoomDefine.MediaDevice device,
    TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    device
    设备
    isDisable
    boolean
    是否禁用
    callback
    TUIRoomDefine.ActionCallback
    操作结果回调

    applyToAdminToOpenLocalDevice

    全体用户媒体设备管理lock
    TUIRoomDefine.Request applyToAdminToOpenLocalDevice(TUIRoomDefine.MediaDevice device,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    参数
    类型
    含义
    device
    设备
    timeout
    int
    超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调
    callback
    TUIRoomDefine.ActionCallback
    操作结果回调

    setMaxSeatCount

    设置最大麦位数,仅支持进房前和创建房间时设置
    roomType 为 RoomType.CONFERENCE (教育及会议场景) 时,maxSeatCount 值不做限制;
    roomType 为 RoomType.LIVE_ROOM (直播场景) 时,maxSeatCount 最大限制为 16;
    void setMaxSeatCount(int maxSeatCount, TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    maxSeatCount
    int
    最大麦位数
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    lockSeatByAdmin

    锁定麦位(包括位置锁定,音频状态锁定,视频状态锁定)
    void lockSeatByAdmin(int seatIndex,
    TUIRoomDefine.SeatLockParams lockParams,
    TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    seatIndex
    int
    麦位编号
    lockParams
    锁麦参数
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    getSeatList

    获取麦位列表
    void getSeatList(TUIRoomDefine.GetSeatListCallback callback);
    参数
    类型
    含义
    callback
    TUIRoomDefine.GetSeatListCallback
    获取麦位列表回调

    takeSeat

    本地上麦
    说明:
    会议场景:SPEAK_AFTER_TAKING_SEAT模式需要向主持人或管理员发起申请才允许上麦,其他模式不支持上麦。
    直播场景:FREE_TO_SPEAK模式可以自由上麦,上麦后开麦发言;SPEAK_AFTER_TAKING_SEAT模式需要向主持人或管理员发起申请才允许上麦;其他模式不支持上麦
    TUIRoomDefine.Request takeSeat(int seatIndex,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    参数:
    参数
    类型
    含义
    seatIndex
    int
    麦位编号
    timeout
    int
    超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调
    callback
    TUIRoomDefine.RequestCallback
    调用接口的回调,用于通知请求的回调状态
    Return: 请求体

    leaveSeat

    本地下麦
    void leaveSeat(TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    takeUserOnSeatByAdmin

    主持人/管理员 邀请用户上麦
    TUIRoomDefine.Request takeUserOnSeatByAdmin(int seatIndex,
    String userId,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    参数
    类型
    含义
    seatIndex
    int
    麦位编号
    userId
    String
    用户 ID
    timeout
    int
    超时时间,单位秒,如果设置为 0,SDK 不会做超时检测,也不会触发超时回调
    callback
    TUIRoomDefine.RequestCallback
    调用接口的回调,用于通知请求的回调状态
    Return: 请求体

    kickUserOffSeatByAdmin

    主持人/管理员 将用户下麦
    void kickUserOffSeatByAdmin(int seatIndex, String userId, TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    seatIndex
    int
    麦位编号
    userId
    String
    用户 ID
    callback
    TUIRoomDefine.RequestCallback
    调用接口的回调,用于通知请求的回调状态

    sendTextMessage

    发送文本消息
    void sendTextMessage(String message,
    TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    message
    String
    文本消息内容
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    sendCustomMessage

    发送自定义消息
    void sendCustomMessage(String message,
    TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    message
    String
    自定义消息内容
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    disableSendingMessageByAdmin

    禁用远端用户的发送文本消息能力(只有管理员或群主能够调用)
    void disableSendingMessageByAdmin(String userId,
    boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    userId
    String
    用户 ID
    isDisable
    boolean
    是否禁用
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    disableSendingMessageForAllUser

    禁用所有用户的发送文本消息能力(只有管理员或群主能够调用)
    void disableSendingMessageForAllUser(boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    参数
    类型
    含义
    isDisable
    boolean
    是否禁用
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    cancelRequest

    取消已经发出的请求
    void cancelRequest(String requestId, TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    requestId
    String
    请求 ID
    callback
    TUIRoomDefine.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    responseRemoteRequest

    回复远端用户的请求
    void responseRemoteRequest(String requestId,
    boolean agree,
    TUIRoomDefine.ActionCallback callback);
    参数:
    参数
    类型
    含义
    requestId
    String
    请求 ID
    agree
    boolean
    是否同意
    callback
    TUIRoomEngineDef.ActionCallback
    调用接口的回调,用于通知接口调用的成功或者失败

    getTRTCCloud

    获取TRTCCloud实例
    TRTCCloud getTRTCCloud();

    getDeviceManager

    获取 deviceManager, 可使用 deviceManager 的方法获取设备列表,甚至设备,切换设备等功能。
    TXDeviceManager getDeviceManager();

    getAudioEffectManager

    获取音频管理
    TXAudioEffectManager getAudioEffectManager();

    getBeautyManager

    获取美颜管理对象
    TXBeautyManager getBeautyManager();
    
    
    
    联系我们

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

    技术支持

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

    7x24 电话支持