tencent cloud

Feedback

TUIRoomEngine

Last updated: 2023-10-23 11:32:46

    TUIRoomEngine (No UI Interface)

    TUIRoomEngine API is a No UI Interface for Conference Component, you can use this API to custom encapsulate according to your business needs.

    createInstance

    Create TUIRoomEngine Instance
    static TUIRoomEngine createInstance()
    return:TUIRoomEngine Instance

    destroyInstance

    Destroy TUIRoomEngine Instance
    void destroyInstance()

    login

    Login interface, you need to initialize user information before entering the room and perform a series of operations
    Note:In v1.0.0, this interface is named setup, and in v1.0.1 and above, please use TUIRoomEnine.login to log in to TUIRoomEngine.
    void static login(Context context,
    int sdkAppId,
    String userId,
    String userSig,
    TUIRoomDefine.ActionCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    context
    Context
    Android Context
    sdkAppId
    int
    Get sdkAppId information from Application Info
    userId
    String
    User ID
    userSig
    String
    UserSig
    callback
    TUIRoomDefine.ActionCallback
    API Callback for notifying the success or failure of the interface call

    logout

    Logout interface, there will be actively leave the room operation, destroy resources
    static void logout(TUIRoomDefine.ActionCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    setSelfInfo

    Set local user name and avatar
    static void setSelfInfo(String userName, String avatarURL, TUIRoomObserver.ActionCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    userName
    int
    User Name
    avatarUrl
    String
    User avatar URL address
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    getSelfInfo

    Get the basic information of the local user login
    static TUIRoomDefine.LoginUserInfo getSelfInfo()
    return:the basic information of the local user login

    addObserver

    Add TUIRoomEngine Event Callback
    void addObserver(TUIRoomObserver observer)
    Parameters:
    Parameter
    Type
    Meaning
    observer
    TUIRoomObserver
    TUIRoomEngine Event Callback

    removeObserver

    Remove TUIRoomEngine Event Callback
    void removeObserver(TUIRoomObserver observer)
    Parameter
    Type
    Meaning
    observer
    TUIRoomObserver
    TUIRoomEngine Event Callback

    createRoom

    The host creates a room, and the user who calls createRoom is the owner of the room. When creating a room, you can set the Room ID, room name, and whether the room allows users to join, enable video and audio, send messages, and other functions.
    void createRoom(TUIRoomDefine.RoomInfo roomInfo, TUIRoomDefine.ActionCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    roomInfo
    Room data
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    destroyRoom

    Destroy Room Interface, the room owner must initiate the destruction of the room. After the room is destroyed, it is unavailable for entry.
    void destroyRoom(TUIRoomDefine.ActionCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    enterRoom

    Entered room.
    void enterRoom(String roomId, TUIRoomDefine.GetRoomInfoCallback callback)
    Parameters:
    Parameter
    Type
    Meaning
    roomId
    String
    Room ID
    callback
    TUIRoomDefine.GetRoomInfoCallback
    Get the entered Room data Callback

    exitRoom

    Exit Room Interface, after the user executes Enter Room, they can leave the room through Leave Room.
    void exitRoom(boolean isSyncWaiting, TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    isSyncWaiting
    boolean
    Whether to synchronize leaving the room
    callback
    TUIRoomDefine.ActionCallback
    Leave Room Result Callback

    connectOtherRoom

    Connect to other rooms
    Description:
    Used for live streaming scenario to apply for cross-room streaming
    TUIRoomDefine.Request connectOtherRoom(String roomId,
    String userId,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    roomId
    String
    Room ID
    userId
    String
    User ID
    timeout
    int
    Time
    callback
    TUIRoomDefine.RequestCallback
    Connect to other rooms Callback
    Return:Request body

    disconnectOtherRoom

    Disconnect from other rooms
    Description:
    Used for live streaming scenario to disconnect cross-room streaming
    void disconnectOtherRoom(TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.ActionCallback
    Disconnect with other rooms Connection result Callback

    
    fetchRoomInfo
    

    Get Room data
    void fetchRoomInfo(TUIRoomDefine.GetRoomInfoCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.GetRoomInfoCallback
    Get Room data Callback

    updateRoomNameByAdmin

    Update Room ID
    void updateRoomNameByAdmin(String roomName, TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    roomName
    String
    Room ID
    callback
    TUIRoomDefine.ActionCallback
    Update Operation result Callback

    updateRoomSpeechModeByAdmin

    Set Management mode (only Administrator or Group owner can call)
    void updateRoomSpeechModeByAdmin(TUIRoomDefine.SpeechMode mode, TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    mode
    Management mode
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    setLocalVideoView

    Set Local user Video Rendering View control
    void setLocalVideoView(TUIRoomDefine.VideoStreamType streamType,
    TUIVideoView view);
    Parameters:
    Parameter
    Type
    Meaning
    streamType
    Local streams type
    view
    TUIVideoView
    To be rendered view, Video Rendering on this view

    openLocalCamera

    Open Local Camera, Start Video Capturing
    void openLocalCamera(boolean isFront,
    TUIRoomDefine.VideoQuality quality,
    TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    isFront
    boolean
    Whether to use Front Camera
    quality
    Video Quality
    callback
    TUIRoomDefine.ActionCallback
    Open Camera Operation result Callback

    closeLocalCamera

    Close Local Camera
    void closeLocalCamera();

    updateVideoQuality

    Set Local Video Parameter
    void updateVideoQuality(TUIRoomDefine.VideoQuality quality);
    Parameters:
    Parameter
    Type
    Meaning
    quality
    Video Quality

    startScreenSharing

    Start Screen sharing
    void startScreenSharing();

    stopScreenSharing

    Stop Screen sharing
    void stopScreenSharing();

    startPushLocalVideo

    Start pushing Local Video streams to Remote
    void startPushLocalVideo();

    stopPushLocalVideo

    Stop pushing Local Video streams to Remote
    void stopPushLocalVideo();

    openLocalMicrophone

    Open Local mic
    void openLocalMicrophone(TUIRoomDefine.AudioQuality quality, TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    quality
    Audio Quality
    callback
    TUIRoomDefine.ActionCallback
    Open mic Operation result Callback

    closeLocalMicrophone

    Close Local mic
    void closeLocalMicrophone();

    updateAudioQuality

    Update Local Audio Codec Quality setting
    void updateAudioQuality(TUIRoomDefine.AudioQuality quality);
    Parameters:
    Parameter
    Type
    Meaning
    quality
    Audio Quality

    startPushLocalAudio

    Start pushing Local Audio streams to Remote
    void startPushLocalAudio();

    stopPushLocalAudio

    Stop pushing Local Audio streams to Remote
    void stopPushLocalAudio();

    setRemoteVideoView

    Set Remote user Video Rendering View control
    void setRemoteVideoView(String userId,
    TUIRoomDefine.VideoStreamType streamType,
    TUIVideoView view);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    streamType
    User streams type
    view
    TUIVideoView
    Playback Remote user streams view

    startPlayRemoteVideo

    Start Playback Remote user Video streams
    void startPlayRemoteVideo(String userId,
    TUIRoomDefine.VideoStreamType streamType,
    TUIRoomDefine.PlayCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    streamType
    User streams type
    callback
    TUIRoomDefine.PlayCallback
    Playback Operation result Callback

    stopPlayRemoteVideo

    Stop Playback Remote user Video streams
    void stopPlayRemoteVideo(String userId,TUIRoomDefine.VideoStreamType streamType);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    streamType
    User streams type

    muteRemoteAudioStream

    Mute Remote user
    void muteRemoteAudioStream(String userId, boolean isMute);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    isMute
    boolean
    Whether to mute

    getUserList

    Get current User list in the room, Note that the maximum number of User list fetched by this Interface is 100
    void getUserList(long nextSequence, TUIRoomDefine.GetUserListCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    nextSequence
    long
    Pagination Fetch Flag, fill in 0 for the first Fetch, if the nextSeq in the Callback is not 0, you need to do Pagination, pass in the nextSeq to Fetch again until the nextSeq in the Callback is 0
    callback
    TUIRoomDefine.GetUserListCallback
    Get User list Callback

    getUserInfo

    Get User Learn more
    void getUserInfo(String userId, TUIRoomEngineDef.GetUserInfoCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    Get Learn more of the user by userId
    callback
    TUIRoomDefine.GetUserInfoCallback
    Get User Learn more Callback

    changeUserRole

    Change user Role, only Administrator or Group owner can call
    void changeUserRole(String userId,
    TUIRoomDefine.Role role,
    TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    role
    User Role
    callback
    TUIRoomDefine.ActionCallback
    Change Role Operation result Callback

    kickRemoteUserOutOfRoom

    Kick user out of the room, only Administrator or Group owner can call
    void kickRemoteUserOutOfRoom(String userId, TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    callback
    TUIRoomDefine.ActionCallback
    Operation result Callback

    disableDeviceForAllUserByAdmin

    Manage Media device for all users, only Administrator or Group owner can call
    void disableDeviceForAllUserByAdmin(TUIRoomDefine.MediaDevice device,
    boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    device
    Device
    isDisable
    boolean
    Whether to Disable
    callback
    TUIRoomDefine.ActionCallback
    Operation result Callback

    openRemoteDeviceByAdmin

    Request Remote user to open Media device, only Administrator or Group owner can call
    TUIRoomDefine.Request openRemoteDeviceByAdmin(String userId,
    TUIRoomDefine.MediaDevice device,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    device
    Device
    timeout
    int
    Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback
    callback
    TUIRoomDefine.ActionCallback
    Operation result Callback

    closeRemoteDeviceByAdmin

    Close Remote user Media device, only Administrator or Group owner can call
    void closeRemoteDeviceByAdmin(String userId,
    TUIRoomDefine.MediaDevice device,
    TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    device
    Device
    isDisable
    boolean
    Whether to Disable
    callback
    TUIRoomDefine.ActionCallback
    Operation result Callback

    applyToAdminToOpenLocalDevice

    Lock all users' Media device management
    TUIRoomDefine.Request applyToAdminToOpenLocalDevice(TUIRoomDefine.MediaDevice device,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    Parameter
    Type
    Meaning
    device
    Device
    timeout
    int
    Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback
    callback
    TUIRoomDefine.ActionCallback
    Operation result Callback

    setMaxSeatCount

    Set Maximum number of seats, only supported when entering the room and creating the room
    When roomType is RoomType.CONFERENCE (Education and Conference scene), maxSeatCount value is not limited;
    When roomType is RoomType.LIVE_ROOM (Live broadcast scene), maxSeatCount is limited to 16;
    void setMaxSeatCount(int maxSeatCount, TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    maxSeatCount
    int
    Maximum number of seats
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    lockSeatByAdmin

    Lock seat (including position lock, audio status lock, video status lock)
    void lockSeatByAdmin(int seatIndex,
    TUIRoomDefine.SeatLockParams lockParams,
    TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    seatIndex
    int
    Seat number
    lockParams
    Lock microphone parameter
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    getSeatList

    Get seat list
    void getSeatList(TUIRoomDefine.GetSeatListCallback callback);
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.GetSeatListCallback
    Get seat list Callback

    takeSeat

    Local on microphone
    Explanation:
    Conference scene: SPEAK_AFTER_TAKING_SEAT mode requires an application to the host or administrator to allow on microphone, other modes do not support on microphone.
    Live broadcast scene: FREE_TO_SPEAK mode can freely on microphone, after on microphone, open microphone to speak; SPEAK_AFTER_TAKING_SEAT mode requires an application to the host or administrator to allow on microphone; other modes do not support on microphone.
    TUIRoomDefine.Request takeSeat(int seatIndex,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    seatIndex
    int
    Seat number
    timeout
    int
    Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback
    callback
    TUIRoomDefine.RequestCallback
    Call interface Callback, used to notify the request Callback status
    Return: Request body

    leaveSeat

    Local off microphone
    void leaveSeat(TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    takeUserOnSeatByAdmin

    Host/Administrator Invite User on microphone
    TUIRoomDefine.Request takeUserOnSeatByAdmin(int seatIndex,
    String userId,
    int timeout,
    TUIRoomDefine.RequestCallback callback);
    Parameter
    Type
    Meaning
    seatIndex
    int
    Seat number
    userId
    String
    User ID
    timeout
    int
    Timeout in seconds, if set to 0, SDK will not do timeout detection and will not trigger timeout Callback
    callback
    TUIRoomDefine.RequestCallback
    Call interface Callback, used to notify the request Callback status
    Return: Request body

    kickUserOffSeatByAdmin

    Host/Administrator Take User off microphone
    void kickUserOffSeatByAdmin(int seatIndex, String userId, TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    seatIndex
    int
    Seat number
    userId
    String
    User ID
    callback
    TUIRoomDefine.RequestCallback
    Call interface Callback, used to notify the request Callback status

    sendTextMessage

    Send Text message
    void sendTextMessage(String message,
    TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    message
    String
    Text message Content
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    sendCustomMessage

    Send Custom message
    void sendCustomMessage(String message,
    TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    message
    String
    Custom message Content
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    disableSendingMessageByAdmin

    Disable Remote user's Text message sending Ability (only Administrator or Group owner can call)
    void disableSendingMessageByAdmin(String userId,
    boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    userId
    String
    User ID
    isDisable
    boolean
    Whether to Disable
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    disableSendingMessageForAllUser

    Disable all users' Text message sending Ability (only Administrator or Group owner can call)
    void disableSendingMessageForAllUser(boolean isDisable,
    TUIRoomDefine.ActionCallback callback);
    Parameter
    Type
    Meaning
    isDisable
    boolean
    Whether to Disable
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    cancelRequest

    Cancel sent Request
    void cancelRequest(String requestId, TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    requestId
    String
    Request ID
    callback
    TUIRoomDefine.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    responseRemoteRequest

    Reply to Remote user's Request
    void responseRemoteRequest(String requestId,
    boolean agree,
    TUIRoomDefine.ActionCallback callback);
    Parameters:
    Parameter
    Type
    Meaning
    requestId
    String
    Request ID
    agree
    boolean
    Whether to agree
    callback
    TUIRoomEngineDef.ActionCallback
    Callback of API, used to Notify the Success or Failure of the API call

    getTRTCCloud

    Get TRTCCloud Instance
    TRTCCloud getTRTCCloud();

    getDeviceManager

    Get deviceManager, you can use deviceManager's method to get Device list, even Device, switch Device and other functions.
    TXDeviceManager getDeviceManager();

    getAudioEffectManager

    Get Audio management
    TXAudioEffectManager getAudioEffectManager();

    getBeautyManager

    Get Beauty management object
    TXBeautyManager getBeautyManager();
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support