tencent cloud

Feedback

Overview

Last updated: 2022-02-21 17:01:28

    TRTCCloud @ TXLiteAVSDK

    Instance creation and event callback APIs

    API Description
    sharedInstance Creates a TRTCCloud instance (singleton).
    destroySharedIntance Terminates a TRTCCloud instance (singleton).
    delegate Sets TRTC event callbacks.
    delegateQueue Sets the queue that drives TRTCCloudDelegate callbacks.

    Room APIs

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

    CDN APIs

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

    Video APIs

    API Description
    startLocalPreview Enables local camera preview (mobile).
    startLocalPreview Enables local camera preview (desktop).
    updateLocalView Updates local camera preview.
    stopLocalPreview Disables local camera preview.
    muteLocalVideo Pauses/Resumes publishing the local video stream.
    setVideoMuteImage Sets the image to display when local video is paused.
    startRemoteView Subscribes to a remote user’s video stream and binds a video rendering control.
    updateRemoteView Updates a remote user’s video rendering control.
    stopRemoteView Unsubscribes from a remote user’s video stream and unbinds the rendering control.
    stopAllRemoteView Unsubscribes from all remote users’ video streams and unbinds all rendering controls.
    muteRemoteVideoStream Pauses/Resumes receiving a remote user’s video stream.
    muteAllRemoteVideoStreams Pauses/Resumes receiving all remote users’ video streams.
    setVideoEncoderParam Sets video encoder parameters.
    setNetworkQosParam Sets video preference.
    setLocalRenderParams Sets rendering parameters for the local image.
    setRemoteRenderParams Sets rendering parameters for a remote image.
    setVideoEncoderRotation Sets the rotation of encoded video images.
    setVideoEncoderMirror Sets the mirror mode of encoded images.
    setGSensorMode Sets the adaptation mode of the G-sensor.
    enableEncSmallVideoStream Enables/Disables the dual-channel (big and small images) encoding mode.
    setRemoteVideoStreamType Switches between the small and big images of a remote user.
    snapshotVideo Takes a video screenshot.

    Audio APIs

    API Description
    startLocalAudio Starts local audio capturing and publishing.
    stopLocalAudio Stops local audio capturing and publishing.
    muteLocalAudio Pauses/Resumes publishing the local audio stream.
    muteRemoteAudio Pauses/Resumes playing the audio stream of a remote user.
    muteAllRemoteAudio Pauses/Resumes playing the audio streams of all remote users.
    setAudioRoute Sets the audio route.
    setRemoteAudioVolume Sets the playback volume of a remote user.
    setAudioCaptureVolume Sets the local audio capturing volume.
    getAudioCaptureVolume Gets the local audio capturing volume.
    setAudioPlayoutVolume Sets the playback volume of remote audio.
    getAudioPlayoutVolume Gets the playback volume of remote audio.
    enableAudioVolumeEvaluation Enables the volume reminder.
    startAudioRecording Starts audio recording.
    stopAudioRecording Stops audio recording.
    startLocalRecording Starts local media recording.
    stopLocalRecording Stops local media recording.
    setRemoteAudioParallelParams Configures policy for the playback of the audio of multiple remote speakers.

    Device management APIs

    API Description
    getDeviceManager Gets the device management class TXDeviceManager.

    Beauty filter and watermark APIs

    API Description
    getBeautyManager Gets the beauty filter management class TXBeautyManager.
    setWatermark Adds watermarks.

    Background music and audio effect APIs

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

    Screen sharing APIs

    API Description
    startScreenCaptureInApp Starts in-application screen sharing (for iOS 13.0 or above).
    startScreenCaptureByReplaykit Starts system-level screen sharing (for iOS 11.0 or above).
    startScreenCapture Starts desktop screen sharing (for desktop systems only).
    stopScreenCapture Stops screen sharing.
    pauseScreenCapture Pauses screen sharing.
    resumeScreenCapture Resumes screen sharing.
    getScreenCaptureSourcesWithThumbnailSize Enumerates shareable screens and windows (for macOS only).
    selectScreenCaptureTarget Selects a screen or window to share (for macOS only).
    setSubStreamEncoderParam Sets encoding parameters for screen sharing (substream video). This API works on both desktop and mobile OS.
    setSubStreamMixVolume Sets audio mixing volume for screen sharing (for desktop systems only).
    addExcludedShareWindow Adds a window to the exclusion list of screen sharing (for desktop systems only).
    removeExcludedShareWindow Removes a window from the exclusion list of screen sharing (for desktop systems only).
    removeAllExcludedShareWindows Removes all windows from the exclusion list of screen sharing (for desktop systems only).
    addIncludedShareWindow Adds a window to the screen sharing list (for desktop systems only).
    removeIncludedShareWindow Removes a window from the screen sharing list (for desktop systems only).
    removeAllIncludedShareWindows Removes all windows from the screen sharing list (for desktop systems only).

    Custom capturing and rendering APIs

    API Description
    enableCustomVideoCapture Enables/Disables custom video capturing.
    sendCustomVideoData Sends captured video frames to the SDK.
    enableCustomAudioCapture Enables/Disables custom audio capturing.
    sendCustomAudioData Sends captured audio data to the SDK.
    enableMixExternalAudioFrame Enables/Disables custom audio tracks.
    mixExternalAudioFrame Mixes a custom audio track into the SDK.
    setMixExternalAudioVolume Sets the publishing and playback volumes of external audio mixed into the published stream.
    generateCustomPTS Gets the PTS for custom capturing.
    setLocalVideoProcessDelegete Sets the callback of video data for the application of third-party beauty filters.
    setLocalVideoRenderDelegate Sets the callback of local video for custom rendering.
    setRemoteVideoRenderDelegate Sets the callback of a remote video for custom rendering.
    setAudioFrameDelegate Sets the callback of audio data for custom rendering.
    setCapturedRawAudioFrameDelegateFormat Sets the format of the callback of raw audio frames captured by the local mic.
    setLocalProcessedAudioFrameDelegateFormat Sets the format of the callback of audio frames captured locally and pre-processed by the audio module.
    setMixedPlayAudioFrameDelegateFormat Sets the format of the callback of audio frames played by the system.
    enableCustomAudioRendering Enables/Disables custom audio rendering.
    getCustomAudioRenderingFrame Gets playable audio frames.

    Custom message sending APIs

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

    Network testing APIs

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

    Debugging APIs

    API Description
    getSDKVersion Gets the SDK version.
    setLogLevel Sets the log output level.
    setConsoleEnabled Enables/Disables console log printing.
    setLogCompressEnabled Enables/Disables local log compression.
    setLogDirPath Sets the path to save local logs.
    setLogDelegate Sets the log callback.
    showDebugView Sets whether to display the dashboard.
    setDebugViewMargin Sets the dashboard margin.
    callExperimentalAPI Calls the experimental API.

    Disused APIs

    API Description
    setMicVolumeOnMixing Sets the mic volume.
    setBeautyStyle Sets the strength of the beauty, brightening, and rosy skin filters.
    setEyeScaleLevel Sets the strength of the eye enlarging filter.
    setFaceScaleLevel Sets the strength of the face slimming filter.
    setFaceVLevel Sets the strength of the chin slimming filter.
    setChinLevel Sets the strength of the jaw lengthening/shortening filter.
    setFaceShortLevel Sets the strength of the face shortening filter.
    setNoseSlimLevel Sets the strength of the nose slimming filter.
    selectMotionTmpl Sets animated stickers.
    setMotionMute Mutes/Unmutes animated effects.
    startScreenCapture Starts screen sharing.
    setFilter Sets the color filter.
    setFilterConcentration Sets the strength of the color filter.
    setGreenScreenFile Sets green screen effects.
    playBGM Starts background music.
    stopBGM Stops background music.
    pauseBGM Pauses background music.
    resumeBGM Resumes background music.
    getBGMDuration Gets the total length of the music file, in milliseconds.
    setBGMPosition Sets the playback progress of background music.
    setBGMVolume Sets the volume of background music.
    setBGMPlayoutVolume Sets the local playback volume of background music.
    setBGMPublishVolume Sets the remote playback volume of background music.
    setReverbType Sets the reverb effect.
    setVoiceChangerType Sets the voice changing effect.
    playAudioEffect Plays an audio effect.
    setAudioEffectVolume Sets the volume of an audio effect.
    stopAudioEffect Stops an audio effect.
    stopAllAudioEffects Stops all audio effects.
    setAllAudioEffectsVolume Sets the volume of all audio effects.
    pauseAudioEffect Pauses an audio effect.
    resumeAudioEffect Resumes an audio effect.
    enableAudioEarMonitoring Enables/Disables in-ear monitoring.
    startRemoteView Plays the video of a remote user.
    stopRemoteView Stops playing the video of a remote user and pulling the user’s video data.
    setRemoteViewFillMode Sets the rendering mode of a remote image.
    setRemoteViewRotation Sets the clockwise rotation of a remote image.
    setLocalViewFillMode Sets the rendering mode of the local image.
    setLocalViewRotation Sets the clockwise rotation of the local image.
    setLocalViewMirror Sets the mirror mode of the local camera's preview image.
    startRemoteSubStreamView Starts playing the substream video of a remote user.
    stopRemoteSubStreamView Stops playing the substream video of a remote user.
    setRemoteSubStreamViewFillMode Sets the fill mode of the substream video of a remote user.
    setRemoteSubStreamViewRotation Sets the clockwise rotation of the substream video of a remote user.
    setPriorRemoteVideoStreamType Sets playback preference.
    setAudioQuality Sets audio quality.
    startLocalAudio Enables local audio capturing and publishing.
    switchCamera Switches cameras.
    isCameraZoomSupported Queries whether the current camera supports zoom.
    setZoom Sets the camera zoom factor (focal length).
    isCameraTorchSupported Queries whether the camera supports flash.
    enbaleTorch Enables/Disables flash.
    isCameraFocusPositionInPreviewSupported Queries whether the camera supports focus setting.
    setFocusPosition Sets the coordinates of camera focus.
    isCameraAutoFocusFaceModeSupported Queries whether the camera supports automatic facial recognition.
    enableAutoFaceFoucs Enables/Disables auto focus on face.
    startCameraDeviceTestInView Starts camera testing.
    stopCameraDeviceTest Stops camera testing.
    startMicDeviceTest Starts mic testing.
    stopMicDeviceTest Stops mic testing.
    startSpeakerDeviceTest Starts speaker testing.
    stopSpeakerDeviceTest Stops speaker testing.
    getMicDevicesList Gets the mic list.
    getCurrentMicDevice Gets the mic currently in use.
    setCurrentMicDevice Sets the mic to use.
    getCurrentMicDeviceVolume Gets the current mic volume.
    setCurrentMicDeviceVolume Sets the current mic volume.
    getCurrentMicDeviceMute Gets whether the current mic is muted.
    setCurrentMicDeviceMute Mutes/Unmutes the current mic.
    getSpeakerDevicesList Gets the speaker list.
    getCurrentSpeakerDevice Gets the speaker currently in use.
    setCurrentSpeakerDevice Sets the speaker to use.
    getCurrentSpeakerDeviceVolume Gets the current speaker volume.
    setCurrentSpeakerDeviceVolume Sets the current speaker volume.
    getCurrentSpeakerDeviceMute Gets whether the current speaker is muted.
    setCurrentSpeakerDeviceMute Mutes/Unmutes the current speaker.
    getCameraDevicesList Gets the camera list.
    getCurrentCameraDevice Gets the camera currently in use.
    setCurrentCameraDevice Sets the camera to use.
    setSystemVolumeType Sets the system volume type.
    snapshotVideo Takes a video screenshot.
    enableCustomVideoCapture Enables/Disables custom video capturing.
    sendCustomVideoData Sends captured video data to the SDK.
    startScreenCaptureInApp Starts in-application screen sharing (for iOS).
    startScreenCaptureByReplaykit Starts system-level screen sharing (for iOS).
    muteLocalVideo Pauses/Resumes publishing the local video stream.
    muteRemoteVideoStream Pauses/Resumes receiving a remote user’s video stream.
    startSpeedTest Starts network speed testing. This API must be called before room entry.

    Error and warning callback APIs

    API Description
    onError Callback for errors
    onWarning Callback for warnings

    Room event callback APIs

    API Description
    onEnterRoom Callback of the result of room entry
    onExitRoom Callback for room exit
    onSwitchRole Callback for role switching
    onSwitchRoom Callback for room switching
    onConnectOtherRoom Callback of the result of requesting a cross-room call
    onDisconnectOtherRoom Callback of the result of ending a cross-room call

    User event callback APIs

    API Description
    onRemoteUserEnterRoom Callback for the entry of a user
    onRemoteUserLeaveRoom Callback for the exit of a user
    onUserVideoAvailable Callback for publishing/unpublishing the primary-stream video by a remote user
    onUserSubStreamAvailable Callback for publishing/unpublishing the substream video by a remote user
    onUserAudioAvailable Callback for publishing/unpublishing audio by a remote user
    onFirstVideoFrame Callback for rendering the first video frame of the local user or a remote user
    onFirstAudioFrame Callback for playing the first audio frame of a remote user
    onSendFirstLocalVideoFrame Callback for sending the first local video frame
    onSendFirstLocalAudioFrame Callback for sending the first local audio frame
    onRemoteVideoStatusUpdated Callback for change of the video status of a remote user

    Callback APIs for statistics on network and technical metrics

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

    Callback APIs for change of connection status

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

    Hardware event callback APIs

    API Description
    onCameraDidReady Callback for the camera being ready
    onMicDidReady Callback for the mic being ready
    onAudioRouteChanged Callback for change of the audio route (for mobile devices only)
    onUserVoiceVolume Callback of volume
    onDevice Callback of the connection/disconnection of a local device (for desktop systems only)
    onAudioDeviceCaptureVolumeChanged Callback for change of the mic’s system audio capturing volume
    onAudioDevicePlayoutVolumeChanged Callback for change of the system’s playback volume
    onSystemAudioLoopbackError Callback of whether system audio capturing is enabled successfully (for macOS only)

    Callback APIs for receiving custom messages

    API Description
    onRecvCustomCmdMsgUserId Callback for receiving a custom message
    onMissCustomCmdMsgUserId Callback for losing a custom message
    onRecvSEIMsg Callback for receiving an SEI message

    CDN event callback APIs

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

    Screen sharing callback APIs

    API Description
    onScreenCaptureStarted Callback for starting screen sharing
    onScreenCapturePaused Callback for pausing screen sharing
    onScreenCaptureResumed Callback for resuming screen sharing
    onScreenCaptureStoped Callback for stopping screen sharing

    Callback APIs for local recording and screenshot taking

    API Description
    onLocalRecordBegin Callback for starting local recording
    onLocalRecording Callback of the progress of local recording
    onLocalRecordComplete Callback for ending local recording

    Disused callback APIs

    API Description
    onUserEnter Callback for the entry of an anchor (disused)
    onUserExit Callback for the exit of an anchor (disused)
    onAudioEffectFinished Callback for ending an audio effect (disused)

    Callback APIs for custom video

    API Description
    onRenderVideoFrame Callback of video frames for custom rendering
    onProcessVideoFrame Callback of video frames for processing by third-party beauty filters
    onGLContextDestory Callback for destroying the OpenGL context in the SDK

    Callback APIs for custom audio

    API Description
    onCapturedRawAudioFrame Callback of audio data captured by the local mic and pre-processed by the audio module
    onLocalProcessedAudioFrame Callback of locally captured audio data that is pre-processed by the audio module, added with audio effects, and mixed with background music
    onRemoteUserAudioFrame Callback of the audio data of each remote user before audio mixing
    onMixedPlayAudioFrame Callback of data mixed from the audio of each user before playback
    onMixedAllAudioFrame Callback of data mixed from all audios in the SDK, including captured and to-be-played audio

    Other callback APIs

    API Description
    onLog Callback for printing local logs

    Definitions of video enumerated values

    API Description
    TRTCVideoResolution Resolution
    TRTCVideoResolutionMode Aspect ratio mode
    TRTCVideoStreamType Stream type
    TRTCVideoFillMode Image fill mode
    TRTCVideoRotation Rotation
    TRTCBeautyStyle Beauty filter (skin smoothing) algorithm
    TRTCVideoPixelFormat Pixel format
    TRTCVideoBufferType Video data transfer method
    TRTCVideoMirrorType Mirror mode
    TRTCSnapshotSourceType Source of local screenshots

    Definitions of network enumerated values

    API Description
    TRTCAppScene Application scenario
    TRTCRoleType Role
    TRTCQosControlMode QoS control mode (disused)
    TRTCVideoQosPreference Video quality preference
    TRTCQualityInfo Network quality
    TRTCAVStatusType Video status
    TRTCAVStatusChangeReason Reason for change of video status

    Definitions of audio enumerated values

    API Description
    TRTCAudioSampleRate Audio sample rate
    TRTCAudioQuality Audio quality
    TRTCAudioRoute Audio route (audio playback mode)
    TRTCReverbType Reverb effect
    TRTCVoiceChangerType Voice changing effect
    TRTCSystemVolumeType System volume type (for mobile devices only)

    Definitions of other enumerated values

    API Description
    TRTCLogLevel Log level
    TRTCGSensorMode G-sensor mode (for mobile devices only)
    TRTCScreenCaptureSourceType Type of the content to share (for desktop systems only)
    TRTCTranscodingConfigMode Layout mode for On-Cloud MixTranscoding
    TRTCRecordType Type of media to record
    TRTCMixInputType Input type for stream mixing
    TRTCMediaDeviceType Device type (for desktop systems only)
    TRTCAudioRecordingContent Type of audio to record

    Definitions of TRTC key types

    API Description
    TRTCParams Room entry parameters
    TRTCVideoEncParam Video encoding parameters
    TRTCNetworkQosParam QoS control parameters
    TRTCRenderParams Video rendering parameters
    TRTCQualityInfo Network quality
    TRTCVolumeInfo Volume
    TRTCSpeedTestParams Network speed testing parameters
    TRTCSpeedTestResult Results of network speed testing
    TRTCVideoFrame Video frame information
    TRTCAudioFrame Audio frame information
    TRTCMixUser Information of each channel in On-Cloud MixTranscoding
    TRTCTranscodingConfig Layout and transcoding parameters for On-Cloud MixTranscoding
    TRTCPublishCDNParam Relaying parameters for publishing audio/video streams to a non-Tencent Cloud CDN
    TRTCAudioRecordingParams Local audio recording parameters
    TRTCLocalRecordingParams Local media recording parameters
    TRTCAudioEffectParam Audio effect parameters (disused)
    TRTCSwitchRoomConfig Room switching parameters
    TRTCAudioFrameDelegateFormat Format of the custom audio callback
    TRTCScreenCaptureSourceInfo 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