Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
Join Tencent RTC at NAB Show 2024 in Las Vegas!
Learn more 
Only  $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Only $9.9! Get 50,000 minutes with our Starter Plan, perfect for your MVP project.
Grab It Now 
RTC Engine
Overview
  • Web
    • Demo Quick Run
    • SDK Quick Start
    • Basic Features
      • Screen Sharing
      • Live Streaming
      • Media Device
      • Audio Volume
      • Set Encoding Profile
      • Detect Network Quality
      • Detect Capabilities
    • Advance Features
      • Enable AI Denoiser
      • Enable Audio Mixer
      • Enable Watermark
      • SEI Message
      • Custom Capturing and Rendering
      • Web Beautification Effects
    • Best Practices
      • Optimize Multi-Person Video Calls
      • Handle Autoplay Restriction
      • Handle Firewall Restriction
    • API List
    • Released Notes
    • Supported Platforms
    • Web FAQs
  • Android
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Setting Video Quality
      • 10.Rotating Videos
    • Testing Newwork Quality
    • Custom Capturing and Rendering
    • Custom Audio Capturing and Playback
    • Client APIs
      • Overview
      • TRTCCloud
      • TRTCStatistics
      • TRTCCloudListener
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • Type Definition
      • Deprecated Interface
      • Error Codes
    • Release Notes
  • iOS
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Setting Video Quality
      • 10.Rotating Videos
    • Testing Network Quality
    • Custom Capturing and Rendering
    • Custom Audio Capturing and Playback
    • Client APIs
      • Overview
      • TRTCCloud
      • TRTCCloudDelegate
      • TRTCStatistics
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • Type Definition
      • Deprecated Interface
      • ErrorCode
    • Release Notes
  • macOS
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Sharing Computer Audio
      • 10.Setting Video Quality
      • 11.Rotating Videos
    • Testing Hardware Devices
    • Testing Network Quality
    • Custom Capturing and Rendering
    • Custom Audio Capturing and Playback
    • Client APIs
      • Overview
      • TRTCCloud
      • TRTCCloudDelegate
      • TRTCStatistics
      • TXAudioEffectManager
      • TXBeautyManager
      • TXDeviceManager
      • Type Definition
      • Deprecated Interface
      • ErrorCode
      • Release Notes
    • Release Notes
  • Windows C++
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Setting Video Quality
      • 10.Rotating Videos
    • Testing Hardware Devices
    • Testing Network Quality
    • Custom Capturing and Rendering
    • Custom Audio Capturing and Playback
    • Client APIs
      • Overview
      • ITRTCCloud
      • ITRTCStatistics
      • TRTCCloudCallback
      • ITXAudioEffectManager
      • ITXDeviceManager
      • Type Definition
      • Deprecated Interface
      • Error Codes
    • Release Notes
  • Electron
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Sharing Computer Audio
      • 10.Setting Video Quality
      • 11.Rotating Videos
    • Client APIs
      • Overview
      • Error Codes
  • Flutter
    • Integration
      • 1.API Examples
      • 2.Importing the SDK
      • 3.Entering a Room
      • 4.Subscribing to Audio/Video Streams
      • 5.Publish Audio/Video Streams
      • 6.Exiting a Room
      • 7.Sensing Network Quality
      • 8.Enabling Screen Sharing
      • 9.Sharing Computer Audio
      • 10.Setting Video Quality
      • 11.Rotating Videos
    • Client APIs
      • Overview
      • Error Codes
  • Unity
    • Integration
      • 1.API Examples
      • 2Importing the SDK
    • Client APIs
      • Overview
      • Error Codes
  • Qt
    • Integration
      • 1.Importing the SDK
  • Overview
    • Overview
  • Pricing
    • RTC-Engine Packages
    • Billing of On-Cloud Recording
    • Billing of MixTranscoding and Relay to CDN
    • Billing Explanation for Subscription Package Duration
    • Billing of Monitoring Dashboard
    • Free Minutes
    • Pay-As-You-Go
  • Concepts
  • Features
  • Performance Statistics
  • FAQs
    • FAQs for Beginners
    • Migration Guide
      • Twilio Video to Tencent RTC
      • Billing
      • Features
      • UserSig
      • Firewall Restrictions
      • How to Downsize Installation Package
      • TRTCCalling for Web
      • Audio and Video Quality
      • Others
RTC Engine

Deprecated Interface

Copyright (c) 2022 Tencent. All rights reserved.
Deprecated Interface

