tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2023-12-18 18:01:32
    Download PDF

      TUIRoomEngine API List

      TUIRoomEngine API is the UI-free interface of the Conference Component, which allows you to customize the encapsulation according to your business needs.
      TUIRoomEngine

      TUIRoomEngine Core Methods

      API
      Description
      init
      Create Instance of TUIRoomEngine.
      login
      Login Interface, you need to initialize user information before entering the room and perform a series of operations.
      logout
      Logout Interface, there will be active room leaving operation and resources destruction.
      Set local user name and avatar.
      Get the basic information of the local user login.
      Set Event Callback.
      Remove Event Callback.

      Active Interface related to the room

      API
      Description
      Create a room.
      Close the room.
      enterRoom
      Entered room.
      exitRoom
      Leave the room.
      Connect to another room.
      Disconnect from another room.
      Get Room data.
      Update Room ID (only administrator or group owner can call).
      Set Mic Control Mode for the room (only administrator or group owner can call).

      Local user view rendering and video management

      API
      Description
      Set the View Control for local user video rendering.
      Open local Camera.
      Close local Camera.
      Update Encoding Quality settings for local video.
      Start pushing local video.
      Stop pushing local video.
      Start Screen Sharing (this interface is only supported on mobile devices).
      Start Screen Sharing (this interface is only supported on Mac OS desktop systems).
      End Screen Sharing.
      Enumerate shareable screens and windows (this interface is only supported on Mac OS systems).
      Select the screen or window to share (this interface is only supported on Mac OS systems).

      Local user audio management

      API
      Description
      Open local mic.
      Close local mic.
      Update local Audio Encoding Quality settings.
      Start pushing local audio.
      Stop pushing local audio.

      Remote user view rendering and video management

      API
      Description
      Set the View Control for remote user video rendering.
      Start Playback of remote user video.
      Stop Playback of remote user video.
      Mute remote user.

      Room user information

      API
      Description
      Get the member list in the room.
      Get member information.

      Room user management

      API
      Description
      Modify user role (only administrator or group owner can call).
      Kick remote user out of the room (only administrator or group owner can call).

      Room user speech management

      API
      Description
      Control the permission status of all users in the current room to open audio streams, video streams, and capture devices, such as: all users are prohibited from opening mics, all users are prohibited from opening cameras, all users are prohibited from opening screen sharing (currently only available in conference scenarios, and only administrators or group owners can call).
      Request remote user to open media device (only administrator or group owner can call).
      Close remote user media device (only administrator or group owner can call).
      Request to open local media device (available for ordinary users).

      Room mic seat management

      API
      Description
      Set the maximum number of mic seats (only supported when entering the room and creating the room).
      Get the list of mic seats.
      Lock the mic seat (only administrator or group owner can call, including position lock, audio status lock, and video status lock).
      takeSeat
      Apply to Go Live (no need to apply in free speech mode).
      leaveSeat
      Apply to leave the mic (no need to apply in free speech mode).
      Host/Administrator invites user to Go Live.
      Host/Administrator kicks user off the mic.

      Signaling management

      API
      Description
      Cancel Request.
      Reply Request.

      Send message

      API
      Description
      Send Text Message.
      Send Custom Message.
      Disable remote user's ability to send text messages (only administrator or group owner can call).
      Disable all users' ability to send text messages (only administrator or group owner can call).

      Advanced features: Get TRTC instance

      API
      Description
      Get native TRTC Device Management class.
      Get native TRTC Sound Effect Class.
      Get native TRTC Beauty Class.
      Get native TRTC Instance Class.
      

      TUIRoomObserver Callback Events

      TUIRoomObserver is the callback event class corresponding to TUIRoomEngine. You can listen to the callback events you need through this callback.
      TUIRoomObserver

      TUIRoomObserver

      Error callback

      API
      Description
      onError
      Error Event Callback.

      Login status event callback

      API
      Description
      Other terminal login is kicked offline.
      User Credential Timeout Event.

      Room event callback

      API
      Description
      Room ID change event.
      All users in the room have their mics disabled event.
      All users in the room have their cameras disabled event.
      All users in the room have their text message sending disabled event.
      Kicked out of the room event.
      Room closed event.
      Room Mic Control Mode changed.

      Room user event callback

      API
      Description
      Remote user entered room event.
      Remote user left the room event.
      User role changed event.
      User video status changed event.
      User audio status changed event.
      User screen capture stopped event.
      User volume change event.
      User text message sending ability changed event.
      User network status change event.

      Room mic seat event callback

      API
      Description
      Maximum mic seat changed event in the room (only effective in conference type rooms).
      Mic seat list changed event.
      Received user kicked off mic event.

      Request signaling event callback

      API
      Description
      Received request message event.
      Received request cancelled event.

      Room message event callback

      API
      Description
      Received normal text message event.
      Received custom message event.
      
      
      Contact Us

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

      Contact Us
      Technical Support

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

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy