Starter Deal! First 3 month from only  $9.9 /month!
Starter Deal! First 3 month from only  $9.9 /month!
Grab It Now 
RTC Engine
  • Overview
  • Web
    • Run Sample Demo
    • SDK Quickstart
    • 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
      • Enable Beauty and Effects
      • Data Messages
      • Custom Capturing and Rendering
    • API List
    • Released Notes
    • Supported Platforms
    • Web FAQs
      • Optimize Multi-Person Video Calls
      • Handle Autoplay Restriction
      • Handle Firewall Restriction
      • Others
  • 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
    • Solution
      • Real-Time Chorus (TUIKaraoke)
        • Quick Integration
        • Implementation Steps
        • Song Synchronization
        • Lyric Synchronization
        • Vocal Synchronization
        • Mixing Stream Solution
        • TRTCKaraoke APIs
        • FAQs
    • 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
    • Solution
      • Quick Integration
      • Implementation Steps
      • Song Synchronization
      • Lyric Synchronization
      • Vocal Synchronization
      • Mixing Stream Solution
      • TRTCKaraoke APIs
      • FAQs
    • 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
    • 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
  • Concepts
  • Features
  • Performance Statistics
  • 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
  • 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.
Deprecate

DeprecatedTRTCCloud

FuncList
DESC
Set TRTC event callback
Set the strength of beauty, brightening, and rosy skin filters.
Set the strength of eye enlarging filter
Set the strength of face slimming filter
Set the strength of chin slimming filter
Set the strength of chin lengthening/shortening filter
Set the strength of face shortening filter
Set the strength of nose slimming filter
Set animated sticker
Mute animated sticker
Set color filter
Set the strength of color filter
Set green screen video
Set reverb effect
Set voice changing type
Enable or disable in-ear monitoring
Enable volume reminder
Enable volume reminder
Switch camera
Query whether the current camera supports zoom
Set camera zoom ratio (focal length)
Query whether the device supports flash
Enable/Disable flash
Query whether the camera supports setting focus
Set the focal position of camera
Query whether the device supports the automatic recognition of face position
Setting the system volume type (for mobile OS)
Query whether a certain audio capability is supported (only for Android)
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
Screencapture video
Start network speed test (used before room entry)
Start screen sharing
Set the direction of image output by video encoder
Set the mirror mode of image output by encoder
Set the adaptation mode of G-sensor

setListener

setListener
void setListener
(TRTCCloudListener listener)

Set TRTC event callback

@deprecated This API is not recommended after v11.4 Please use addListener instead.

setBeautyStyle

setBeautyStyle
void setBeautyStyle
(int beautyStyle

int beautyLevel

int whitenessLevel

int ruddinessLevel)

Set the strength of beauty, brightening, and rosy skin filters.

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

setEyeScaleLevel

setEyeScaleLevel
void setEyeScaleLevel
(int eyeScaleLevel)

Set the strength of eye enlarging filter

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

setFaceSlimLevel

setFaceSlimLevel
void setFaceSlimLevel
(int faceScaleLevel)

Set the strength of face slimming filter

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

setFaceVLevel

setFaceVLevel
void setFaceVLevel
(int faceVLevel)

Set the strength of chin slimming filter

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

setChinLevel

setChinLevel
void setChinLevel
(int chinLevel)

Set the strength of chin lengthening/shortening filter

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

setFaceShortLevel

setFaceShortLevel
void setFaceShortLevel
(int faceShortlevel)

Set the strength of face shortening filter

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

setNoseSlimLevel

setNoseSlimLevel
void setNoseSlimLevel
(int noseSlimLevel)

Set the strength of nose slimming filter

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

selectMotionTmpl

selectMotionTmpl
void selectMotionTmpl
(String motionPath)

Set animated sticker

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

setMotionMute

setMotionMute
void setMotionMute
(boolean motionMute)

Mute animated sticker

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

setFilter

setFilter
void setFilter
(Bitmap image)

Set color filter

@deprecated This API is not recommended after v7.2. Please use getBeautyManager instead.

setFilterConcentration

setFilterConcentration
void setFilterConcentration
(float concentration)

Set the strength of color filter

@deprecated This API is not recommended after v7.2. Please use getBeautyManager instead.

setGreenScreenFile

setGreenScreenFile
boolean setGreenScreenFile
(String file)

Set green screen video

@deprecated This API is not recommended after v7.2. Please use getBeautyManager instead.

setReverbType

setReverbType
void setReverbType
(int reverbType)

Set reverb effect

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

setVoiceChangerType

