tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2025-01-03 18:01:30
    Download PDF

      TUICallKit (including UI Interface)

      TUICallKit APIs

      UICallKit API, you can quickly implement a WeChat-like audio and video call scenario through simple interfaces.
      API
      Description
      login
      Login.
      logout
      Logout.
      call
      To make a one-on-one call, supports custom room ID, call timeout, offline push content, and more.
      groupCall
      To make a group call, supports custom room ID, call timeout, offline push content, and more.
      Join a group call.
      Customize user's ringtone.
      Set your own nickname and profile photo.
      Turn On/Off Ringtone.
      Set Screen Orientation.
      on
      Listen to TUICallKit events.
      off
      Cancel listening to TUICallKit events.

      TUICallEvent

      TUICallEvent is the callback event class corresponding to TUICallKit. Through this callback, you can listen to the callback events you are interested in.
      Event
      Description
      Error Callback during Call.
      Callback for a Call Request.
      Callback for Call Cancellation.
      Callback for Call Connection.
      Callback for Call Termination.
      xxxx User declines the call Callback.
      xxxx User Non-response Callback.
      xxxx User Busy Line Callback.
      xxxx User Joins Call Callback.
      A user left the call.
      Callback for a change in the Call's Media Type.
      Current user kicked offline.
      Ticket expired while online.
      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.

      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
      Creates a TUICallEngine instance (singleton mode).
      Terminates a TUICallEngine instance (singleton mode).
      login
      Authenticates the basic audio/video call capabilities.
      on
      Registers an event listener.
      off
      Unregisters an event listener.
      call
      Makes a one-to-one call.
      accept
      Accepts a call.
      reject
      Rejects a call.
      ignore
      Ignores a call.
      hangup
      Ends a 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.
      Switches between the front and rear cameras.
      Turns the camera off.
      Turns the mic on.
      Turns the mic off.
      Selects the audio playback device (receiver or speaker).
      Set the rendering mode of video image.
      Set the encoding parameters of video encoder.
      Set beauty level, support turning off default beauty.
      Sets the alias and profile photo.
      Sets whether to enable multi-device login for TUICallEngine .
      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-2025 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy