tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    API Overview

    Last updated: 2024-08-09 22:25:01
    Download PDF

      TUICallKit (Includes UI Components)

      TUICallKit is an audio and video call component that includes a UI component. You can quickly implement a WhatsApp-like audio and video calling scenario with this component.
      API
      Description
      init
      Initialize TUICallKit.
      call
      Makes a one-to-one call, Support for custom room ID, call timeout, offline push content, etc
      groupCall
      Makes a group call, Support for custom room ID, call timeout, offline push content, etc
      Join a group call.
      Customize user's ringtone.
      Set your own nickname and avatar.
      Turn on/off ringtone
      Activate/Deactivate the floating window function Turn on/off the floating window function
      Turn on/off the blurred background function button. v3.2.4+ support
      Set the call language for the TUICallKit component
      Hidden Button, v3.2.9+ support
      Set the background image for the local user's call interface, v3.2.9+ support
      Set the background image for the remote user's call interface, v3.2.9+ support
      Set the call interface layout mode, supported from v3.3.0+
      Set whether the camera is opened by default, supported from v3.3.0+
      destroyed
      Terminating TUICallKit Destroy TUICallKit
      Get TUICallEngine instance,v2.4.3+ supported

      TUICallEngine (No UI)

      TUICallEngine API is an audio and video call component that offers a No UI interface. You can use this set of APIs to custom encapsulate according to your business needs.
      API
      Description
      Creating a TUICallEngine Instance (Singleton Pattern)
      Terminating a TUICallEngine Instance (Singleton Pattern)
      on
      Listening on events
      off
      Canceling Event Listening
      login
      Sign in Interface
      logout
      Logout Interface
      Configure the user's nickname and profile photo
      call
      Initiate a one-on-one call
      groupCall
      Group Chat Invitation Call
      accept
      Answer Calls
      reject
      Decline Call
      hangup
      End Calls
      Switch Audio and Video Calls
      Initiate Remote Screen Rendering
      Stop Remote Screen Rendering
      Start Local Screen Rendering, Note: This will be deprecated; use openCamera instead
      Stop Local Screen Rendering, Note: This will be deprecated; use closeCamera instead
      Enable the camera
      Turn Off Camera
      Switch between front and rear cameras, note: only supported on mobile devices. v3.0.0+ supported
      Enable Microphone
      Turn off the microphone
      Set video quality
      Access device list
      Switch camera or microphone devices
      Enable/disable AI noise reduction
      Turn on/off the multi-device login mode of TUICallEngine. v2.1.1+ supported
      Switch/set background blur, v3.0.6+ supported
      Switch/set image background blur, v3.0.6+ supported

      Event Types

      TUICallEvent is the callback event class corresponding to TUICallEngine. Through this callback, you can listen to the callback events of interest.
      EVENT
      Description
      An error occurred during the call.
      This callback is received when the SDK enters the Ready State
      Duplicate Sign in, receiving this callback indicates being Kicked out of Room
      If a user answers, this callback will be received
      A user joined the call.
      A user left the call.
      A user declined the call.
      A user didn't respond.
      A user was busy.
      Whether a user has a video stream.
      Whether a user has an audio stream.
      The volume levels of all users.
      Group Chat Update, Invitation List this callback will be received
      Call connected event, v1.4.6+ supported
      A call was received. It will be discarded later and it is recommended to use TUICallEvent.ON_CALL_RECEIVED
      Call request event, v1.4.6+ supported
      Call cancellation event,
      It will be abandoned later and it is recommended to use TUICallEvent.ON_CALL_CANCELED
      Call canceled event, v1.4.6+ supported
      The call ended.
      Device list update, this callback will be received
      This callback is received when switching call types
      All user network quality events, v3.0.7+ supported

      Document Link

      TUICallEngine
      TUICallEvent
      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