tencent cloud

Feedback

Overview

Last updated: 2022-09-26 15:40:34

    TRTCCloud @ TXLiteAVSDK

    Instance creation and event callback APIs

    API
    Description
    Creates a TRTCCloud instance (singleton).
    Terminates a TRTCCloud instance (singleton).
    Sets TRTC event callbacks.
    Sets the queue that drives TRTCCloudDelegate 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.
    Sets the image to display when local video is paused.
    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.
    Sets the adaptation mode of the G-sensor.
    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 audio route.
    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
    Gets the beauty filter management class TXBeautyManager.
    Adds watermarks.

    Background music and audio effect APIs

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

    Screen sharing APIs

    API
    Description
    Starts in-application screen sharing (for iOS 13.0 or above).
    Starts system-level screen sharing (for iOS 11.0 or above).
    Starts desktop screen sharing (for desktop systems only).
    Stops screen sharing.
    Pauses screen sharing.
    Resumes screen sharing.
    Enumerates shareable screens and windows (for macOS only).
    Selects a screen or window to share (for macOS 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 for custom rendering.
    Sets the callback of a remote video for custom rendering.
    Sets the callback of audio data for custom rendering.
    Sets the format of the callback of raw audio frames captured by the local mic.
    Sets the format of the callback of audio frames captured locally and pre-processed by the audio module.
    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.
    Sets the dashboard margin.
    Calls the experimental API.

    Disused APIs

    API
    Description
    Sets the mic volume.
    Sets the strength of the beauty, brightening, and rosy skin filters.
    Sets the strength of the eye enlarging filter.
    Sets the strength of the face slimming filter.
    Sets the strength of the chin slimming filter.
    Sets the strength of the jaw lengthening/shortening filter.
    Sets the strength of the face shortening filter.
    Sets the strength of the nose slimming filter.
    Sets animated stickers.
    Mutes/Unmutes animated effects.
    Starts screen sharing.
    Sets the color filter.
    Sets the strength of the color filter.
    Sets green screen effects.
    Starts background music.
    Stops background music.
    Pauses background music.
    Resumes background music.
    Gets the total length of the music file, in milliseconds.
    Sets the playback progress of background music.
    Sets the volume of background music.
    Sets the local playback volume of background music.
    Sets the remote playback volume of background music.
    Sets the reverb effect.
    Sets the voice changing effect.
    Plays an audio effect.
    Sets the volume of an audio effect.
    Stops an audio effect.
    Stops all audio effects.
    Sets the volume of all audio effects.
    Pauses an audio effect.
    Resumes an audio effect.
    Enables/Disables in-ear monitoring.
    Plays the video of a remote user.
    Stops playing the video of a remote user and pulling the user’s video data.
    Sets the rendering mode of a remote image.
    Sets the clockwise rotation of a remote image.
    Sets the rendering mode of the local image.
    Sets the clockwise rotation of the local image.
    Sets the mirror mode of the local camera's preview image.
    Starts playing the substream video of a remote user.
    Stops playing the substream video of a remote user.
    Sets the fill mode of the substream video of a remote user.
    Sets the clockwise rotation of the substream video of a remote user.
    Sets playback preference.
    Sets audio quality.
    Enables local audio capturing and publishing.
    Switches cameras.
    Queries whether the current camera supports zoom.
    Sets the camera zoom factor (focal length).
    Queries whether the camera supports flash.
    Enables/Disables flash.
    Queries whether the camera supports focus setting.
    Sets the coordinates of camera focus.
    Queries whether the camera supports automatic facial recognition.
    Enables/Disables auto focus on face.
    Starts camera testing.
    Stops camera testing.
    Starts mic testing.
    Stops mic testing.
    Starts speaker testing.
    Stops speaker testing.
    Gets the mic list.
    Gets the mic currently in use.
    Sets the mic to use.
    Gets the current mic volume.
    Sets the current mic volume.
    Gets whether the current mic is muted.
    Mutes/Unmutes the current mic.
    Gets the speaker list.
    Gets the speaker currently in use.
    Sets the speaker to use.
    Gets the current speaker volume.
    Sets the current speaker volume.
    Gets whether the current speaker is muted.
    Mutes/Unmutes the current speaker.
    Gets the camera list.
    Gets the camera currently in use.
    Sets the camera to use.
    Sets the system volume type.
    Takes a video screenshot.
    Enables/Disables custom video capturing.
    Sends captured video data to the SDK.
    Starts in-application screen sharing (for iOS).
    Starts system-level screen sharing (for iOS).
    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 for change of the audio route (for mobile devices only)
    Callback of volume
    Callback of the connection/disconnection 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)

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

    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 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 for destroying the OpenGL context in the SDK

    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
    Callback of the audio data of each remote user before audio mixing
    Callback of data mixed from the audio of each user before playback
    Callback of data mixed from all audios in the SDK, including captured and to-be-played audio

    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 filter (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 sample rate
    Audio quality
    Audio route (audio playback mode)
    Reverb effect
    Voice changing effect
    System volume type (for mobile devices only)

    Definitions of other enumerated values

    API
    Description
    Log level
    G-sensor mode (for mobile devices only)
    Type of the content to share (for desktop systems only)
    Layout mode for On-Cloud MixTranscoding
    Type of 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
    Format of the custom audio callback
    Information of the content to share (for desktop systems only)
    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