IDeprecatedTRTCCloud

FuncList
DESC
Enable volume reminder
Enable volume reminder
Set sound quality
Start displaying remote video image
Stop displaying remote video image and pulling the video data stream of remote user
Set the rendering mode of local image
Set the clockwise rotation angle of local image
Set the mirror mode of local camera's preview image
Set the fill mode of substream image
Set the clockwise rotation angle of remote image
Start displaying the substream image of remote user
Stop displaying the substream image of remote user
Set the fill mode of substream image
Set the clockwise rotation angle of substream image
Set sound quality
Specify whether to view the big or small image
Set mic volume
Start background music
Stop background music
Stop background music
Stop background music
Get the total length of background music in ms
Set background music playback progress
Set background music volume
Set the local playback volume of background music
Set the remote playback volume of background music
Play sound effect
Set sound effect volume
Stop sound effect
Stop all sound effects
Set the volume of all sound effects
Pause sound effect
Pause sound effect
Enable custom video capturing mode
Deliver captured video data to SDK
Pause/Resume publishing local video stream
Pause/Resume subscribing to remote user's video stream
Start network speed test (used before room entry)
Start screen sharing
Set video data callback for third-party beauty filters
Get the list of cameras
Set the camera to be used currently
Get the currently used camera
Get the list of mics
Get the current mic device
Select the currently used mic
Get the current mic volume
Set the current mic volume
Set the mute status of the current system mic
Get the mute status of the current system mic
Get the list of speakers
Get the currently used speaker
Set the speaker to use
Get the current speaker volume
Set the current speaker volume
Get the mute status of the current system speaker
Set whether to mute the current system speaker
Start camera test

Start camera test
Start mic test
Start mic test
Start speaker test
Stop speaker test
start in-app screen sharing (for iOS 13.0 and above only)
Set the direction of image output by video encoder
Set the mirror mode of image output by encoder

enableAudioVolumeEvaluation

enableAudioVolumeEvaluation
void enableAudioVolumeEvaluation
(uint32_t interval)

Enable volume reminder

@deprecated This API is not recommended after v10.1. Please use enableAudioVolumeEvaluation(enable, params) instead.

enableAudioVolumeEvaluation

enableAudioVolumeEvaluation
void enableAudioVolumeEvaluation
(uint32_t interval

bool enable_vad)

Enable volume reminder

@deprecated This API is not recommended after v11.2. Please use enableAudioVolumeEvaluation(enable, params) instead.

startLocalAudio

startLocalAudio

Set sound quality

@deprecated This API is not recommended after v8.0. Please use startLocalAudio:quality instead.

startRemoteView

startRemoteView
void startRemoteView
(const char* userId

TXView rendView)

Start displaying remote video image

@deprecated This API is not recommended after v8.0. Please use startRemoteView:streamType:view: instead.

stopRemoteView

stopRemoteView
void stopRemoteView
(const char* userId)

Stop displaying remote video image and pulling the video data stream of remote user

@deprecated This API is not recommended after v8.0. Please use stopRemoteView:streamType: instead.

setLocalViewFillMode

setLocalViewFillMode
void setLocalViewFillMode
(TRTCVideoFillMode mode)

Set the rendering mode of local image

@deprecated This API is not recommended after v8.0. Please use setLocalRenderParams instead.

setLocalViewRotation

setLocalViewRotation
void setLocalViewRotation
(TRTCVideoRotation rotation)

Set the clockwise rotation angle of local image

@deprecated This API is not recommended after v8.0. Please use setLocalRenderParams instead.

setLocalViewMirror

setLocalViewMirror
void setLocalViewMirror
(bool mirror)

Set the mirror mode of local camera's preview image

@deprecated This API is not recommended after v8.0. Please use setLocalRenderParams instead.

setRemoteViewFillMode

setRemoteViewFillMode
void setRemoteViewFillMode
(const char* userId

TRTCVideoFillMode mode)

Set the fill mode of substream image

@deprecated This API is not recommended after v8.0. Please use setRemoteRenderParams:streamType:params: instead.

setRemoteViewRotation

setRemoteViewRotation
void setRemoteViewRotation
(const char* userId

TRTCVideoRotation rotation)

Set the clockwise rotation angle of remote image

@deprecated This API is not recommended after v8.0. Please use setRemoteRenderParams:streamType:params: instead.

startRemoteSubStreamView