setVoiceChangerType
boolean setVoiceChangerType
(int voiceChangerType)

Set voice changing type

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

enableAudioEarMonitoring

enableAudioEarMonitoring
void enableAudioEarMonitoring
(boolean enable)

Enable or disable in-ear monitoring

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

enableAudioVolumeEvaluation

enableAudioVolumeEvaluation
void enableAudioVolumeEvaluation
(int interval)

Enable volume reminder

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

enableAudioVolumeEvaluation

enableAudioVolumeEvaluation
void enableAudioVolumeEvaluation
(int interval

boolean enable_vad)

Enable volume reminder

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

switchCamera

switchCamera

Switch camera

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

isCameraZoomSupported

isCameraZoomSupported

Query whether the current camera supports zoom

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

setZoom

setZoom
void setZoom
(int distance)

Set camera zoom ratio (focal length)

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

isCameraTorchSupported

isCameraTorchSupported

Query whether the device supports flash

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

enableTorch

enableTorch
boolean enableTorch
(boolean enable)

Enable/Disable flash

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

isCameraFocusPositionInPreviewSupported

isCameraFocusPositionInPreviewSupported

Query whether the camera supports setting focus

@deprecated This API is not recommended after v8.0.

setFocusPosition

setFocusPosition
void setFocusPosition
(int x

int y)

Set the focal position of camera

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

isCameraAutoFocusFaceModeSupported

isCameraAutoFocusFaceModeSupported

Query whether the device supports the automatic recognition of face position

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

setSystemVolumeType

setSystemVolumeType
void setSystemVolumeType
(int type)

Setting the system volume type (for mobile OS)

@deprecated This API is not recommended after v8.0. Please use the startLocalAudio instead, which param quality is used to decide audio quality.

checkAudioCapabilitySupport

checkAudioCapabilitySupport
int checkAudioCapabilitySupport
(int capabilityType)

Query whether a certain audio capability is supported (only for Android)

@deprecated This API is not recommended after v10.1
Param
DESC
capabilityType
Audio capability type.
TRTCAudioCapabilityLowLatencyChorus,Low-latency chorus capability.
TRTCAudioCapabilityLowLatencyEarMonitor,Low-latency earmonitor capability.

Return Desc:

0:supported;1:supported。

startLocalAudio

startLocalAudio

Set sound quality

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

startRemoteView

startRemoteView
void startRemoteView
(String userId

TXCloudVideoView view)

Start displaying remote video image

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

stopRemoteView

stopRemoteView
void stopRemoteView
(String 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
(int 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
(int 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
(int mirrorType)

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
(String userId

int 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
(String userId

int 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
(String userId

TXCloudVideoView view)

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
(String 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
(String userId

int 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
(final String userId

final int 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
(int quality)

Set sound quality

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

setPriorRemoteVideoStreamType

setPriorRemoteVideoStreamType
int setPriorRemoteVideoStreamType
(int streamType)

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
(int volume)

Set mic volume

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

playBGM

playBGM
void playBGM
(String path

TRTCCloud.BGMNotify notify)

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
int getBGMDuration
(String 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
int setBGMPosition
(int 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
(int 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
(int 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
(int 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
(TRTCCloudDef.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
(boolean enable)

Enable custom video capturing mode

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

sendCustomVideoData

sendCustomVideoData
void sendCustomVideoData
(TRTCCloudDef.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
(boolean 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
(String userId

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

snapshotVideo

snapshotVideo
void snapshotVideo
(String userId

int streamType

TRTCCloudListener.TRTCSnapshotListener listener)

Screencapture video

@deprecated This API is not recommended after v11.0. Please use snapshotVideo(userId, streamType, sourceType, listener) instead.

startSpeedTest

startSpeedTest
void startSpeedTest
(int sdkAppId

String userId

String 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
(TRTCCloudDef.TRTCVideoEncParam encParams

TRTCCloudDef.TRTCScreenShareParams shareParams)

Start screen sharing

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

setVideoEncoderRotation

setVideoEncoderRotation
void setVideoEncoderRotation
(int rotation)

Set the direction of image output by video encoder

@deprecated It is deprecated starting from v11.7.

setVideoEncoderMirror

setVideoEncoderMirror
void setVideoEncoderMirror
(boolean mirror)

Set the mirror mode of image output by encoder

@deprecated It is deprecated starting from v11.7.

setGSensorMode

setGSensorMode
void setGSensorMode
(int mode)

Set the adaptation mode of G-sensor

@deprecated It is deprecated starting from v11.7. It is recommended to use the setGravitySensorAdaptiveMode interface instead.