tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API List

    Last updated: 2024-09-10 15:30:52
    Download PDF

      TUIRoomEngine (non-UI API)

      TUIRoomEngine Static Methods

      API
      Description
      once
      Listen for the TUIRoomEngine ready event.
      Note: All methods other than TUIRoomEngine.init must be executed after the TUIRoomEngine ready event is received and the TUIRoomEngine.init method is successfully executed.
      login
      Log in to TUIRoomEngine
      logout
      Log out of TUIRoomEngine
      Set basic information of the current user (user name, user avatar)
      Get basic information of the current user (user name, user avatar)
      Get device manager
      Get audio effect manager
      Get media source mixing manager
      Get video effect plugin manager

      roomEngine Room Management API

      API
      Description
      Create a room
      enterRoom
      Enter a room
      Destroy a room
      exitRoom
      Exit a room
      Fetch room information
      Update room name (Only available to room owners or administrators)
      Update room seat mode (Only available to room owners or administrators)

      roomEngine Audio and Video API

      API
      Description
      Set the HTML element where to play local camera video stream
      Open local camera
      Close local camera
      Start pushing the local video stream to the remote end
      Stop pushing the local video stream to the remote end
      Set local video parameters
      Set local video encoding parameters
      Set the resolution mode of the local video stream
      Open local microphone
      Close local microphone
      Set local audio parameters
      Stop pushing the local audio stream to the remote end
      Start pushing the local audio stream to the remote end
      Set the HTML element where to play the remote video stream
      Start playing the remote user's video stream
      Stop playing the remote user's video stream
      Stop the remote user's audio stream

      roomEngine Screen/Window Sharing API

      API
      Description
      Start screen or window sharing
      Stop screen or window sharing
      Get the screens and windows to be shared
      Select the screen or window to share

      roomEngine Member Management API

      API
      Description
      Get users list
      Get user detail information
      Change user role
      Kick user out of current room
      Cancel a request already sent
      Response to remote use request
      Disable/Enable instant message chat

      roomEngine Seat Management API

      API
      Description
      Get seats information
      Lock a seat (only available to room owner and administrators)
      takeSeat
      Take a seat
      leaveSeat
      Release a seat
      Invite someone else to speak (only available to room owner and administrators)
      Kick someone off the seat (only available to room owner and administrators)
      Get the list of speaking requests

      roomEngine Event Listening API

      API
      Description
      on
      Add TUIRoomEvents event listener
      off
      Remove TUIRoomEvents evnet listener

      roomEngine Malicious API

      API
      Description
      Get TRTCCloud instance
      getTIM
      Get TIM/Chat instance

      Event Name Definition

      TUIRoomEvent is an enum type of all the events supported by TUIRoomEngine.
      EVENT
      Description
      Error event
      Kick out of room event
      Kick off seat event
      Kick off line event
      userSig expired
      Room owner destroying room event
      Room name changed event
      Room information changed event
      Seat mode change event
      Disable/Enable all user microphone event
      Disable/Enable all user instant message sending event
      The maximize seats number change event
      Remote user enter room event
      Remote user leave room event
      User role changed event
      User video stream changed event
      User audio stream changed event
      Disable/Enable a user instant message sending event
      User voice volume changed event
      User network quality changed event
      Seat control enabled/disabled event
      Seats information changed event
      Request received event
      Request processed event
      Request cancelled event
      Device changed event
      Screen sharing stopped 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