startRemoteSubStreamView
void startRemoteSubStreamView
(const char* userId

TXView rendView)

Start displaying the substream image of remote user

@deprecated This API is not recommended after v8.0. Please use startRemoteView:streamType:view: instead.

stopRemoteSubStreamView

stopRemoteSubStreamView
void stopRemoteSubStreamView
(const char* userId)

Stop displaying the substream image of remote user

@deprecated This API is not recommended after v8.0. Please use stopRemoteView:streamType: instead.

setRemoteSubStreamViewFillMode

setRemoteSubStreamViewFillMode
void setRemoteSubStreamViewFillMode
(const char* userId

TRTCVideoFillMode mode)

Set the fill mode of substream image

@deprecated This API is not recommended after v8.0. Please use setRemoteRenderParams:streamType:params: instead.

setRemoteSubStreamViewRotation

setRemoteSubStreamViewRotation
void setRemoteSubStreamViewRotation
(const char* userId

TRTCVideoRotation rotation)

Set the clockwise rotation angle of substream image

@deprecated This API is not recommended after v8.0. Please use setRemoteRenderParams:streamType:params: instead.

setAudioQuality

setAudioQuality
void setAudioQuality
(TRTCAudioQuality quality)

Set sound quality

@deprecated This API is not recommended after v8.0. Please use startLocalAudio:quality instead.

setPriorRemoteVideoStreamType

setPriorRemoteVideoStreamType
void setPriorRemoteVideoStreamType
(TRTCVideoStreamType type)

Specify whether to view the big or small image

@deprecated This API is not recommended after v8.0. Please use startRemoteView:streamType:view: instead.

setMicVolumeOnMixing

setMicVolumeOnMixing
void setMicVolumeOnMixing
(uint32_t volume)

Set mic volume

@deprecated This API is not recommended after v6.9. Please use setAudioCaptureVolume instead.

playBGM

playBGM
void playBGM
(const char* path)

Start background music

@deprecated This API is not recommended after v7.3. Please use getAudioEffectManager instead.

stopBGM

stopBGM

Stop background music

@deprecated This API is not recommended after v7.3. Please use getAudioEffectManager instead.

pauseBGM

pauseBGM

Stop background music

@deprecated This API is not recommended after v7.3. Please use getAudioEffectManager instead.

resumeBGM

resumeBGM

Stop background music

@deprecated This API is not recommended after v7.3. Please use getAudioEffectManager instead.

getBGMDuration

getBGMDuration
uint32_t getBGMDuration
(const char* path)

Get the total length of background music in ms

@deprecated This API is not recommended after v7.3. Please use getMusicDurationInMS API in TXAudioEffectManager instead.

setBGMPosition

setBGMPosition
void setBGMPosition
(uint32_t pos)

Set background music playback progress

@deprecated This API is not recommended after v7.3. Please use seekMusicToPosInMS API in TXAudioEffectManager instead.

setBGMVolume

setBGMVolume
void setBGMVolume
(uint32_t volume)

Set background music volume

@deprecated This API is not recommended after v7.3. Please use setMusicVolume API in TXAudioEffectManager instead.

setBGMPlayoutVolume

setBGMPlayoutVolume
void setBGMPlayoutVolume
(uint32_t volume)

Set the local playback volume of background music

@deprecated This API is not recommended after v7.3. Please use setMusicPlayoutVolume API in TXAudioEffectManager instead.

setBGMPublishVolume

setBGMPublishVolume
void setBGMPublishVolume
(uint32_t volume)

Set the remote playback volume of background music

@deprecated This API is not recommended after v7.3. Please use setBGMPublishVolume API in TXAudioEffectManager instead.

playAudioEffect

playAudioEffect
void playAudioEffect
(TRTCAudioEffectParam* effect)

Play sound effect

@deprecated This API is not recommended after v7.3. Please use startPlayMusic API in TXAudioEffectManager instead.

setAudioEffectVolume

setAudioEffectVolume
void setAudioEffectVolume
(int effectId

int volume)

Set sound effect volume

@deprecated This API is not recommended after v7.3. Please use setMusicPublishVolume and setMusicPlayoutVolume API in TXAudioEffectManager instead.

stopAudioEffect

stopAudioEffect
void stopAudioEffect
(int effectId)

Stop sound effect

@deprecated This API is not recommended after v7.3. Please use stopPlayMusic API in TXAudioEffectManager instead.

stopAllAudioEffects

stopAllAudioEffects

Stop all sound effects

