tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2024-09-14 15:22:51
    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 the Audio/Video call Component's No UI Interface, you can use this set of API to customize packaging according to your business needs.
      TUIRoomEngine

      TUIRoomEngine Core Methods

      API
      Description
      Create TUIRoomEngine Instance
      Destroy TUIRoomEngine Instance
      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 actively leave room operation, destroy resources
      Set local user name and avatar
      Set login user information
      Get local user basic information
      Set event callback
      Remove event callback

      Room Related Active Interface

      API
      Description
      Create room
      Close the room
      enterRoom
      Entered room
      exitRoom
      Leave room
      Connect to other room
      Disconnect from other room
      Get room data
      Update room name
      Set room management mode (only administrator or group owner can call)

      Local User View Rendering, Video Management

      API
      Description
      Set the view control for local user video rendering
      Open local camera
      Close local camera
      Update local video codec quality settings
      Set the encoding parameters of video encoder
      Set the resolution mode of video encoder
      Enable the gravity sensor
      Start pushing local video
      Stop pushing local video
      Start screen sharing
      Stop screen sharing

      Local User Audio Management

      API
      Description
      Open local microphone
      Close local microphone
      Update local audio codec quality settings
      Mute local audio
      UnMute local audio

      Remote User View Rendering, Video Management

      API
      Description
      Set the view control for remote user video rendering
      Start playing remote user video
      Stop playing 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)
      Add category tags to users (Only Administrator or Group Owner can call)
      Remove category tags to users (Only Administrator or Group Owner can call)
      Get user information in the room based on tags

      Speech Management in Room

      API
      Description
      Control the permission status of whether all users in the current room can open Audio and Video streams capturing devices, such as: Prohibit all from turning on the mic, Prohibit all from turning on the Camera, Prohibit all from turning on Screen Sharing (currently only available in meeting scenes, and only administrators or group owners can invoke).
      Request Remote User to Open Media Device (Only Administrator or Group Owner can call)
      Close Remote User's Media Device (Only Administrator or Group Owner can call)
      Request to Open Local Media Device (Available for Ordinary Users)

      Microphone Seat Management in Room

      API
      Description
      Set Maximum Number of Microphone Seats (Only supported when entering the room and creating the room)
      Get Microphone Seat List
      Lock Microphone Seat (Including Position Lock, Audio State Lock, Video State Lock)
      takeSeat
      Apply to Go Live (Not Required in Free Speech Mode)
      leaveSeat
      Apply to leave the live (Not Required in Free Speech Mode)
      Host/Administrator invites user to go live
      Host/Administrator kicks user off the microphone seat

      Signaling Management

      API
      Description
      Cancel Request
      Reply to Request

      Send Message

      API
      Description
      Send Text Message
      Send Custom Message
      Disable Remote User's Text Message Sending Ability (Only Administrator or Group Owner can call)
      Disable All Users' Text Message Sending Ability (Only Administrator or Group Owner can call) Advanced Feature: Get TRTC Instance

      Advanced Features

      API
      Description
      Switch front/rear camera
      Set beauty level
      Set whiteness level

      Debugging related

      API
      Description
      Call experimental api
      

      TUIRoomObserver Callback Event

      TUIRoomObserver is the Callback Event class corresponding to TUIRoomEngine. You can monitor the Callback Events you need through this Callback.
      TUIRoomObserver

      TUIRoomObserver

      Error Callback

      API
      Description
      onError
      Error Callback Event

      Login Status Event Callback

      API
      Description
      User Kicked Offline Event
      User Credential Timeout Event

      Room Event Callback

      API
      Description
      Room Name Change Event
      All Users' Microphones Disabled in Room Event
      All Users' Cameras Disabled in Room Event
      All Users' Text Message Sending Disabled in Room Event
      Room Dismissed Event
      Kicked Out of Room Event
      Room Microphone Control Mode Change

      Room User Event Callback

      API
      Description
      Remote User Entering Room Event
      Remote User Leaving Room Event
      User Role Change Event
      User Video State Change Event
      User Audio State Change Event
      User Volume Change Event
      User Text Message Sending Ability Change Event
      User Network Status Change Event
      Screen Sharing End Event

      Room Microphone Seat Event Callback

      API
      Description
      Room Maximum Microphone Seat Number Change Event (Only effective in conference type rooms)
      Microphone Seat List Change Event
      Received User Kicked Off Microphone Event

      Request Signaling Event Callback

      API
      Description
      Received Request Message Event
      Received Request Cancellation 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