tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    Overview

    Last updated: 2024-12-18 15:02:11
    Download PDF

      Overview

      TUIRoomEngine (rtc_room_engine) is a component designed for scenarios involving corporate meetings, webinars, online education, etc., supporting multi-person audio and video conversations. It offers room management, multi-person TRTC interactions, member management, screen sharing, and other meeting control features, and supports various video qualities including standard definition, high definition, and ultra-high definition. By integrating this component, you can add multi-person audio and video conversation features to your application.

      Integration method:

      In your project's pubspec.yaml, add the following code to integrate TUIRoomEngine:
      dependencies:   
          rtc_room_engine: latest version
      Run the following command to install the component:
      flutter pub get

      TUIRoomEngine API List

      TUIRoomEngine API is a no UI interface for multi-person audio and video rooms, you can use these APIs to perform custom encapsulation based on your business needs.
      TUIRoomEngine

      TUIRoomEngine Core Methods

      API
      Description
      Create TUIRoomEngine Instance.
      Destroy TUIRoomEngine Instance.
      login
      Login Interface, you need to initialize user information first to enter the room and perform a series of operations.
      logout
      Logout Interface, which includes proactively leaving the room and destroying resources.
      Set Local Username and Avatar.
      Set Login User Information.
      Obtain Basic Information of Local User Login.
      Set event callbacks.
      Remove event callbacks.

      Room-related proactive interface

      API
      Description
      Create Room.
      Dissolve Room.
      enterRoom
      Enter the room.
      exitRoom
      Leave the room.
      Connect to Other Rooms.
      Disconnect from Other Rooms.
      Obtain room information.
      Update Room Name (only administrators or group owners can invoke).
      Set Room Management Mode (only administrators or group owners can invoke).

      Local User View Rendering, Video Management

      API
      Description
      Set control for local user video rendering.
      Turns the local camera on.
      Turns the local camera off.
      Update local video encoding quality settings.
      Set encoding parameters for the video encoder
      Set the resolution mode for the video encoder
      Enable gravity sensing mode
      Start pushing local video.
      Stop pushing local video.
      Starting Screen Sharing
      End Screen Sharing

      Local User Audio Management

      API
      Description
      Enable the local mic.
      Disable the local mic.
      Update local audio encoding quality settings.
      Stop pushing local audio.
      Start pushing local audio.

      Remote user view rendering, Video Management

      API
      Description
      Set control for remote user video rendering.
      Start playing remote user video.
      Stop playing remote user video.
      Mute remote user.

      Inside the Room User Information

      API
      Description
      Obtain the member list inside the room.
      Obtain member information.

      In-room User Management

      API
      Description
      Modify User Role (only administrators or group owners can invoke).
      Modify User Nickname.
      Remove Remote User from Room (only administrators or group owners can invoke).
      Add a label to a user (only homeowners can call)
      Remove a label from a user (only homeowners can call)
      Get user information in the room based on labels
      Set customized information for members in the room

      User speaking management in the room

      API
      Description
      Control whether all users in the current room can enable audio stream, video stream capture devices. For example: prohibit everyone from turning on the microphone, camera, or screen sharing (currently available only in meeting scenarios, and only administrators or group owners can invoke).
      Request Remote User to Enable Media Devices (only administrators or group owners can invoke).
      Turn Off Remote User Media Devices (only administrators or group owners can invoke).
      Request to Enable Local Media Devices (available for regular users).

      Microphone Position Management within the Rooms

      API
      Description
      Set Maximum Number of Microphones (can only be set before entering or creating a room).
      Get the microphone position list.
      Host/Administrator gets the request list of users applying for the microphone in the room.
      Lock Microphone Position (only administrators or group owners can invoke, including position lock, audio status lock, and video status lock).
      takeSeat
      Apply to join the microphone (no need to apply in free speaking mode).
      leaveSeat
      Apply to leave the microphone (no need to apply in free speaking mode).
      Disconnect Mic
      Host/Administrator invites users to go on stage.
      Host/Administrator removes users from the microphone.

      Signaling Management

      API
      Description
      Cancel Request.
      Reply Request.

      Sending Message

      API
      Description
      Disable the remote user's ability to send text messages (only administrators or group owners can call this).
      Disable all users' ability to send text messages (only administrators or group owners can call this).

      Advanced Features

      API
      Description
      Set beauty filter effect level
      Set brightening filter effect level
      Get plugins
      Get device management class

      Debugging related

      API
      Description
      Calls an experimental API.

      TUIRoomObserver Callback Event

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

      TUIRoomObserver

      Error Callback

      API
      Description
      onError
      Error event callback

      Callback for login status event

      API
      Description
      Kicked offline by another client during terminal login.
      User credentials timeout event.

      Room Event Callback

      API
      Description
      Room name change event.
      All users' microphones in the room have been disabled event.
      All users' cameras in the room have been disabled event.
      All users' screen sharing in the room has been disabled event.
      All users' ability to send text messages in the room has been disabled event.
      Removed from the room event.
      Room dissolved event.
      Room Microphone Mode Change
      Room population changed

      User Event Callback Inside the Room

      API
      Description
      Remote user entered room event.
      Remote user left room event.
      User role changed event.
      User video status changed event.
      Event of User Audio Status Changed
      User volume changed event.
      User text message sending capability changed event.
      User network status changed event.
      Screen sharing ended.

      Room microphone position event callback

      API
      Description
      Maximum number of microphones in room changed event (only in meeting type rooms).
      Microphone position list changed event.
      User removed from microphone event received.

      Request signaling event callback

      API
      Description
      Request message event received.
      Request cancellation event received.
      Received request handled by another administrator/homeowner 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