tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2024-05-23 16:24:18
    Download PDF

      TUICallKit (UI Included)

      TUICallKit is an audio/video call component that includes UI elements. You can use its APIs to quickly implement an audio/video call application similar to WeChat.
      API
      Description
      login
      Log in
      logout
      Sign out
      Sets the user nickname and profile photo.
      call
      Makes a one-to-one call.
      groupCall
      Makes a group call.
      Joins a group call.
      Sets whether to turn on the mute mode.
      Sets whether to enable floating windows.
      Custom ringtone.
      Turn On/Off the Virtual Background feature

      TUICallEngine (No UI)

      TUICallEngine is an audio/video call component that does not include UI elements. If TUICallKit does not meet your requirements, you can use the APIs of TUICallEngine to customize your project.
      API
      Description
      init
      Authenticates the basic audio/video call capabilities.
      unInit
      The destructor function, which releases resources used by TUICallEngine.
      Registers an event listener.
      Unregisters an event listener.
      call
      Makes a one-to-one call.
      groupCall
      Makes a group call.
      accept
      Accepts a call.
      reject
      Rejects a call.
      hangup
      Ends a call.
      ignore
      Ignores a call.
      Invites users to the current group call.
      Joins a group call.
      Changes the call type, for example, from video call to audio call.
      Subscribes to the video stream of a remote user.
      Unsubscribes from the video stream of a remote user.
      Turns the camera on.
      Turns the camera off.
      Switches between the front and rear cameras.
      Turns the mic on.
      Turns the mic off.
      Selects the audio playback device (receiver or speaker).
      Sets the alias and profile photo.
      Sets whether to enable multi-device login for TUICallEngine (supported by the premium package).
      Set the rendering mode of video image.
      Set the encoding parameters of video encoder.
      Query call record.
      Delete call record.
      Set Blurry Video Effect
      Set Virtual Background Image
      Set beauty level, support turning off default beauty.

      TUICallObserver

      TUICallObserver is the callback class of TUICallEngine. You can use it to listen for events.
      API
      Description
      onError
      An error occurred during the call.
      A call was received.
      The call was canceled.
      The call was connected.
      onCallEnd
      The call ended.
      The call type changed.
      A user declined the call.
      A user didn't respond.
      A user was busy.
      A user joined the call.
      A user left the call.
      Whether a user has a video stream.
      Whether a user has an audio stream.
      The volume levels of all users.
      The network quality of all users.
      The current user is kicked offline
      Ticket expires while online
      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