@deprecated This API is not recommended after v7.3. Please use stopPlayMusic API in TXAudioEffectManager instead.

setAllAudioEffectsVolume

setAllAudioEffectsVolume
void setAllAudioEffectsVolume
(int volume)

Set the volume of all sound effects

@deprecated This API is not recommended after v7.3. Please use setMusicPublishVolume and setMusicPlayoutVolume API in TXAudioEffectManager instead.

pauseAudioEffect

pauseAudioEffect
void pauseAudioEffect
(int effectId)

Pause sound effect

@deprecated This API is not recommended after v7.3. Please use pauseAudioEffect API in TXAudioEffectManager instead.

resumeAudioEffect

resumeAudioEffect
void resumeAudioEffect
(int effectId)

Pause sound effect

@deprecated This API is not recommended after v7.3. Please use resumePlayMusic API in TXAudioEffectManager instead.

enableCustomVideoCapture

enableCustomVideoCapture
void enableCustomVideoCapture
(bool enable)

Enable custom video capturing mode

@deprecated This API is not recommended after v8.5. Please use enableCustomVideoCapture instead.

sendCustomVideoData

sendCustomVideoData
void sendCustomVideoData
(TRTCVideoFrame* frame)

Deliver captured video data to SDK

@deprecated This API is not recommended after v8.5. Please use sendCustomVideoData instead.

muteLocalVideo

muteLocalVideo
void muteLocalVideo
(bool mute)

Pause/Resume publishing local video stream

@deprecated This API is not recommended after v8.9. Please use muteLocalVideo (streamType, mute) instead.

muteRemoteVideoStream

muteRemoteVideoStream
void muteRemoteVideoStream
(const char* userId

bool mute)

Pause/Resume subscribing to remote user's video stream

@deprecated This API is not recommended after v8.9. Please use muteRemoteVideoStream (userId, streamType, mute) instead.

startSpeedTest

startSpeedTest
void startSpeedTest
(uint32_t sdkAppId

const char* userId

const char* userSig)

Start network speed test (used before room entry)

@deprecated This API is not recommended after v9.2. Please use startSpeedTest (params) instead.

startScreenCapture

startScreenCapture
void startScreenCapture
(TXView rendView)

Start screen sharing

@deprecated This API is not recommended after v7.2. Please use startScreenCapture:streamType:encParam: instead.

setLocalVideoProcessCallback

setLocalVideoProcessCallback
int setLocalVideoProcessCallback
(TRTCVideoPixelFormat pixelFormat

TRTCVideoBufferType bufferType

ITRTCVideoFrameCallback* callback)

Set video data callback for third-party beauty filters

@deprecated This API is not recommended after v11.4. Please use the enableLocalVideoCustomProcess and setLocalVideoCustomProcessCallback instead.

getCameraDevicesList

getCameraDevicesList

Get the list of cameras

@deprecated This API is not recommended after v8.0. Please use the getDevicesList API in TXDeviceManager instead.

setCurrentCameraDevice

setCurrentCameraDevice
void setCurrentCameraDevice
(const char* deviceId)

Set the camera to be used currently

@deprecated This API is not recommended after v8.0. Please use the setCurrentDevice API in TXDeviceManager instead.

getCurrentCameraDevice

getCurrentCameraDevice

Get the currently used camera

@deprecated This API is not recommended after v8.0. Please use the getCurrentDevice API in TXDeviceManager instead.

getMicDevicesList

getMicDevicesList

Get the list of mics

@deprecated This API is not recommended after v8.0. Please use the getDevicesList API in TXDeviceManager instead.

getCurrentMicDevice

getCurrentMicDevice

Get the current mic device

@deprecated This API is not recommended after v8.0. Please use the getCurrentDevice API in TXDeviceManager instead.

setCurrentMicDevice

setCurrentMicDevice
void setCurrentMicDevice
(const char* micId)

Select the currently used mic

@deprecated This API is not recommended after v8.0. Please use the setCurrentDevice API in TXDeviceManager instead.

getCurrentMicDeviceVolume

getCurrentMicDeviceVolume

Get the current mic volume

@deprecated This API is not recommended after v8.0. Please use the getCurrentDeviceVolume API in TXDeviceManager instead.

setCurrentMicDeviceVolume

setCurrentMicDeviceVolume
void setCurrentMicDeviceVolume
(uint32_t volume)

Set the current mic volume

