tencent cloud

Feedback

Overview

Last updated: 2022-09-26 15:47:42

    Introduction

    Since version 8.0, TRTC has provided new APIs for C++ in addition to the original ones. They can be used on Windows, iOS, macOS, and Android. See the following documents for how to integrate the C++ APIs.
    explain
    The C++ APIs are currently available in LiteAV_TRTC only.
    On Windows, the TRTC header file automatically adopts the "trtc" namespace. You do not need to specify the namespace.

    ITRTCCloud @ TXLiteAVSDK

    Instance creation and event callback APIs

    API
    Description
    Creates a TRTCCloud instance (singleton).
    Terminates a TRTCCloud instance (singleton).
    Sets TRTC event callbacks.
    Removes TRTC event callbacks.

    Room APIs

    API
    Description
    Enters a room.
    Exits a room.
    Switches roles.
    Switches rooms.
    Requests a cross-room call.
    Exits a cross-room call.
    Sets the subscription mode. It must be set before room entry to take effect.
    Creates a sub-room instance (for concurrent playback from multiple rooms).
    Terminates a sub-room instance.

    CDN APIs

    API
    Description
    Starts publishing audio/video streams to Tencent Cloud’s live streaming CDN.
    Stops publishing audio/video streams to Tencent Cloud’s live streaming CDN.
    Starts publishing audio/video streams to a non-Tencent Cloud CDN.
    Stops publishing audio/video streams to a non-Tencent Cloud CDN.
    Sets layout and transcoding parameters for On-Cloud MixTranscoding.

    Video APIs

    API
    Description
    Enables local camera preview (mobile).
    Enables local camera preview (desktop).
    Updates local camera preview.
    Disables local camera preview.
    Pauses/Resumes publishing the local video stream.
    Subscribes to a remote user’s video stream and binds a video rendering control.
    Updates a remote user’s video rendering control.
    Unsubscribes from a remote user’s video stream and unbinds the rendering control.
    Unsubscribes from all remote users’ video streams and unbinds all rendering controls.
    Pauses/Resumes receiving a remote user’s video stream.
    Pauses/Resumes receiving all remote users’ video streams.
    Sets video encoder parameters.
    Sets video preference.
    Sets rendering parameters for the local image.
    Sets rendering parameters for a remote image.
    Sets the rotation of encoded video images.
    Sets the mirror mode of encoded images.
    Enables/Disables the dual-channel (big and small images) encoding mode.
    Switches between the small and big images of a remote user.
    Takes a video screenshot.

    Audio APIs

    API
    Description
    Starts local audio capturing and publishing.
    Stops local audio capturing and publishing.
    Pauses/Resumes publishing the local audio stream.
    Pauses/Resumes playing the audio stream of a remote user.
    Pauses/Resumes playing the audio streams of all remote users.
    Sets the playback volume of a remote user.
    Sets the local audio capturing volume.
    Gets the local audio capturing volume.
    Sets the playback volume of remote audio.
    Gets the playback volume of remote audio.
    Enables the volume reminder.
    Starts audio recording.
    Stops audio recording.
    Starts local media recording.
    Stops local media recording.
    Configures policy for the playback of the audio of multiple remote speakers.

    Device management APIs

    API
    Description
    Gets the device management class TXDeviceManager.

    Beauty filter and watermark APIs

    API
    Description
    Sets the beauty, skin brightening, and rosy skin filters.
    Adds watermarks.

    Background music and audio effect APIs

    API
    Description
    Gets the audio effect management class TXAudioEffectManager.
    Starts system audio capturing (for desktop systems only).
    Stops system audio capturing (for desktop systems only).
    Sets system audio capturing volume.

    Screen sharing APIs

    API
    Description
    Starts desktop screen sharing (for desktop systems only).
    Stops screen sharing.
    Pauses screen sharing.
    Resumes screen sharing.
    Enumerates shareable screens and windows (for desktop systems only).
    Selects a screen or window to share (for desktop systems only).
    Sets encoding parameters for screen sharing (substream video). This API works on both desktop and mobile OS.
    Sets audio mixing volume for screen sharing (for desktop systems only).
    Adds a window to the exclusion list of screen sharing (for desktop systems only).
    Removes a window from the exclusion list of screen sharing (for desktop systems only).
    Removes all windows from the exclusion list of screen sharing (for desktop systems only).
    Adds a window to the screen sharing list (for desktop systems only).
    Removes a window from the screen sharing list (for desktop systems only).
    Removes all windows from the screen sharing list (for desktop systems only).

    Custom capturing and rendering APIs

    API
    Description
    Enables/Disables custom video capturing.
    Sends captured video frames to the SDK.
    Enables/Disables custom audio capturing.
    Sends captured audio data to the SDK.
    Enables/Disables custom audio tracks.
    Mixes a custom audio track into the SDK.
    Sets the publishing and playback volumes of external audio mixed into the published stream.
    Gets the PTS for custom capturing.
    Sets the callback of video data for the application of third-party beauty filters.
    Sets the callback of local video data for custom rendering.
    Sets the callback of a remote user’s video data for custom rendering.
    Sets the callback of audio data for custom rendering.
    Sets the format of the callback of audio frames played by the system.
    Enables/Disables custom audio rendering.
    Gets playable audio frames.

    Custom message sending APIs

    API
    Description
    Sends a custom message to all users in a room via TRTC’s UDP channel.
    Sends a custom message to all users in a room via TRTC’s SEI channel.

    Network testing APIs

    API
    Description
    Starts network speed testing. This API must be called before room entry.
    Stops network speed testing.

    Debugging APIs

    API
    Description
    Gets the SDK version.
    Sets the log output level.
    Enables/Disables console log printing.
    Enables/Disables local log compression.
    Sets the path to save local logs.
    Sets the log callback.
    Sets whether to display the dashboard.
    Calls the experimental API.

    Disused APIs

    API
    Description
    Enables/Disables custom video capturing.
    Sends captured video data to the SDK.
    Pauses/Resumes publishing the local video stream.
    Pauses/Resumes receiving a remote user’s video stream.
    Starts network speed testing. This API must be called before room entry.

    Error and warning callback APIs

    API
    Description
    Callback for errors
    Callback for warnings

    Room event callback APIs

    API
    Description
    Callback of the result of room entry
    Callback for room exit
    Callback for role switching
    Callback for room switching
    Callback of the result of requesting a cross-room call
    Callback of the result of ending a cross-room call

    User event callback APIs

    API
    Description
    Callback for the entry of a user
    Callback for the exit of a user
    Callback for publishing/unpublishing the primary-stream video by a remote user
    Callback for publishing/unpublishing the substream video by a remote user
    Callback for publishing/unpublishing audio by a remote user
    Callback for rendering the first video frame of the local user or a remote user
    Callback for playing the first audio frame of a remote user
    Callback for sending the first local video frame
    Callback for sending the first local audio frame
    Callback for change of the video status of a remote user

    Callback APIs for statistics on network and technical metrics

    API
    Description
    Callback of real-time statistics on network quality
    Callback of real-time statistics on technical metrics
    Callback of network speed testing results

    Callback APIs for change of connection status

    API
    Description
    Callback for the disconnection of the SDK from the server
    Callback for the SDK trying to reconnect to the server
    Callback for the reconnection of the SDK to the server

    Hardware event callback APIs

    API
    Description
    Callback for the camera being ready
    Callback for the mic being ready
    Callback of volume
    Callback for change of the connection status of a local device (for desktop systems only)
    Callback for change of the mic’s system audio capturing volume
    Callback for change of the system’s playback volume
    Callback of whether system audio capturing is enabled successfully (for macOS only)
    Volume callback for mic testing
    Volume callback for speaker testing

    Callback APIs for receiving custom messages

    API
    Description
    Callback for receiving a custom message
    Callback for losing a custom message
    Callback for receiving an SEI message

    CDN event callback APIs

    API
    Description
    Callback for publishing audio/video streams to Tencent Cloud’s live streaming CDN
    Callback for stopping publishing audio/video streams to Tencent Cloud’s live streaming CDN
    Callback for publishing audio/video streams to a non-Tencent Cloud CDN
    Callback for stopping publishing audio/video streams to a non-Tencent Cloud CDN
    Callback for setting layout and transcoding parameters for On-Cloud MixTranscoding

    Screen sharing callback APIs

    API
    Description
    Callback for starting screen sharing
    Callback for pausing screen sharing
    Callback for resuming screen sharing
    Callback for stopping screen sharing
    Callback for the window to share being covered (for Windows only)

    Callback APIs for local recording and screenshot taking

    API
    Description
    Callback for starting local recording
    Callback of the progress of local recording
    Callback for ending local recording
    Callback for taking a screenshot

    Disused callback APIs

    API
    Description
    Callback for the entry of an anchor (disused)
    Callback for the exit of an anchor (disused)
    Callback for ending an audio effect (disused)
    Callback for starting background music (disused)
    Callback of the playback progress of background music (disused)
    Callback for ending background music (disused)
    Callback of server speed testing results. This callback has been disused.

    Callback APIs for custom video

    API
    Description
    Callback of video frames for custom rendering
    Callback of video frames for processing by third-party beauty filters

    Callback APIs for custom audio

    API
    Description
    Callback of audio data captured by the local mic and pre-processed by the audio module
    Callback of locally captured audio data that is pre-processed by the audio module, added with audio effects, and mixed with background music
    Audio data of each remote user before audio mixing
    Callback of data mixed from the audio of each user before playback

    Other callback APIs

    API
    Description
    Callback for printing local logs

    Definitions of video enumerated values

    API
    Description
    Resolution
    Aspect ratio mode
    Stream type
    Image fill mode
    Rotation
    Beauty (skin smoothing) algorithm
    Pixel format
    Video data transfer method
    Mirror mode
    Source of local screenshots

    Definitions of network enumerated values

    API
    Description
    Application scenario
    Role
    QoS control mode (disused)
    Video quality preference
    Network quality
    Video status
    Reason for change of video status

    Definitions of audio enumerated values

    API
    Description
    Audio quality

    Definitions of other enumerated values

    API
    Description
    Log level
    Type of the content to share (for desktop systems only)
    Layout mode for On-Cloud MixTranscoding
    Type of the media to record
    Input type for stream mixing
    Device type (for desktop systems only)
    Type of audio to record

    Definitions of TRTC key types

    API
    Description
    Room entry parameters
    Video encoding parameters
    QoS control parameters
    Video rendering parameters
    Network quality
    Volume
    Network speed testing parameters
    Results of network speed testing
    Video frame information
    Audio frame information
    Information of each channel in On-Cloud MixTranscoding
    Layout and transcoding parameters for On-Cloud MixTranscoding
    Relaying parameters for publishing audio/video streams to a non-Tencent Cloud CDN
    Local audio recording parameters
    Local media recording parameters
    Audio effect parameters (disused)
    Room switching parameters
    Parameters for the format of the custom audio callback
    Information of the content to share (for desktop systems only)
    List of sharable sources
    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