tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2024-09-24 17:31:07
    Download PDF
      API OVERVIEW

      Creating instances and event callback.

      FuncList
      DESC
      Destroy the TUIRoomEngine instance (singleton mode)
      After creating a TUIRoomEngine instance, you should login with sdkAppId, userId and userSig then you can call TUIRoomEngine instance and other function.
      Log out of your account. If you are in the room, there will be active leaving room and destroying resource operations.
      Update user name and avatar for logged-in user.
      Return the basic information of the logged-in user, including nickname and avatar.
      Update user basic information for logged-in user.
      Set event observer.
      Remove event observer.

      Room APIs.

      FuncList
      DESC
      Create a room.
      Dismiss the room.
      Enter a room.
      Enter a room.
      Enter a room.
      Exit the room.
      Fetch room information.
      Fetch room information.
      Update room name (only support for administrators or room owner).
      Update room seat mode (only support for administrators or room owner).
      Update room password.
      Get room metadata.
      Set room metadata, if the key already exists, update its value, if not, add the key.

      Local user view rendering, video management.

      FuncList
      DESC
      Set the local camera to preview the render view.
      Open the local camera.
      Close the local camera.
      Start publishing local video stream, default enabled.
      Stop publishing local video stream.
      Update video encoding quality.
      Set the video encoding parameters.
      Set the video resolution mode (horizontal resolution or vertical resolution).
      Turn on gravity sensing mode. (only availble on mobile OS and the camera capture scene inside the SDK).
      Start screen sharing (only available on mobile OS).
      Start screen sharing (only available on Mac OS).
      Stop screen sharing.
      Get the sharable screen and windows (only available on Mac OS)
      Select the screen or windows to share (only available on Mac OS)

      Local User Audio Management.

      FuncList
      DESC
      Open local microphone.
      Close the local microphone.
      Update audio encoding quality.
      Pause publishing the local audio stream.
      Resume publishing the local audio stream.

      Remote user view rendering and video management.

      FuncList
      DESC
      Set the render view for remote user.
      Start playing the remote user's video stream.
      Stop playing the remote user's video stream.
      Mute the remote user's audio stream.

      User information in the room.

      FuncList
      DESC
      Get the list of user in the room.
      Get user information.

      User management in the room.

      FuncList
      DESC
      Change user role (only support for administrators or room owner).
      Change user nickname in the room (only support to change all user for administrators or room owner, user can only change by self).
      Kick the remote user out of the room (only support for administrators or room owner).
      Add a tag for the user (only support for administrators or room owner).
      Remove tag for user (only support for room owner).
      Get user information in the room based on the tag.
      Set custom information for room users.

      User speech management in the room.

      FuncList
      DESC
      The owner or administrator control that all users whether can open device. For example: all users are prohibited from opening the microphone(only available in the conference scenario).
      Request the remote user to open the media device (only support for administrators or room owner).
      Close remote user media devices (only support for administrators or room owner).
      Apply to open the local media device (available to general users).

      Seat management in the room.

      FuncList
      DESC
      Set the maximum number of seat (only available before entering room and when creating room).
      Get seat list.
      Lock the seat (only support for administrators or room owner).
      Take the seat.
      Leave the seat.
      Move to seat.
      Invite user to take the seat (only support for administrators or room owner).
      Kick off the user from seat (only support for administrators or room owner).
      Get the request list of users who want to take the seat in the room (only support for administrators or room owner).

      Message.

      FuncList
      DESC
      Disable the ability of remote users to send messages (only support for administrators or room owner).
      Disable the ability of all users to send messages (only support for administrators or room owner).

      Request Management.

      FuncList
      DESC
      Cancel request.
      Response request.

      Advanced Features.

      FuncList
      DESC
      Set the beauty level.
      Set whitening level.
      Get the extension.
      Get device management class.
      Get live-connection management class.

      Debug related.

      FuncList
      DESC
      Call experimental APIs.

      Error event callback.

      FuncList
      DESC
      Error event callback.

      Login status event callback.

      FuncList
      DESC
      The current user was kicked offline.
      The current user signature is expired.

      Event callback in the room.

      FuncList
      DESC
      The name of the room has changed.
      The status of disabling to open microphone has changed for all users.
      The status of disabling to open camera has changed for all users.
      The status of disabling to open screen sharing has changed for all users.
      The status of disabling to send message has changed for all users.
      Room was dismissed.
      The current user has been kicked off from the room.
      The room seat mode has changed.
      The count of user in the room has changed.
      The key-value of room metadata has changed.
      Room was dismissed.

      User event callback in the room.

      FuncList
      DESC
      Remote user entered room.
      Remote user left room.
      User information has changed in the room.
      The status of the user has video stream changed.
      The status of the user has audio stream changed.
      User volume changed.
      The status of disabling to send message has changed for user.
      The user network status changed.
      Screen sharing stopped.

      Seat event callback in the room.

      FuncList
      DESC
      The maximum count of seats in the room changed (only available in conference rooms)
      Seat list changed.
      The user was kicked off the seat.
      Recevied user was kicked off the seat.

      Request event callback.

      FuncList
      DESC
      Receive a request message.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.

      Deprecated callbacks.

      FuncList
      DESC
      Room was dismissed.
      The user was kicked off the seat.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.
      Local device added.
      Room was dismissed.
      User role changed.
      User role changed.
      Recevied user was kicked off the seat.
      Received a cancelled request.
      Receive a request to be processed by other administrator/owner.

      Device management APIs.

      FuncList
      DESC
      Query whether the front camera is being used (only availiable for mobile OS).
      Switch to the front/rear camera (only availiable for mobile OS).
      Query whether automatic face detection is supported (only availiable for mobile OS).
      Enable auto focus (only availiable for mobile OS).
      Enable/Disable flash, i.e., the torch mode (only availiable for mobile OS).
      Set the audio route (only availiable for mobile OS).
      Set event observer.
      Start camera testing (only availiable for desktop OS).
      End camera testing (only availiable for desktop OS).
      Start microphone testing (only availiable for desktop OS).
      End microphone testing (only availiable for desktop OS)
      Start speaker testing (only availiable for desktop OS).
      End speaker testing (only availiable for desktop OS).
      Get the device list (only availiable for desktop OS).
      Set the device to use (only availiable for desktop OS).
      Get the device currently in use (only availiable for desktop OS).
      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