@deprecated This API is not recommended after v8.0. Please use the setCurrentDeviceVolume API in TXDeviceManager instead.

setCurrentMicDeviceMute

setCurrentMicDeviceMute
void setCurrentMicDeviceMute
(bool mute)

Set the mute status of the current system mic

@deprecated This API is not recommended after v8.0. Please use the setCurrentDeviceMute API in TXDeviceManager instead.

getCurrentMicDeviceMute

getCurrentMicDeviceMute

Get the mute status of the current system mic

@deprecated This API is not recommended after v8.0. Please use the getCurrentDeviceMute API in TXDeviceManager instead.

getSpeakerDevicesList

getSpeakerDevicesList

Get the list of speakers

@deprecated This API is not recommended after v8.0. Please use the getDevicesList API in TXDeviceManager instead.

getCurrentSpeakerDevice

getCurrentSpeakerDevice

Get the currently used speaker

@deprecated This API is not recommended after v8.0. Please use the getCurrentDevice API in TXDeviceManager instead.

setCurrentSpeakerDevice

setCurrentSpeakerDevice
void setCurrentSpeakerDevice
(const char* speakerId)

Set the speaker to use

@deprecated This API is not recommended after v8.0. Please use the setCurrentDevice API in TXDeviceManager instead.

getCurrentSpeakerVolume

getCurrentSpeakerVolume

Get the current speaker volume

@deprecated This API is not recommended after v8.0. Please use the getCurrentDeviceVolume API in TXDeviceManager instead.

setCurrentSpeakerVolume

setCurrentSpeakerVolume
void setCurrentSpeakerVolume
(uint32_t volume)

Set the current speaker volume

@deprecated This API is not recommended after v8.0. Please use the setCurrentDeviceVolume API in TXDeviceManager instead.

getCurrentSpeakerDeviceMute

getCurrentSpeakerDeviceMute

Get the mute status of the current system speaker

@deprecated This API is not recommended after v8.0. Please use the getCurrentDeviceMute API in TXDeviceManager instead.

setCurrentSpeakerDeviceMute

setCurrentSpeakerDeviceMute
void setCurrentSpeakerDeviceMute
(bool mute)

Set whether to mute the current system speaker

@deprecated This API is not recommended after v8.0. Please use the setCurrentDeviceMute API in TXDeviceManager instead.

startCameraDeviceTest

startCameraDeviceTest
void startCameraDeviceTest
(TXView renderView)

Start camera test

@deprecated This API is not recommended after v8.0. Please use the startCameraDeviceTest API in TXDeviceManager instead.

stopCameraDeviceTest

stopCameraDeviceTest

Start camera test

@deprecated This API is not recommended after v8.0. Please use the stopCameraDeviceTest API in TXDeviceManager instead.

startMicDeviceTest

startMicDeviceTest
void startMicDeviceTest
(uint32_t interval)

Start mic test

@deprecated This API is not recommended after v8.0. Please use the startMicDeviceTest API in TXDeviceManager instead.

stopMicDeviceTest

stopMicDeviceTest

Start mic test

@deprecated This API is not recommended after v8.0. Please use the stopMicDeviceTest API in TXDeviceManager instead.

startSpeakerDeviceTest

startSpeakerDeviceTest
void startSpeakerDeviceTest
(const char* testAudioFilePath)

Start speaker test

@deprecated This API is not recommended after v8.0. Please use the startSpeakerDeviceTest API in TXDeviceManager instead.

stopSpeakerDeviceTest

stopSpeakerDeviceTest

Stop speaker test

@deprecated This API is not recommended after v8.0. Please use the stopSpeakerDeviceTest API in TXDeviceManager instead.

selectScreenCaptureTarget

selectScreenCaptureTarget
void selectScreenCaptureTarget
(const TRTCScreenCaptureSourceInfo& source

const RECT& captureRect

bool captureMouse = true

bool highlightWindow = true)

start in-app screen sharing (for iOS 13.0 and above only)

@deprecated This API is not recommended after v8.6. Please use startScreenCaptureInApp instead.

setVideoEncoderRotation

setVideoEncoderRotation
void setVideoEncoderRotation
(TRTCVideoRotation rotation)

Set the direction of image output by video encoder

@deprecated It is deprecated starting from v11.7.

setVideoEncoderMirror

setVideoEncoderMirror
void setVideoEncoderMirror
(bool mirror)

Set the mirror mode of image output by encoder

@deprecated It is deprecated starting from v11.7.