tencent cloud


API Overview

Last updated: 2024-05-08 11:39:30

    TUICallKit(UI Component)

    TUICallKit is an audio and video call component with UI components , allowing you to quickly implement WeChat-like audio and video call scenarios.
    <TUICallKit/>: The call component.
    <TUICallKitMini/>:UI call floating window. If the minimize feature is enabled, <TUICallKitMini/> must be placed on the page. Note: Deprecated as of v2.3.2+ .
    TUICallKitServer: Call instance. The provided API is as follows.
    Initialize TUICallKit.
    Initiate a 1v1 Call
    Initiate a Group Call
    Actively Join the Current Group Call
    Setting Custom Incoming Call Ringtone
    Setting User Nickname and Avatar
    Enable/Disable Ringtone
    Enable/Disable Floating Window Feature
    Setting TUICallKit Component Call Language
    Terminate TUICallKit

    TUICallEngine (No UI)

    TUICallEngine is an audio/video call component that does not include UI elements. You can use its APIs to customize your project.
    Creates a TUICallEngine instance (singleton mode).
    Terminates a TUICallEngine instance (singleton mode).
    Listens for an event.
    Stops listening for an event.
    Logs in.
    Logs out.
    Sets the alias and profile photo.
    Makes a one-to-one call.
    Makes a group call.
    Accepts a call.
    Rejects a call.
    Ends a call.
    Changes the call type.
    Starts rendering a remote video, Note: Will be deprecated, recommend using openCamera
    Stops rendering a remote video, Note: Will be deprecated, recommend using closeCamera
    Starts rendering the local video.
    Stops rendering the local video.
    Turns the camera on.
    Turns the camera off.
    Turns the mic on.
    Turns the mic off.
    Sets the video quality.
    Gets the device list.
    Changes to a different camera/mic.
    open/close AI noise reduction

    Event Types

    TUICallEvent is the callback class of TUICallEngine. You can use it to listen for events.
    An internal error occurred.
    The SDK is ready.
    The current user was removed from the room due to repeated login.
    A user accepted the call.
    A user agreed to join the call.
    A user agreed to leave the call.
    A user rejected the call.
    The invited user did not answer.
    The line is busy.
    A remote user turned on/off their camera.
    A remote user turned on/off their mic.
    A remote user adjusted their call volume.
    The invitation list for a group call was updated.
    You were invited to a call.
    The call was canceled (received by an invitee).
    The call ended.
    The device list was updated.
    The call type changed.


    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support