tencent cloud

Feedback

TUIRoomEngine

Last updated: 2024-11-05 11:40:49

    TUIRoomEngine Introduction

    TUIRoomEngine SDK provides Room Management, Multi-person Tencent Real-Time Communication, Screen Sharing, Member Management, Instant Messaging, and other features.
    Installation Method:
    // Use npm
    npm i @tencentcloud/tuiroom-engine-js --save
    
    // Use pnpm
    pnpm i @tencentcloud/tuiroom-engine-js --save
    
    // Use yarn
    yarn add @tencentcloud/tuiroom-engine-js

    TUIRoomEngine API

    TUIRoomEngine Static Method

    API
    Description
    once
    Listening to the TUIRoomEngine ready Event.
    Note: All methods other than TUIRoomEngine.login must be executed after listening to the TUIRoomEngine ready event and the successful execution of the TUIRoomEngine.login method.
    login
    Login to TUIRoomEngine
    Setting the current user's Basic information (Username, User Avatar)
    Get the current user's Basic information (Username, User Avatar)
    logout
    Logout of TUIRoomEngine

    roomEngine Room Management API

    API
    Description
    Create Room
    enterRoom
    Enter Room
    Destroy Room
    exitRoom
    Exit Room
    Get Room data
    Update Name (Call by Group Owner or Administrator only)
    Update Speaking Mode (Call by Group Owner or Administrator only)
    Get User List
    Learn more about the user

    roomEngine Audio Video API

    API
    Description
    Set Local Stream Rendering Position
    Capturing Local Camera Video streams
    Close Local Camera
    Open Local mic
    Close Local mic
    Set Local Video Parameters
    Set Local Audio Parameters
    Start Screen Sharing
    Stop Screen Sharing
    Start Pushing Local Video streams to Remote
    Stop Pushing Local Video streams to Remote
    Start Pushing Local Audio Stream to Remote
    Stop Pushing Local Audio Stream to Remote
    Set Remote Stream Rendering Area
    Start Playback Remote User Video streams
    Stop Playback Remote User Video streams
    Stop Remote User Audio Stream

    roomEngine Member Management API

    API
    Description
    Request Remote User to Open Media Device
    Participant Apply to Host to Open Device
    Close Remote User Media Device
    Cancel Sent Request
    Reply to Remote User Request
    Change User Role
    Kick Out User from Room
    Disable/Enable All Users' Media Device
    Disallow/Allow All Users to Send Message
    Disallow/Allow Specific User to Send Message

    roomEngine Mic Position Management API

    API
    Description
    Set Room Maximum Value
    Get Mic Position Information
    takeSeat
    Get Mic Position
    leaveSeat
    Release Mic Position
    Invite Others to Go Live (Only Room Host and Administrator can invoke this method)
    Kick Others Off the Mic (Only Room Host and Administrator can invoke this method)
    Lock a Specific Mic Position Status (Only Room Host and Administrator can invoke this method)

    roomEngine Message Sending API

    API
    Description
    Send Text Message
    Send Custom Message

    roomEngine Device Management API

    API
    Description
    Get Camera Device List
    Get Mic Device List
    Get Speaker Device List
    Set to Use Camera
    Set to Use Mic
    Set to Use Speaker
    Get the Currently Used Camera
    Get the Currently Used Mic
    Get the Currently Used Speaker
    Start Camera Test
    Stop Camera Test

    roomEngine Event Listening API

    API
    Description
    on
    Listen to TUIRoomEvents
    off
    Cancel Listening to TUIRoomEvents

    roomEngine Other API

    API
    Description
    Get trtcCloud Instance
    getTIM
    Get tim Instance

    API Details

    once

    Monitor TUIRoomEngine 'ready' Event
    TUIRoomEngine.once('ready', () => {
    const roomEngine = new TUIRoomEngine();
    await TUIRoomEngine.login({
    sdkAppId: 0, // Fill in the sdkAppId you applied for
    userId: '', // Fill in the userId corresponding to your business
    userSig: '', // Fill in the userSig calculated by the server or locally
    });
    await roomEngine.createRoom({
    roomId: '12345', // Enter your Room ID, note that the Room ID is required to be a string type
    name: 'Test Room', // Enter your room name, the default room name is roomId, up to 30 bytes
    roomType: TUIRoomType.kGroup, // Set the room type to TUIRoomType.kGroup type
    });
    });

    login

    Description:
    In version v1.0.0, this interface is named TUIRoomEngine.init, please use TUIRoomEngine.login to log in TUIRoomEngine in v1.0.1 and above versions.
    You must log in to TUIRoomEngine before you can call other methods of TUIRoomEngine and its instances.
    // Login TUIRoomEngine
    await TUIRoomEngine.login({
    sdkAppId: 0, // Fill in the sdkAppId you applied for
    userId: '', // Fill in the userId corresponding to your business
    userSig: '', // Fill in the userSig calculated by the server or locally
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    sdkAppId
    number
    Required
    -
    After clicking Application Management > Create Application in the Tencent Real-Time Communication Console, you can get the sdkAppId information in Application Info.
    userId
    string
    Required
    -
    It is recommended to limit the user ID length to 32 bytes, and only allow uppercase and lowercase English letters (a-zA-Z), numbers (0-9), underscores, and hyphens.
    userSig
    string
    Required
    -
    UserSig signature
    Please refer to UserSig related for the method of calculating userSig.
    tim
    TIM
    Not Required
    -
    If you want to use more capabilities of the Chat SDK while accessing roomEngine, you can pass the created tim instance into TUIRoomEngine. For the creation method of tim instance, please refer to TIM.create.
    Returns Promise<void>

    setSelfInfo

    Set current user Basic information (Username, User avatar)
    // Set current user Username and User avatar
    await TUIRoomEngine.setSelfInfo({
    userName: '', // Enter your New username
    avatarUrl: '', // Enter your New avatar URL
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userName
    string
    Required
    -
    User Name
    avatarUrl
    string
    Required
    -
    User avatar
    Returns Promise<void>

    getSelfInfo

    Get current user Basic information (Username, User avatar)
    // Get current user Username and User avatar
    const loginUserInfo = await TUIRoomEngine.getSelfInfo();
    Returns Promise<TUILoginUserInfo> loginUserInfo

    logout

    Description:
    Interface since v1.0.1 Version support.
    Logout TUIRoomEngine
    // Logout TUIRoomEngine
    await TUIRoomEngine.logout();
    Returns Promise<void>

    createRoom

    Host creates room, Call createRoom User is the room owner. When creating a room, you can set Room ID, Room name, Room type, Speaking mode, Whether to allow users to join and enable audio and video, Send message and other functions.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.createRoom({
    roomId: '12345', // Enter your Room ID, note that the Room ID must be a string type
    roomName: 'Test Room', // Enter your Room Name, the default Room Name is roomId, with a maximum length of 30 bytes
    roomType: TUIRoomType.kConference, // Set the Room Type to TUIRoomType.kConference
    speechMode: TUISpeechMode.kFreeToSpeak, // Set the speech mode to free speech mode
    isMicrophoneDisableForAllUser: false, // Allow users to turn on their mic when joining the room
    isCameraDisableForAllUser: false, // Allow users to turn on their Camera when joining the room
    isMessageDisableForAllUser: false, // Allow users to send messages when joining the room
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    roomId
    string
    Required
    -
    Room ID, roomId has a length limit of 64 bytes and only supports the following character sets:
    English letters (a-zA-Z)
    Numbers (0-9)
    Space ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
    roomName
    string
    Optional
    roomId
    Room Name, default value is roomId, cannot be an empty string
    roomType
    Optional
    TUIRoomType.kConference
    Room Type
    Office collaboration, medical consultation, remote conference, educational scene, roomType is set to TUIRoomType.kConference
    E-commerce live broadcast, audio chat room scene, roomType is set to TUIRoomType.kLivingRoom
    speechMode
    Optional
    TUISpeechMode.kFreeToSpeak
    Speech mode in the room
    For TUIRoomType.kConference (education and conference scenes):
    Set speechMode to TUISpeechMode.kFreeToSpeak, users can turn on their Camera and mic by default when entering the room
    Set speechMode to TUISpeechMode.kApplyToSpeak, users do not turn on their Camera and mic by default when entering the room, and need to apply to the host to turn on their Camera or mic. TUISpeechMode.kFreeToSpeak and TUISpeechMode.kApplyToSpeak modes can be switched
    Set speechMode to TUISpeechMode.kSpeakAfterTakingSeat, users need to call the takeSeat interface to get permission to turn on their Camera and mic after entering the room
    For TUIRoomType.kLivingRoom (live broadcast scene):
    Set speechMode to TUISpeechMode.kFreeToSpeak, no need for host approval to Go Live
    Set speechMode to TUISpeechMode.kSpeakAfterTakingSeat, host approval is required to Go Live
    TUISpeechMode.kFreeToSpeak and TUISpeechMode.kSpeakAfterTakingSeat modes can be switched
    isMicrophoneDisableForAllUser
    boolean
    Optional
    false
    Enable mute all by default, do not enable mute all by default
    isCameraDisableForAllUser
    boolean
    Optional
    false
    Enable disable all drawings by default, do not enable disable all drawings by default
    isMessageDisableForAllUser
    boolean
    Optional
    false
    Allow members to send messages, do not prohibit by default
    maxSeatCount
    number
    Optional
    -
    Maximum number of microphone seats
    For TUIRoomType.kConference (education and conference scenes), there is no limit on the value of maxSeatCount
    For TUIRoomType.kLivingRoom (live broadcast scene), the maximum limit of maxSeatCount is 16
    enableCDNStreaming
    boolean
    Optional
    false
    Enable CDNs live stream
    cdnStreamDomain
    string
    Optional
    ''
    Push domain
    Returns Promise<void>

    enterRoom

    Entered room interface
    const roomEngine = new TUIRoomEngine();
    const roomInfo = await roomEngine.enterRoom({
    roomId: '12345',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    roomId
    string
    Required
    -
    Room ID
    Returns Promise<TUIRoomInfo> roomInfo
    This interface returns the current Room data

    destroyRoom

    Close the room interface, the room must be closed by the room owner, and the room cannot be entered after it is closed.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.destroyRoom();
    Returns Promise<void>

    exitRoom

    Leave the room interface, users can leave the room through exitRoom after executing enterRoom.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.exitRoom();
    Returns Promise<void>

    fetchRoomInfo

    Get Room information
    const roomEngine = new TUIRoomEngine();
    const roomInfo = roomEngine.fetchRoomInfo();
    Returns:Promise<TUIRoomInfo> roomInfo

    updateRoomNameByAdmin

    Update the current room's name (only group owner or admin can invoke)
    const roomEngine = new TUIRoomEngine();
    await roomEngine.createRoom({ roomId: '12345' });
    await roomEngine.updateRoomNameByAdmin({ roomName: 'NewName' });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    roomName
    string
    Required
    -
    Update the room's name, with the requirement that roomName is not an empty string

    updateRoomSpeechModeByAdmin

    Update the room's speaking mode (only group owner or admin can invoke)
    const roomEngine = new TUIRoomEngine();
    await roomEngine.createRoom({ roomId: '12345' });
    await roomEngine.updateRoomSpeechModeByAdmin({
    speechMode: TUISpeechMode.kSpeakAfterTakingSeat // Update to Go Live Speaking mode
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    speechMode
    TUISpeechMode
    Required
    -
    Update the room's speaking mode

    getUserList

    Get the current room's user list, note that the maximum number of user lists fetched by this interface is 100
    const roomEngine = new TUIRoomEngine();
    const userList = [];
    let result;
    do {
    result = await globalProperties.roomEngine.getUserList();
    userList.push(...result.userInfoList);
    } while (result.nextSequence !== 0)
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    nextSequence
    number
    Optional
    0
    Offset, default is to start fetching users from 0
    Returns:Promise<Array> result
    result.nextSequence is the offset for fetching group users next time, if result.nextSequence is 0, it means that all userList have been fetched
    result.userInfoList is the userList fetched this time

    getUserInfo

    Get the detailed information of the user
    const roomEngine = new TUIRoomEngine();
    const userList = [];
    const userInfo = await roomEngine.getUserInfo({
    userId: 'user_12345',
    });
    
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    Get the detailed information of the user according to userId
    Returns:Promise<Array<TUIUserInfo>> userInfoList
    This interface returns the user information of the specified user

    setLocalVideoView

    Set the rendering position of the local stream
    const roomEngine = new TUIRoomEngine();
    // Set the playback area of the local camera stream to the div element with id 'preview-camera'
    await roomEngine.setLocalVideoView({
    streamType: TUIVideoStreamType.kCameraStream,
    view: 'preview-camera',
    });
    // Set the playback area of the local screen sharing stream to the div element with id 'preview-screen'
    await roomEngine.setLocalVideoView({
    streamType: TUIVideoStreamType.kScreenStream,
    view: 'preview-screen',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    streamType
    Required
    -
    Local stream type
    view
    string
    Required
    -
    The id of the div element corresponding to the streamType
    Returns:Promise<void>

    openLocalCamera

    Open the local camera and start capturing video streams
    const roomEngine = new TUIRoomEngine();
    await roomEngine.setLocalVideoView({
    streamType: TUIVideoStreamType.kCameraStream,
    view: 'preview-camera',
    });
    await roomEngine.openLocalCamera();
    Returns:Promise<void>

    closeLocalCamera

    Close the local camera
    const roomEngine = new TUIRoomEngine();
    await roomEngine.closeLocalCamera();
    Returns:Promise<void>

    openLocalMicrophone

    Open the local mic and start capturing audio streams
    const roomEngine = new TUIRoomEngine();
    await roomEngine.openLocalMicrophone();
    Returns:Promise<void>

    closeLocalMicrophone

    Close the local mic
    const roomEngine = new TUIRoomEngine();
    await roomEngine.closeLocalMicrophone();
    Returns:Promise<void>

    updateVideoQuality

    Set the codec parameters of the local video stream, default is TUIVideoProfile.kVideoQuality_720P
    const roomEngine = new TUIRoomEngine();
    await roomEngine.updateVideoQuality({
    quality: TUIVideoQuality.kVideoQuality_540p,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    quality
    Required
    -
    Clear TUIVideoProfile.kVideoQuality_360P
    SD TUIVideoProfile.kVideoQuality_540P
    HD TUIVideoProfile.kVideoQuality_720P
    Full HD TUIVideoProfile.kVideoQuality_1080P
    Returns:Promise<void>

    updateAudioQuality

    Set Local Audio Parameters
    Note:
    This method needs to be set before openLocalMicrophone, otherwise it will not take effect.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.setLocalAudioProfile({
    audioProfile: TUIAudioProfile.kAudioProfileSpeech,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    audioProfile
    Required
    -
    TUIAudioProfile.kAudioProfileSpeech: Speech Mode; Sample rate: 16k
    TUIAudioProfile.kAudioProfileDefault: Standard Mode (or Default Mode); Sample rate: 48k
    TUIAudioProfile.kAudioProfileMusic: Music Mode; Sample rate: 48k
    Returns:Promise<void>

    startScreenSharing

    Start Screen Sharing
    const roomEngine = new TUIRoomEngine();
    // Set the playback area of the local screen sharing stream to the div element with id 'preview-screen', which can be unset
    await roomEngine.setLocalRenderView({
    streamType: TUIVideoStreamType.kScreenStream,
    view: 'preview-screen',
    });
    // example 1: Start Screen Sharing
    await roomEngine.startScreenSharing();
    // example 2: Start Screen Sharing(Capturing System Audio)
    await roomEngine.startScreenSharing({ screenAudio: true });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    screenAudio
    boolean
    Optional
    false
    Whether web screen sharing can optionally share system sound, screenAudio default value is false
    Returns:Promise<void>

    stopScreenSharing

    Stop Screen Sharing
    const roomEngine = new TUIRoomEngine();
    await roomEngine.stopScreenSharing();
    Returns:Promise<void>

    startPushLocalVideo

    After entering the room, the local video stream will be pushed to the remote by default. This interface is used to re-push the local video stream to the remote after stopping the push.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.startPushLocalVideo();
    Returns:Promise<void>

    stopPushLocalVideo

    Stop Pushing Local Video Stream to Remote
    const roomEngine = new TUIRoomEngine();
    await roomEngine.stopPushLocalVideo();
    Returns:Promise<void>

    startPushLocalAudio

    After entering the room, the local audio stream will be pushed to the remote by default. This interface is used to re-push the local audio stream to the remote after stopping the push.
    const roomEngine = new TUIRoomEngine();
    await roomEngine.startPushLocalAudio();
    Returns:Promise<void>

    stopPushLocalAudio

    Stop Pushing Local Audio Stream to Remote
    const roomEngine = new TUIRoomEngine();
    await roomEngine.stopPushLocalAudio();
    Returns:Promise<void>

    setRemoteVideoView

    Set Remote Stream Rendering Area
    const roomEngine = new TUIRoomEngine();
    
    // Set the remote user's video stream to play in the area with id 'remote_preview_camera'
    await roomEngine.setRemoteVideoView({
    userId: 'user_1234',
    streamType: TUIVideoStreamType.kCameraStream,
    view: 'remote_preview_camera',
    });
    // Set the remote user's screen sharing stream to play in the area with id 'remote_preview_screen'
    await roomEngine.setRemoteVideoView({
    userId: 'user_1234',
    streamType: TUIVideoStreamType.kScreenStream,
    view: 'remote_preview_screen',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    streamType
    Required
    -
    User Stream Type
    view
    string
    Required
    -
    The id of the div element playing the remote user's stream
    Returns:Promise<void>

    startPlayRemoteVideo

    Start Playback of Remote User Video Stream
    const roomEngine = new TUIRoomEngine();
    await roomEngine.startPlayRemoteVideo({
    userId: 'user_1234',
    streamType: TUIVideoStreamType.kCameraStream,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    streamType
    Required
    -
    User Stream Type
    TUIVideoStreamType.kCameraStream Video Stream
    TUIVideoStreamType.kScreenStream Screen Sharing Stream
    TUIVideoStreamType.kCameraStreamLow Low Definition Video Stream
    Returns:Promise<void>

    stopPlayRemoteVideo

    Stop Playback of Remote User Video Stream
    const roomEngine = new TUIRoomEngine();
    await roomEngine.stopPlayRemoteVideo({
    userId: 'user_1234',
    streamType: TUIVideoStreamType.kCameraStream,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    streamType
    Required
    -
    User Stream Type
    TUIVideoStreamType.kCameraStream Video Stream
    TUIVideoStreamType.kScreenStream Screen Sharing Stream
    TUIVideoStreamType.kCameraStreamLow Low Definition Video Stream
    Returns:Promise<void>

    muteRemoteAudioStream

    Stop Remote User's Audio Stream
    const roomEngine = new TUIRoomEngine();
    await roomEngine.muteRemoteAudioStream({
    userId: 'user_1234',
    isMute: true,
    });
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    isMute
    boolean
    Required
    -
    Whether to Stop Remote User's Audio

    openRemoteDeviceByAdmin

    Request Remote User to Open Media Device
    const roomEngine = new TUIRoomEngine();
    const requestId = roomEngine.openRemoteDeviceByAdmin({
    userId: 'user_1234',
    device: TUIMediaDevice.kMicrophone //The requested device is a mic
    timeout: 0,
    requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
    switch (requestCallbackType) {
    case TUIRequestCallbackType.kRequestAccepted:
    // Request Accepted
    break;
    case TUIRequestCallbackType.kRequestRejected:
    // Request Rejected
    break;
    case TUIRequestCallbackType.kRequestCancelled:
    // Request Canceled
    break;
    case TUIRequestCallbackType.kRequestTimeout:
    // Request Timeout
    break;
    case TUIRequestCallbackType.kRequestError:
    // Request Error
    break;
    default:
    break;
    }
    },
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    device
    TUIMediaDevice
    Required
    -
    Media Device Type (Camera/Mic/Screen Sharing)
    timeout
    number
    Required
    -
    Timeout Time. If timeout is set to 0, there is no timeout time
    requestCallback
    Function
    Required
    Empty Function
    Request Callback, used to notify the initiator of the request being accepted/rejected/canceled/timeout/error
    Returns:Promise<string> requestId
    This interface returns requestId, users can use this requestId to call cancelRequest interface to cancel the request.
    Description:
    In v1.0.2 and above, the requestId returned by this interface is of type string; in v1.0.0 and v1.0.1, the requestId returned by this interface is of type number;

    applyToAdminToOpenLocalDevice

    Participant applies to the host to open the device
    const roomEngine = new TUIRoomEngine();
    const requestId = roomEngine.applyToAdminToOpenLocalDevice({
    device: TUIMediaDevice.kMicrophone //The requested device is a mic
    timeout: 0,
    requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
    switch (requestCallbackType) {
    case TUIRequestCallbackType.kRequestAccepted:
    // Request Accepted
    break;
    case TUIRequestCallbackType.kRequestRejected:
    // Request Rejected
    break;
    case TUIRequestCallbackType.kRequestCancelled:
    // Request Canceled
    break;
    case TUIRequestCallbackType.kRequestTimeout:
    // Request Timeout
    break;
    case TUIRequestCallbackType.kRequestError:
    // Request Error
    break;
    default:
    break;
    }
    },
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    device
    TUIMediaDevice
    Required
    -
    Media Device Type (Camera/Mic/Screen Sharing)
    timeout
    number
    Required
    -
    Timeout Time. If timeout is set to 0, there is no timeout time
    requestCallback
    Function
    Optional
    Empty Function
    Request Callback, used to notify the initiator of the request being accepted/rejected/canceled/timeout/error
    Returns:Promise<string> requestId
    This interface returns requestId, users can use this requestId to call cancelRequest interface to cancel the request

    closeRemoteDeviceByAdmin

    Close Remote User Media Device
    const roomEngine = new TUIRoomEngine();
    await roomEngine.closeRemoteDeviceByAdmin({
    userId: 'user_1234',
    device: TUIMediaDevice.kMicrophone, //Close mic
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    device
    TUIMediaDevice
    Required
    -
    Media Device Type (Camera/Mic/Screen Sharing)
    Returns:Promise<void>

    cancelRequest

    Cancel Already Sent Request
    const roomEngine = new TUIRoomEngine();
    await roomEngine.cancelRequest({
    requestId: '', // Please use Actual requestId
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    requestId
    string
    Required
    -
    Request ID
    Returns:Promise<void>
    Note:
    In v1.0.2 and above, the requestId returned by this interface is of type string; in v1.0.0 and v1.0.1, the requestId returned by this interface is of type number;

    responseRemoteRequest

    Reply to Remote User's Request
    const roomEngine = new TUIRoomEngine();
    // Agree to Remote User's Request
    await roomEngine.responseRemoteRequest({
    requestId: '', // Please use Actual requestId
    agree: true,
    });
    // Reject Remote User's Request
    await roomEngine.responseRemoteRequest({
    requestId: '', // Please use Actual requestId
    agree: false,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    requestId
    string
    Required
    -
    Request ID
    agree
    boolean
    Required
    -
    Whether to Agree
    Returns:Promise<void>
    Note:
    In v1.0.2 and above, the requestId returned by this interface is of type string; in v1.0.0 and v1.0.1, the requestId returned by this interface is of type number;

    disableDeviceForAllUserByAdmin

    Prohibit/Allow All Users to Open Media Device (This Interface is invalid for Room Owner and Administrator)
    // Example 1: Prohibit All Users to Open Mic
    await roomEngine.disableDeviceForAllUserByAdmin({
    device: TUIMediaDevice.kMicrophone,
    isDisable: true,
    })
    // Example 2: Allow All Users to Open Mic
    await roomEngine.disableDeviceForAllUserByAdmin({
    device: TUIMediaDevice.kMicrophone,
    isDisable: false,
    })
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    device
    TUIMediaDevice
    Required
    -
    Disabled Media Device Type (Camera/Mic/Screen Sharing)
    isDisable
    boolean
    Required
    -
    Whether it is Prohibited
    Returns:Promise<void>

    disableSendingMessageForAllUser

    Whether All Users are Allowed to Send Messages (This Interface is invalid for Room Owner and Administrator)
    await roomEngine.disableSendingMessageForAllUser({
    isDisable: true,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    isDisable
    boolean
    Required
    -
    Whether it is Disabled
    Returns:Promise<void>

    disableSendingMessageByAdmin

    Whether Specific User is Allowed to Send Messages
    await roomEngine.disableSendingMessageByAdmin({
    userId: 'user_1234',
    isDisable: true,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    isDisable
    boolean
    Required
    -
    Whether it is Disabled
    Returns:Promise<void>

    changeUserRole

    Change User's Role (Only the Host can call this Interface)
    const roomEngine = new TUIRoomEngine();
    
    // Transfer the Room to User user_1234
    await roomEngine.changeUserRole({
    userId: 'user_1234',
    role: TUIRole.kRoomOwner,
    });
    
    // Set user_1234 as Room Administrator
    await roomEngine.changeUserRole({
    userId: 'user_1234',
    userRole: TUIRole.kAdministrator,
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    userRole
    TUIRole
    Required
    -
    User Role
    Host TUIRole.kRoomOwner
    Administrator TUIRole.kAdministrator
    General Member TUIRole.kGeneralUser
    Returns:Promise<void>

    kickRemoteUserOutOfRoom

    Kick Out User from Room (Only Host and Administrator can call this Interface)
    const roomEngine = new TUIRoomEngine();
    await roomEngine.kickRemoteUserOutOfRoom({
    userId: 'user_1234',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    userId
    string
    Required
    -
    User ID
    Returns:Promise<void>

    setMaxSeatCount

    Set Room Seat Maximum Value
    When roomType is TUIRoomType.kConference (Education and Conference Scene), maxSeatCount value is not limited;
    When roomType is TUIRoomType.kLivingRoom (Live Scene), maxSeatCount is limited to 16;
    const roomEngine = new TUIRoomEngine();
    await roomEngine.createRoom({ roomId: '12345' });
    await roomEngine.setMaxSeatCount({ maxSeatCount: 16 })
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    maxSeatCount
    number
    Required
    -
    Set Room Seat Maximum Value
    Returns:Promise<void>

    getSeatList

    Get Seat List
    const roomEngine = new TUIRoomEngine();
    const seatList = await roomEngine.getSeatList();
    Returns:Promise<TUISeatInfo[]> seatList
    seatList for the Current Room's All Seat List

    takeSeat

    Mic-off Users can call takeSeat to become Mic-on Users, only Mic-on Users can Publish Local stream.
    When roomInfo.roomType is TUIRoomType.kConference and roomInfo.speechMode is TUISpeechMode.kSpeakAfterTakingSeat, General Users need to Wait for the Host/Administrator's Agreement to become Mic-on Users after calling takeSeat method.
    When roomInfo.roomType is TUIRoomType.kLivingRoom and roomInfo.speechMode is TUISpeechMode.kFreeToSpeak, General Users become Mic-on Users after calling takeSeat method Successfully.
    Host & Administrator become Mic-on Users after calling takeSeat Successfully.
    Changes of Mic-on Users are Notified to All Users through TUIRoomEvents.onSeatListChanged.
    const roomEngine = new TUIRoomEngine();
    // Scenario 1: Host/Administrator Go Live
    // Scenario 2: When roomInfo.roomType is TUIRoomType.kConference
    // and roomInfo.speechMode is TUISpeechMode.kSpeakAfterTakingSeat, General Users Go Live
    await roomEngine.takeSeat({
    seatIndex: -1,
    timeout: 0,
    });
    // Scenario 3: When roomInfo.enableSeatControl is true, General Users Go Live
    const requestId = await roomEngine.instance?.takeSeat({
    seatIndex: -1,
    timeout: 0,
    requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
    switch (requestCallbackType) {
    case TUIRequestCallbackType.kRequestAccepted:
    // Request Accepted
    break;
    case TUIRequestCallbackType.kRequestRejected:
    // Request Rejected
    break;
    case TUIRequestCallbackType.kRequestCancelled:
    // Request Canceled
    break;
    case TUIRequestCallbackType.kRequestTimeout:
    // Request Timeout
    break;
    case TUIRequestCallbackType.kRequestError:
    // Request Error
    break;
    default:
    break;
    }
    },
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    seatIndex
    number
    Required
    -
    Seat index, set to -1 when there is No Serial Number
    timeout
    number
    Required
    -
    Timeout. If timeout is set to 0, there is no Timeout
    requestCallback
    Function
    Optional
    Empty Function
    Callback, used to Notify Initiator of Request being Accepted/Rejected/Cancelled/Timeout/Error
    Returns:Promise<string> requestId
    When roomInfo.enableSeatControl is true, General Users call this Interface to return requestId, General Users can use this requestId to call cancelRequest Interface to cancel Go Live Request。
    Note:
    In v1.0.2 and above, the requestId returned by this interface is of type string; in v1.0.0 and v1.0.1, the requestId returned by this interface is of type number;

    leaveSeat

    Release Seat
    const roomEngine = new TUIRoomEngine();
    await roomEngine.leaveSeat();
    Returns:Promise<void>

    takeUserOnSeatByAdmin

    Invite Others to Go Live
    const roomEngine = new TUIRoomEngine();
    const requestId = roomEngine.takeUserOnSeatByAdmin({
    seatIndex: 0,
    userId: 'user_1234',
    timeout: 0,
    requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
    switch (requestCallbackType) {
    case TUIRequestCallbackType.kRequestAccepted:
    // Request Accepted
    break;
    case TUIRequestCallbackType.kRequestRejected:
    // Request Rejected
    break;
    case TUIRequestCallbackType.kRequestCancelled:
    // Request Canceled
    break;
    case TUIRequestCallbackType.kRequestTimeout:
    // Request Timeout
    break;
    case TUIRequestCallbackType.kRequestError:
    // Request Error
    break;
    default:
    break;
    }
    },
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    seatIndex
    number
    Required
    -
    Seat index
    userId
    string
    Required
    -
    User ID
    timeout
    number
    Required
    -
    Timeout. If timeout is set to 0, there is no Timeout
    requestCallback
    Function
    Optional
    Empty Function
    Callback, used to Notify Initiator of Request being Accepted/Rejected/Cancelled/Timeout/Error
    Returns:Promise<string> requestId
    This Interface returns requestId, Users can use this requestId to call cancelRequest Interface to cancel Request
    Note:
    In v1.0.2 and above, the requestId returned by this interface is of type string; in v1.0.0 and v1.0.1, the requestId returned by this interface is of type number

    kickUserOffSeatByAdmin

    Ask others to get off the mic
    const roomEngine = new TUIRoomEngine();
    const requestId = await roomEngine.kickUserOffSeatByAdmin({
    seatIndex: 0,
    userId: 'user_1234',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    seatIndex
    number
    Required
    -
    Seat index
    userId
    string
    Required
    -
    User ID
    Returns:Promise<void>

    lockSeatByAdmin

    Lock a certain mic position status (Only the room host and administrator can call this method)
    const roomEngine = new TUIRoomEngine();
    await roomEngine.lockSeatByAdmin({
    seatIndex: 0,
    lockParams: {
    lockSeat: true,
    lockVideo: true,
    lockAudio: true,
    },
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    seatIndex
    number
    Required
    -
    Mic position index
    lockParams
    TUISeatLockParams
    Required
    -
    Lock mic parameter
    Returns:Promise<void>

    sendTextMessage

    Send text message
    const roomEngine = new TUIRoomEngine();
    await roomEngine.sendTextMessage({
    messageText: 'hello, everyone',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    messageText
    string
    Required
    -
    Text message content
    Returns:Promise<void>

    sendCustomMessage

    Send custom message
    const roomEngine = new TUIRoomEngine();
    await roomEngine.sendCustomMessage({
    messageText: '{ data:'', description: ''}',
    });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    messageText
    string
    Required
    -
    Custom message content
    Returns:Promise<void>

    getCameraDevicesList

    Get camera device list
    const roomEngine = new TUIRoomEngine();
    const cameraList = await roomEngine.getCameraDevicesList();
    for (i = 0; i < cameraList.length; i++) {
    var camera = cameraList[i];
    console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
    }
    Returns: Promise<TRTCDeviceInfo[]> cameraList

    getMicDevicesList

    Get mic device list
    const roomEngine = new TUIRoomEngine();
    const micList = await roomEngine.getMicDevicesList();
    for (i = 0; i < micList.length; i++) {
    var mic = micList[i];
    console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
    }
    Returns: Promise<TRTCDeviceInfo[]> micList

    getSpeakerDevicesList

    Get speaker device list
    const roomEngine = new TUIRoomEngine();
    const speakerList = await roomEngine.getSpeakerDevicesList();
    for (i = 0; i < speakerList.length; i++) {
    var speaker = speakerList[i];
    console.info("speaker deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
    }
    Returns: Promise<TRTCDeviceInfo[]> speakerList

    setCurrentCameraDevice

    Set the camera device to be used
    const roomEngine = new TUIRoomEngine();
    await roomEngine.setCurrentCameraDevice({ deviceId: '' });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    deviceId
    string
    Required
    -
    Device ID obtained from getCameraDevicesList
    Returns:void

    setCurrentMicDevice

    Set the mic device to be used
    const roomEngine = new TUIRoomEngine();
    await roomEngine.setCurrentMicDevice({ deviceId: '' });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    deviceId
    string
    Required
    -
    Device ID obtained from getMicDevicesList
    Returns:void

    setCurrentSpeakerDevice

    Set the speaker device to be used
    const roomEngine = new TUIRoomEngine();
    await roomEngine.setCurrentSpeakerDevice({ deviceId: '' });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    deviceId
    string
    Required
    -
    Device ID obtained from getSpeakerDevicesList
    Returns:void

    getCurrentCameraDevice

    Get the currently used camera device
    const roomEngine = new TUIRoomEngine();
    const currentCameraDevice = roomEngine.getCurrentCameraDevice();
    Returns:TRTCDeviceInfo
    Device information, can get device ID and device name

    getCurrentMicDevice

    Get the currently used mic device
    const roomEngine = new TUIRoomEngine();
    const currentMicDevice = roomEngine.getCurrentMicDevice();
    Returns:TRTCDeviceInfo
    Device information, can get device ID and device name

    getCurrentSpeakerDevice

    Get the currently used speaker device
    const roomEngine = new TUIRoomEngine();
    const currentSpeakerDevice = roomEngine.getCurrentSpeakerDevice();
    Returns:TRTCDeviceInfo
    Device information, can get device ID and device name

    startCameraDeviceTest

    Start camera test
    const roomEngine = new TUIRoomEngine();
    await roomEngine.startCameraDeviceTest({ view: 'test-preview' });
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    view
    string
    Required
    -
    Display the video area of the camera test, the input view is the Id of the div element carrying the preview screen
    Returns:Promise<void>

    stopCameraDeviceTest

    Stop camera test
    const roomEngine = new TUIRoomEngine();
    await roomEngine.stopCameraDeviceTest();
    Returns:Promise<void>

    on

    Listen to roomEngine events
    const roomEngine = new TUIRoomEngine();
    roomEngine.on(event, func);
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    event
    Required
    -
    TUIRoomEngine event list
    func
    Function
    Required
    -
    Event callback function
    Returns:void

    off

    Cancel listening to roomEngine events
    const roomEngine = new TUIRoomEngine();
    roomEngine.off(event, func);
    Parameter:
    Parameter
    Type
    Description
    Default Value
    Meaning
    event
    Required
    -
    TUIRoomEngine event list
    func
    Function
    Required
    -
    Event callback function
    Returns:void

    getTRTCCloud

    Get trtcCloud instance, for web-side trtcCloud capabilities, please check: TRTCCloud API documentation
    const roomEngine = new TUIRoomEngine();
    const trtcCloud = roomEngine.getTRTCCloud();
    Returns:TRTCCloud

    getTIM

    Get tim instance, for web-side tim capabilities, please check: IM API documentation
    const roomEngine = new TUIRoomEngine();
    const trtcCloud = roomEngine.getTIM();
    Returns:TIM
    
    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