tencent cloud

Feedback

Overview

Last updated: 2022-10-28 10:12:40
    TRTCCloud

    Create Instance And Event Callback

    functions
    desc
    Terminate TRTCCloud instance (singleton mode)
    Set the queue that drives the TRTCCloudDelegate event callback
    Set TRTC event callback
    Create TRTCCloud instance (singleton mode)

    Room APIs

    functions
    desc
    Request cross-room call
    Exit cross-room call
    Create room subinstance (for concurrent multi-room listen/watch)
    Terminate room subinstance
    enterRoom
    Enter room
    exitRoom
    Exit room
    Set subscription mode (which must be set before room entry for it to take effect)
    Switch role(support permission credential)
    Switch room

    CDN APIs

    functions
    desc
    Set the layout and transcoding parameters of On-Cloud MixTranscoding
    Start publishing audio/video streams to non-Tencent Cloud CDN
    Publish a stream
    Start publishing audio/video streams to Tencent Cloud CSS CDN
    Stop publishing audio/video streams to non-Tencent Cloud CDN
    Stop publishing
    Stop publishing audio/video streams to Tencent Cloud CSS CDN
    Modify publishing parameters

    Video APIs

    functions
    desc
    Enable dual-channel encoding mode with big and small images
    Pause/Resume subscribing to all remote users' video streams
    Pause/Resume publishing local video stream
    Pause/Resume subscribing to remote user's video stream
    Set the adaptation mode of G-sensor
    Set the rendering parameters of local video image
    Set network quality control parameters
    Set the rendering mode of remote video image
    Switch the big/small image of specified remote user
    Set the mirror mode of image output by encoder
    Set the encoding parameters of video encoder
    Set the direction of image output by video encoder
    Set placeholder image during local video pause
    Screencapture video
    Enable the preview image of local camera (mobile)
    Subscribe to remote user's video stream and bind video rendering control
    Stop subscribing to all remote users' video streams and release all rendering resources
    Stop camera preview
    Stop subscribing to remote user's video stream and release rendering control
    Update the preview image of local camera
    Update remote user's video rendering control

    Audio APIs

    functions
    desc
    Enable 3D spatial effect
    Enable volume reminder
    Get the capturing volume of local audio
    Get the playback volume of remote audio
    Pause/Resume playing back all remote users' audio streams
    Pause/Resume publishing local audio stream
    Pause/Resume playing back remote audio stream
    Set the maximum 3D spatial attenuation range for userId's audio stream
    Set the capturing volume of local audio
    Set the playback volume of remote audio
    Set audio route
    Set the parallel strategy of remote audio streams
    Set the audio playback volume of remote user
    Start audio recording
    Enable local audio capturing and publishing
    Start local media recording
    Stop audio recording
    Stop local audio capturing and publishing
    Stop local media recording
    Update the specified remote user's position for 3D spatial effect
    Update self position and orientation for 3D spatial effect

    Device management APIs

    functions
    desc
    Get device management class (TXDeviceManager)

    Beauty filter and watermark APIs

    functions
    desc
    Get beauty filter management class (TXBeautyManager)
    Add watermark

    Background music and sound effect APIs

    functions
    desc
    Get sound effect management class (TXAudioEffectManager)
    Enable system audio capturing (for android system only)
    Stop system audio capturing (for desktop systems and android system)

    Screen sharing APIs

    functions
    desc
    Pause screen sharing
    Resume screen sharing
    Set the video encoding parameters of screen sharing (i.e., substream) (for desktop and mobile systems)
    Start screen sharing
    Stop screen sharing

    Custom capturing and rendering APIs

    functions
    desc
    Enable custom audio capturing mode
    Enabling custom audio playback
    Enable/Disable custom video capturing mode
    Enable/Disable custom audio track
    Generate custom capturing timestamp
    Getting playable audio data
    Mix custom audio track into SDK
    Deliver captured audio data to SDK
    Deliver captured video frames to SDK
    Set custom audio data callback
    Set the callback format of original audio frames captured by local mic
    Set the callback format of preprocessed local audio frames
    Set video data callback for third-party beauty filters
    Set the callback of custom rendering for local video
    Set the publish volume and playback volume of mixed custom audio track
    Set the callback format of audio frames to be played back by system
    Set the callback of custom rendering for remote video

    Custom message sending APIs

    functions
    desc
    Use UDP channel to send custom message to all users in room
    Use SEI channel to send custom message to all users in room

    Network test APIs

    functions
    desc
    Start network speed test (used before room entry)
    Stop network speed test

    Debugging APIs

    functions
    desc
    Set dashboard margin
    Call experimental APIs
    Get SDK version information
    Enable/Disable console log printing
    Enable/Disable local log compression
    Set local log storage path
    Set log output level
    Set log callback
    Display dashboard

    背景音乐预加载事件回调

    functions
    desc
    Background music preload error
    Background music preload progress

    Callback of playing background music

    functions
    desc
    Background music ended
    Playback progress of background music
    onStart
    Background music started.

    Voice effect APIs

    functions
    desc
    Enabling in-ear monitoring
    Setting speech volume
    Setting voice changing effects
    Setting in-ear monitoring volume
    Setting speech pitch
    Setting voice reverb effects

    Background music APIs

    functions
    desc
    Getting the playback progress (ms) of background music
    Getting the total length (ms) of background music
    Pausing background music
    Preload background music
    Resuming background music
    Setting the playback progress (ms) of background music
    Setting the local and remote playback volume of background music
    Setting the background music callback
    Adjusting the pitch of background music
    Setting the local playback volume of a specific music track
    Setting the remote playback volume of a specific music track
    Adjust the speed change effect of the scratch disc
    Changing the speed of background music
    Setting music preload callback
    Starting background music
    Stopping background music

    beauty interface

    functions
    desc
    Enables clarity enhancement.
    Sets the strength of the beauty filter.
    Sets the beauty (skin smoothing) filter algorithm.
    Sets the strength of the chin lengthening/shortening filter.
    Sets the strength of the eye corner adjustment filter.
    Sets the strength of the eye distance adjustment filter.
    Sets the strength of the eye brightening filter.
    Sets the strength of the eye enlarging filter.
    Sets the strength of the face shape adjustment filter.
    Sets the strength of the face narrowing filter.
    Sets the strength of the face shortening filter.
    Sets the strength of the face slimming filter.
    Sets the strength of the chin slimming filter.
    Sets the strength of color filter.
    setFilter
    Sets color filter.
    Sets the strength of the hairline adjustment filter.
    Sets green screen video
    Sets the strength of the lip thickness adjustment filter.
    Sets whether to mute during animated effect playback.
    Selects the AI animated effect pendant.
    Sets the strength of the mouth shape adjustment filter.
    Sets the strength of the nose position adjustment filter.
    Sets the strength of the nose slimming filter.
    Sets the strength of the nose wing narrowing filter.
    Sets the strength of the eye bag removal filter.
    Sets the strength of the rosy skin filter.
    Sets the strength of the smile line removal filter.
    Sets the strength of the teeth whitening filter.
    Sets the strength of the brightening filter.
    Sets the strength of the wrinkle removal filter.

    Error and warning events

    functions
    desc
    onError
    Error event callback
    onWarning
    Warning event callback

    Room event callback

    functions
    desc
    Result of requesting cross-room call
    Result of ending cross-room call
    Whether room entry is successful
    Room exit
    Role switching
    Result of room switching

    User event callback

    functions
    desc
    The SDK started playing the first audio frame of a remote user
    The SDK started rendering the first video frame of the local or a remote user
    Change of remote audio status
    A user entered the room
    A user exited the room
    Change of remote video status
    The first local audio frame was published
    The first local video frame was published
    A remote user published/unpublished audio
    A remote user published/unpublished substream video
    A remote user published/unpublished primary stream video
    Change of remote video size

    Callback of statistics on network and technical metrics

    functions
    desc
    Real-time network quality statistics
    Callback of network speed test
    Real-time statistics on technical metrics

    Callback of connection to the cloud

    functions
    desc
    The SDK was disconnected from the cloud
    The SDK is reconnected to the cloud
    The SDK is reconnecting to the cloud

    Callback of hardware events

    functions
    desc
    The audio route changed (for mobile devices only)
    The camera is ready
    The mic is ready
    Volume

    Callback of the receipt of a custom message

    functions
    desc
    Loss of custom message
    Receipt of custom message
    Receipt of SEI message

    CDN event callback

    functions
    desc
    Callback for change of RTMP/RTMPS publishing status
    Set the layout and transcoding parameters for On-Cloud MixTranscoding
    Started publishing to non-Tencent Cloud’s live streaming CDN
    Callback for starting to publish
    Started publishing to Tencent Cloud CSS CDN
    Stopped publishing to non-Tencent Cloud’s live streaming CDN
    Callback for stopping publishing
    Stopped publishing to Tencent Cloud CSS CDN
    Callback for modifying publishing parameters

    Screen sharing event callback

    functions
    desc
    Screen sharing was paused
    Screen sharing was resumed
    Screen sharing started
    Screen sharing stopped

    Callback of local recording and screenshot events

    functions
    desc
    Local recording started
    Local recording stopped
    Local media is being recorded
    Finished taking a local screenshot

    Disused callbacks

    functions
    desc
    Audio effects ended (disused)
    Result of server speed testing (disused)
    An anchor entered the room (disused)
    An anchor left the room (disused)

    Callback of custom video processing

    functions
    desc
    An OpenGL context was created in the SDK.
    The OpenGL context in the SDK was destroyed
    Video processing by third-party beauty filters
    Custom video rendering

    Callback of custom audio processing

    functions
    desc
    Audio data captured by the local mic and pre-processed by the audio module
    Audio data captured by the local mic, pre-processed by the audio module, effect-processed and BGM-mixed
    Data mixed from all the captured and to-be-played audio in the SDK
    Data mixed from each channel before being submitted to the system for playback
    Audio data of each remote user before audio mixing

    Other event callbacks

    functions
    desc
    onLog
    Printing of local log

    废弃接口

    functions
    desc
    Query whether a certain audio capability is supported (only for Android)
    Enable or disable in-ear monitoring
    启用音量大小提示
    Enable custom video capturing mode
    Enable/Disable flash
    Get the total length of background music in ms
    Query whether the device supports the automatic recognition of face position
    Query whether the camera supports setting focus
    Query whether the device supports flash
    Query whether the current camera supports zoom
    Pause/Resume publishing local video stream
    Pause/Resume subscribing to remote user's video stream
    Pause sound effect
    Stop background music
    Play sound effect
    Start background music
    Pause sound effect
    Stop background music
    Set animated sticker
    Deliver captured video data to SDK
    Set the volume of all sound effects
    Set sound effect volume
    Set sound quality
    Set the local playback volume of background music
    Set background music playback progress
    Set the remote playback volume of background music
    Set background music volume
    Set the strength of beauty, brightening, and rosy skin filters.
    Set the strength of chin lengthening/shortening filter
    Set the strength of eye enlarging filter
    Set the strength of face shortening filter
    Set the strength of face slimming filter
    Set the strength of chin slimming filter
    Set the strength of color filter
    Set color filter
    Set the focal position of camera
    Set green screen video
    Set the rendering mode of local image
    Set the mirror mode of local camera's preview image
    Set the clockwise rotation angle of local image
    Set mic volume
    Mute animated sticker
    Set the strength of nose slimming filter
    Specify whether to view the big or small image
    Set the fill mode of substream image
    Set the clockwise rotation angle of substream image
    Set the fill mode of substream image
    Set the clockwise rotation angle of remote image
    Set reverb effect
    Setting the system volume type (for mobile OS)
    Set voice changing type
    Set camera zoom ratio (focal length)
    Set sound quality
    Start displaying the substream image of remote user
    Start displaying remote video image
    Start screen sharing
    Start network speed test (used before room entry)
    Stop all sound effects
    Stop sound effect
    Stop background music
    Stop displaying the substream image of remote user
    Stop displaying remote video image and pulling the video data stream of remote user
    Switch camera

    Device APIs for mobile OS (iOS and Android)

    functions
    desc
    Enabling auto focus (for mobile OS)
    Enabling/Disabling flash, i.e., the torch mode (for mobile OS)
    Getting the maximum zoom ratio of the camera (for mobile OS)
    Querying whether automatic face detection is supported (for mobile OS)
    Querying whether the front camera is being used
    Setting the audio route (for mobile OS)
    Adjusting the focus (for mobile OS)
    Setting the camera zoom ratio (for mobile OS)
    Switching to the front/rear camera (for mobile OS)

    Device APIs for desktop OS (Windows & macOS)

    functions
    desc
    Set camera acquisition preferences

    Disused APIs

    functions
    desc
    Setting the system volume type (for mobile OS)

    Background music playback information

    functions
    desc
    Background music playback information

    Definitions of core TRTC classes

    functions
    desc
    Sound effect parameter (disused)
    Format parameter of custom audio callback
    Audio frame data
    Local audio file recording parameters
    Local media file recording parameters
    Description information of each video image in On-Cloud MixTranscoding
    Network QoS control parameter set
    Room entry parameters
    Push parameters required to be set when publishing audio/video streams to non-Tencent Cloud CDN
    The destination URL when you publish to Tencent Cloud or a third-party CDN
    The publishing destination
    Network quality
    Rendering parameters of video image
    Screen sharing parameter (for Android only)
    Network speed testing parameters
    Network speed test result
    The encoding parameters
    The transcoding parameters
    Room switch parameter
    Video texture data
    Layout and transcoding parameters of On-Cloud MixTranscoding
    TRTCUser
    The users whose streams to publish
    Video encoding parameters
    Video frame information
    The video layout of the transcoded stream
    Volume
    The watermark layout

    Local audio/video metrics

    functions
    desc
    Local audio/video metrics

    Remote audio/video metrics

    functions
    desc
    Remote audio/video metrics

    Network and performance metrics

    functions
    desc
    Network and performance metrics
    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