tencent cloud

Feedback

API Overview

Last updated: 2023-11-16 14:29:38

    TUIRoomKit (UI included Component)

    TUIRoomKit API List

    API
    Description
    init
    Initialize TUIRoomKit Component
    Host creates room
    enterRoom
    Regular member enters room

    TUIRoomKit Event type

    Event
    Description
    Room event callback for creating room
    Entered room callback
    Destroy room callback
    Regular member exits room callback
    Regular member is kicked out of room by host notification
    User account logged in elsewhere, kicked off line
    User UserSig expired, please re-obtain UserSig

    TUIRoomEngine (No UI interface)

    TUIRoomEngine API List

    TUIRoomEngine Static method
    API
    Description
    once
    Listen to TUIRoomEngine ready event.
    Note: All methods except TUIRoomEngine.init must be executed after listening to the TUIRoomEngine ready event and the TUIRoomEngine.init method is executed successfully.
    login
    Login to TUIRoomEngine
    Set the current user's basic information (username, user avatar)
    Get the current user's basic information (username, user avatar)
    logout
    Logout from TUIRoomEngine
    RoomEngine Room Management API
    API
    Description
    Create room
    enterRoom
    Entered room
    Close the room
    exitRoom
    Leave room
    Get room data
    Update the room's name (Only group owner or administrator can call)
    Update the room's speech mode (Only group owner or administrator can call)
    Get the current room user list
    Get user Learn more
    roomEngine Audio Video API
    API
    Description
    Set the view control for local user video rendering
    Open local camera
    Close local camera
    Open local microphone
    Close local microphone
    Update local video codec quality settings
    Update local audio codec quality settings
    Start screen sharing
    End screen sharing
    Start pushing local video
    Stop pushing local video
    Start pushing local audio
    Stop pushing local audio
    Set the view control for remote user video rendering
    Start playing remote user video
    Stop playing remote user video
    Mute remote user
    roomEngine Member Management API
    API
    Description
    Request remote user to open media device
    Participant applies to the host to open the device
    Close remote user's media device
    Cancel the sent request
    Reply to remote user's request
    Change user's role
    Kick user out of the room
    Disable/Enable all users' media devices
    Disable/Enable all users to send messages
    Disable/Enable a user to send messages
    roomEngine Microphone Management API
    API
    Description
    Set room microphone position maximum value
    Get microphone position information
    takeSeat
    Get microphone position
    leaveSeat
    Release microphone position
    Invite others to go live (only room host and administrator can call this method)
    Kick others off the microphone position (only room host and administrator can call this method)
    Lock a microphone position status (only room host and administrator can call 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 the camera device to use
    Set the mic device to use
    Set the speaker device to use
    Get the currently used camera device
    Get the currently used mic device
    Get the currently used speaker device
    Start camera device test
    Stop camera device test
    roomEngine Event Listening API
    API
    Description
    on
    Listen to TUIRoomEvents event
    off
    Cancel listening to TUIRoomEvents event
    roomEngine Other API
    API
    Description
    Get trtcCloud instance
    getTIM
    Get tim instance

    TUIRoomEngine Event Type

    TUIRoomEvent is the Callback Event class corresponding to TUIRoomEngine. You can listen to the Callback Events you are interested in through this callback.
    EVENT
    Description
    Error Event
    Kick out of room event
    User Kicked Offline Event
    User Credential Timeout Event
    Room Dismissed Event
    Room Name Change Event
    Room Microphone Control Mode Change
    All Users' Cameras Disabled in Room Event
    All Users' Microphones Disabled in Room Event
    All Users' Text Message Sending Disabled in Room Event
    Maximum number of microphone slots in the room modification event
    Remote user Entered room event
    Remote user leaving room event
    Role change event
    Video Status change event
    Audio Status change event
    Send message status event
    Volume change event
    Network quality change event
    Mic position list change event
    Kicked off the mic event
    Request received event
    Request cancelled event
    Receive text message event
    Receive custom message event
    Device change event
    Screen sharing stopped event
    When a user uses the built-in browser's stop sharing button to end Screen Sharing, the user will receive the 'onUserScreenCaptureStopped' event to modify the Sharing status.
    
    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