tencent cloud

Feedback

API Overview

Last updated: 2023-09-19 15:19:59

    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
    Creates a TUICallKit instance (singleton mode).
    Sets the user nickname and profile photo.
    call
    Makes a one-to-one call.
    groupCall
    Makes a group call.
    Joins a group call.
    Sets the ringtone.
    Sets whether to turn on the mute mode.
    Sets whether to enable floating windows.

    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).
    Terminates a TUICallEngine instance (singleton).
    init
    Authenticates the basic audio/video call capabilities.
    Registers an event listener.
    Unregisters an event listener.
    call
    Makes a one-to-one call.
    groupCall
    Makes a group call.
    accept
    Answers a call.
    reject
    Declines a call.
    hangup
    Ends a call.
    ignore
    Ignores a call.
    Invites users to the current group call.
    Joins a group call.
    Switches the call media type, such as 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 the camera.
    Enables the mic.
    Disables the mic.
    Selects the audio playback device (receiver/speaker).
    Sets the user nickname 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.
    Advanced features.
    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 was kicked offline.
    The user sig is expired.

    Definitions of Key Types

    API
    Description
    The call type. Enumeration: Video call and audio call.
    The call role. Enumeration: Caller and callee.
    The call status. Enumeration: Idle, waiting, and answering.
    The room ID, which can be a number or string.
    The camera type. Enumeration: Front camera and rear camera.
    The audio playback device type. Enumeration: Speaker and receiver.
    The current network quality.
    
    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