Deprecated Interface

Last updated:2025-12-31 17:31:26

Deprecated Interface

Last updated: 2025-12-31 17:31:26

Deprecated Interface
TRTCCloud
FuncList
DESC
destroySharedIntance
Terminate TRTCCloud instance (singleton mode).
delegate
Set TRTC event callback.
setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:
Set the strength of beauty, brightening, and rosy skin filters.
setEyeScaleLevel:
Set the strength of eye enlarging filter.
setFaceScaleLevel:
Set the strength of face slimming filter.
setFaceVLevel:
Set the strength of chin slimming filter.
setChinLevel:
Set the strength of chin lengthening/shortening filter.
setFaceShortLevel:
Set the strength of face shortening filter.
setNoseSlimLevel:
Set the strength of nose slimming filter.
selectMotionTmpl:
Set animated sticker.
setMotionMute:
Mute animated sticker.
setFilter:
Set color filter.
setFilterConcentration:
Set the strength of color filter.
setGreenScreenFile:
Set green screen video.
setReverbType:
Set reverb effect.
setVoiceChangerType:
Set voice changing type.
enableAudioEarMonitoring:
Enable or disable in-ear monitoring.
enableAudioVolumeEvaluation:
Enable volume reminder.
enableAudioVolumeEvaluation:enable_vad:
Enable volume reminder.
switchCamera
Switch camera.
isCameraZoomSupported
Query whether the current camera supports zoom.
setZoom:
Set camera zoom ratio (focal length).
isCameraTorchSupported
Query whether the device supports flash.
enbaleTorch:
Enable/Disable flash.
isCameraFocusPositionInPreviewSupported
Query whether the camera supports setting focus.
setFocusPosition:
Set the focal position of camera.
isCameraAutoFocusFaceModeSupported
Query whether the device supports the automatic recognition of face position.
enableAutoFaceFoucs:
Enable/Disable face auto focus.
setSystemVolumeType:
Setting the system volume type (for mobile OS).
snapshotVideo:type:
Screencapture video.
startScreenCaptureByReplaykit:appGroup:
Start system-level screen sharing (for iOS 11.0 and above only).
startLocalAudio
Set sound quality.
startRemoteView:view:
Start displaying remote video image.
stopRemoteView:
Stop displaying remote video image and pulling the video data stream of remote user.
setLocalViewFillMode:
Set the rendering mode of local image.
setLocalViewRotation:
Set the clockwise rotation angle of local image.
setLocalViewMirror:
Set the mirror mode of local camera's preview image.
setRemoteViewFillMode:mode:
Set the fill mode of substream image.
setRemoteViewRotation:rotation:
Set the clockwise rotation angle of remote image.
startRemoteSubStreamView:view:
Start displaying the substream image of remote user.
stopRemoteSubStreamView:
Stop displaying the substream image of remote user.
setRemoteSubStreamViewFillMode:mode:
Set the fill mode of substream image.
setRemoteSubStreamViewRotation:rotation:
Set the clockwise rotation angle of substream image.
setAudioQuality:
Set sound quality.
setPriorRemoteVideoStreamType:
Specify whether to view the big or small image.
setMicVolumeOnMixing:
Set mic volume.
playBGM:
Start background music.
stopBGM
Stop background music.
pauseBGM
Stop background music.
resumeBGM
Stop background music.
getBGMDuration:
Get the total length of background music in ms.
setBGMPosition:
Set background music playback progress.
setBGMVolume:
Set background music volume.
setBGMPlayoutVolume:
Set the local playback volume of background music.
setBGMPublishVolume:
Set the remote playback volume of background music.
playAudioEffect:
Play sound effect.
setAudioEffectVolume:volume:
Set sound effect volume.
stopAudioEffect:
Stop sound effect.
stopAllAudioEffects
Stop all sound effects.
setAllAudioEffectsVolume:
Set the volume of all sound effects.
pauseAudioEffect:
Pause sound effect.
resumeAudioEffect:
Pause sound effect.
enableCustomVideoCapture:
Enable custom video capturing mode.
sendCustomVideoData:
Deliver captured video data to SDK.
muteLocalVideo:
Pause/Resume publishing local video stream.
muteRemoteVideoStream:mute:
Pause/Resume subscribing to remote user's video stream.
startSpeedTest:userId:userSig:
Start network speed test (used before room entry).
startScreenCapture:
Start screen sharing.
getCameraDevicesList
Get the list of cameras.
setCurrentCameraDevice:
Set the camera to be used currently.
getCurrentCameraDevice
Get the currently used camera.
getMicDevicesList
Get the list of mics.
getCurrentMicDevice
Get the current mic device.
setCurrentMicDevice:
Select the currently used mic.
getCurrentMicDeviceVolume
Get the current mic volume.
setCurrentMicDeviceVolume:
Set the current mic volume.
setCurrentMicDeviceMute:
Set the mute status of the current system mic.
getCurrentMicDeviceMute
Get the mute status of the current system mic.
getSpeakerDevicesList
Get the list of speakers.
getCurrentSpeakerDevice
Get the currently used speaker.
setCurrentSpeakerDevice:
Set the speaker to use.
getCurrentSpeakerDeviceVolume
Get the current speaker volume.
setCurrentSpeakerDeviceVolume:
Set the current speaker volume.
getCurrentSpeakerDeviceMute
Get the mute status of the current system speaker.
setCurrentSpeakerDeviceMute:
Set whether to mute the current system speaker.
startCameraDeviceTestInView:
Start camera test.
stopCameraDeviceTest
Start camera test.
startMicDeviceTest:
Start mic test.
stopMicDeviceTest
Start mic test.
startSpeakerDeviceTest:
Start speaker test.
stopSpeakerDeviceTest
Stop speaker test.
startScreenCaptureInApp:
start in-app screen sharing (for iOS 13.0 and above only).
setVideoEncoderRotation:
Set the direction of image output by video encoder.
setVideoEncoderMirror:
Set the mirror mode of image output by encoder.
setGSensorMode:
Set the adaptation mode of G-sensor.
startPublishing:type:
Start publishing audio/video streams to Tencent Cloud CSS CDN.
stopPublishing
Stop publishing audio/video streams to Tencent Cloud CSS CDN.
startPublishCDNStream:
Start publishing audio/video streams to non-Tencent Cloud CDN.
stopPublishCDNStream
Stop publishing audio/video streams to non-Tencent Cloud CDN.
setMixTranscodingConfig:
Set the layout and transcoding parameters of On-Cloud MixTranscoding.
destroySharedIntance
destroySharedIntance
Terminate TRTCCloud instance (singleton mode).@deprecated This API is not recommended after 11.5 Please use ﻿destroySharedInstance﻿ instead.
delegate
delegate
Set TRTC event callback.@deprecated This API is not recommended after v11.4 Please use ﻿addDelegate﻿ instead.
setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:
setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:
- (void)setBeautyStyle:
(﻿TRTCBeautyStyle﻿)beautyStyle
beautyLevel:
(NSInteger)beautyLevel
whitenessLevel:
(NSInteger)whitenessLevel
ruddinessLevel:
(NSInteger)ruddinessLevel
Set the strength of beauty, brightening, and rosy skin filters.@deprecated This API is not recommended after v6.9. Please use ﻿setBeautyStyle﻿, ﻿setBeautyLevel﻿, ﻿setWhitenessLevel﻿, ﻿setRuddyLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setEyeScaleLevel:
setEyeScaleLevel:
- (void)setEyeScaleLevel:
(float)eyeScaleLevel
Set the strength of eye enlarging filter.@deprecated This API is not recommended after v6.9. Please use ﻿setEyeScaleLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setFaceScaleLevel:
setFaceScaleLevel:
- (void)setFaceScaleLevel:
(float)faceScaleLevel
Set the strength of face slimming filter.@deprecated This API is not recommended after v6.9. Please use ﻿setFaceSlimLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setFaceVLevel:
setFaceVLevel:
- (void)setFaceVLevel:
(float)faceVLevel
Set the strength of chin slimming filter.@deprecated This API is not recommended after v6.9. Please use ﻿setFaceVLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setChinLevel:
setChinLevel:
- (void)setChinLevel:
(float)chinLevel
Set the strength of chin lengthening/shortening filter.@deprecated This API is not recommended after v6.9. Please use ﻿setChinLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setFaceShortLevel:
setFaceShortLevel:
- (void)setFaceShortLevel:
(float)faceShortlevel
Set the strength of face shortening filter.@deprecated This API is not recommended after v6.9. Please use ﻿setFaceShortLevel﻿ API in ﻿TXBeautyManager﻿ instead.
setNoseSlimLevel:
setNoseSlimLevel:
- (void)setNoseSlimLevel:
(float)noseSlimLevel
Set the strength of nose slimming filter.@deprecated This API is not recommended after v6.9. Please use ﻿setNoseSlimLevel﻿ API in ﻿TXBeautyManager﻿ instead.
selectMotionTmpl:
selectMotionTmpl:
- (void)selectMotionTmpl:
(NSString *)tmplPath
Set animated sticker.@deprecated This API is not recommended after v6.9. Please use ﻿setMotionTmpl﻿ API in ﻿TXBeautyManager﻿ instead.
setMotionMute:
setMotionMute:
- (void)setMotionMute:
(BOOL)motionMute
Mute animated sticker.@deprecated This API is not recommended after v6.9. Please use ﻿setMotionMute﻿ API in ﻿TXBeautyManager﻿ instead.
setFilter:
setFilter:
- (void)setFilter:
(TXImage *)image
Set color filter.@deprecated This API is not recommended after v7.2. Please use ﻿setFilter﻿ API in ﻿TXBeautyManager﻿ instead.
setFilterConcentration:
setFilterConcentration:
- (void)setFilterConcentration:
(float)concentration
Set the strength of color filter.@deprecated This API is not recommended after v7.2. Please use ﻿setFilterStrength﻿ API in ﻿TXBeautyManager﻿ instead.
setGreenScreenFile:
setGreenScreenFile:
- (void)setGreenScreenFile:
(NSURL *)file
Set green screen video.@deprecated This API is not recommended after v7.2. Please use ﻿setGreenScreenFile﻿ API in ﻿TXBeautyManager﻿ instead.
setReverbType:
setReverbType:
- (void)setReverbType:
(﻿TRTCReverbType﻿)reverbType
Set reverb effect.@deprecated This API is not recommended after v7.3. Please use ﻿setVoiceReverbType﻿ API in ﻿TXAudioEffectManager﻿ instead.
setVoiceChangerType:
setVoiceChangerType:
- (void)setVoiceChangerType:
(﻿TRTCVoiceChangerType﻿)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:
(BOOL)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:
(NSUInteger)interval
Enable volume reminder.@deprecated This API is not recommended after v10.1. Please use ﻿enableAudioVolumeEvaluation﻿(enable, params) instead.
enableAudioVolumeEvaluation:enable_vad:
enableAudioVolumeEvaluation:enable_vad:
- (void)enableAudioVolumeEvaluation:
(NSUInteger)interval
enable_vad:
(BOOL)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:
(CGFloat)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.
enbaleTorch:
enbaleTorch:
- (BOOL)enbaleTorch:
(BOOL)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:
(CGPoint)touchPoint
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.
enableAutoFaceFoucs:
enableAutoFaceFoucs:
- (void)enableAutoFaceFoucs:
(BOOL)enable
Enable/Disable face auto focus.@deprecated This API is not recommended after v8.0. Please use the ﻿enableCameraAutoFocus﻿ API in ﻿TXDeviceManager﻿ instead.
setSystemVolumeType:
setSystemVolumeType:
- (void)setSystemVolumeType:
(﻿TRTCSystemVolumeType﻿)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.
snapshotVideo:type:
snapshotVideo:type:
- (void)snapshotVideo:
(NSString *)userId
type:
(﻿TRTCVideoStreamType﻿)streamType
Screencapture video.@deprecated This API is not recommended after v8.2. Please use ﻿snapshotVideo﻿ instead.
startScreenCaptureByReplaykit:appGroup:
startScreenCaptureByReplaykit:appGroup:
- (void)startScreenCaptureByReplaykit:
(﻿TRTCVideoEncParam﻿ *)encParams
appGroup:
(NSString *)appGroup
Start system-level screen sharing (for iOS 11.0 and above only).@deprecated This API is not recommended after v8.6. Please use ﻿startScreenCaptureByReplaykit﻿ instead.
startLocalAudio
startLocalAudio
Set sound quality.@deprecated This API is not recommended after v8.0. Please use ﻿startLocalAudio﻿:quality instead.
startRemoteView:view:
startRemoteView:view:
- (void)startRemoteView:
(NSString *)userId
view:
(TXView *)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:
(NSString *)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:
(TRTCLocalVideoMirrorType)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:mode:
setRemoteViewFillMode:mode:
- (void)setRemoteViewFillMode:
(NSString*)userId
mode:
(﻿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:rotation:
setRemoteViewRotation:rotation:
- (void)setRemoteViewRotation:
(NSString*)userId
rotation:
(﻿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:view:
startRemoteSubStreamView:view:
- (void)startRemoteSubStreamView:
(NSString *)userId
view:
(TXView *)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:
(NSString *)userId
Stop displaying the substream image of remote user.@deprecated This API is not recommended after v8.0. Please use ﻿stopRemoteView﻿:streamType: instead.
setRemoteSubStreamViewFillMode:mode:
setRemoteSubStreamViewFillMode:mode:
- (void)setRemoteSubStreamViewFillMode:
(NSString *)userId
mode:
(﻿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:rotation:
setRemoteSubStreamViewRotation:rotation:
- (void)setRemoteSubStreamViewRotation:
(NSString*)userId
rotation:
(﻿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﻿)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:
(NSInteger)volume
Set mic volume.@deprecated This API is not recommended after v6.9. Please use ﻿setAudioCaptureVolume﻿ instead.
playBGM:
playBGM:
- (void) playBGM:
(NSString *)path
Start background music.@deprecated This API is not recommended after v7.3. Please use ﻿startPlayMusic﻿ API in ﻿TXAudioEffectManager﻿ instead.
stopBGM
stopBGM
Stop background music.@deprecated This API is not recommended after v7.3. Please use ﻿stopPlayMusic﻿ API in ﻿TXAudioEffectManager﻿ instead.
pauseBGM
pauseBGM
Stop background music.@deprecated This API is not recommended after v7.3. Please use ﻿pausePlayMusic﻿ API in ﻿TXAudioEffectManager﻿ instead.
resumeBGM
resumeBGM
Stop background music.@deprecated This API is not recommended after v7.3. Please use ﻿resumePlayMusic﻿ API in ﻿TXAudioEffectManager﻿ instead.
getBGMDuration:
getBGMDuration:
- (NSInteger)getBGMDuration:
(NSString *)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:
(NSInteger)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:
(NSInteger)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:
(NSInteger)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:
(NSInteger)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:volume:
setAudioEffectVolume:volume:
- (void)setAudioEffectVolume:
(int)effectId
volume:
(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:mute:
muteRemoteVideoStream:mute:
- (void)muteRemoteVideoStream:
(NSString*)userId
mute:
(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:userId:userSig:
startSpeedTest:userId:userSig:
- (void)startSpeedTest:
(uint32_t)sdkAppId
userId:
(NSString *)userId
userSig:
(NSString *)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:
(nullable NSView *)view
Start screen sharing.@deprecated This API is not recommended after v7.2. Please use  startScreenCapture:streamType:encParam:  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:
- (int)setCurrentCameraDevice:
(NSString *)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:
- (int)setCurrentMicDevice:
(NSString*)deviceId
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:
(NSInteger)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:
- (int)setCurrentSpeakerDevice:
(NSString*)deviceId
Set the speaker to use.@deprecated This API is not recommended after v8.0. Please use the ﻿setCurrentDevice﻿ API in ﻿TXDeviceManager﻿ instead.
getCurrentSpeakerDeviceVolume
getCurrentSpeakerDeviceVolume
Get the current speaker volume.@deprecated This API is not recommended after v8.0. Please use the ﻿getCurrentDeviceVolume﻿ API in ﻿TXDeviceManager﻿ instead.
setCurrentSpeakerDeviceVolume:
setCurrentSpeakerDeviceVolume:
- (int)setCurrentSpeakerDeviceVolume:
(NSInteger)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.
startCameraDeviceTestInView:
startCameraDeviceTestInView:
- (void)startCameraDeviceTestInView:
(NSView *)view
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:
(NSInteger)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:
(NSString*)audioFilePath
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.
startScreenCaptureInApp:
startScreenCaptureInApp:
- (void)startScreenCaptureInApp:
(﻿TRTCVideoEncParam﻿ *)encParams
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.
setGSensorMode:
setGSensorMode:
- (void)setGSensorMode:
(﻿TRTCGSensorMode﻿) 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.
startPublishing:type:
startPublishing:type:
- (void)startPublishing:
(NSString *)streamId
type:
(﻿TRTCVideoStreamType﻿)streamType
Start publishing audio/video streams to Tencent Cloud CSS CDN.@deprecated It is deprecated starting from v12.0. Please use ﻿startPublishMediaStream﻿ instead.
stopPublishing
stopPublishing
Stop publishing audio/video streams to Tencent Cloud CSS CDN.@deprecated It is deprecated starting from v12.0. Please use ﻿stopPublishMediaStream﻿ instead.
startPublishCDNStream:
startPublishCDNStream:
- (void)startPublishCDNStream:
(﻿TRTCPublishCDNParam﻿*)param
Start publishing audio/video streams to non-Tencent Cloud CDN.@deprecated It is deprecated starting from v12.0. Please use ﻿startPublishMediaStream﻿ instead.
stopPublishCDNStream
stopPublishCDNStream
Stop publishing audio/video streams to non-Tencent Cloud CDN.@deprecated It is deprecated starting from v12.0. Please use ﻿stopPublishMediaStream﻿ instead.
setMixTranscodingConfig:
setMixTranscodingConfig:
- (void)setMixTranscodingConfig:
(nullable ﻿TRTCTranscodingConfig﻿*)config
Set the layout and transcoding parameters of On-Cloud MixTranscoding.@deprecated It is deprecated starting from v12.0. Please use ﻿startPublishMediaStream﻿， ﻿updatePublishMediaStream﻿ and ﻿stopPublishMediaStream﻿ instead.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

FuncList	DESC
destroySharedIntance	Terminate TRTCCloud instance (singleton mode).
delegate	Set TRTC event callback.
setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:	Set the strength of beauty, brightening, and rosy skin filters.
setEyeScaleLevel:	Set the strength of eye enlarging filter.
setFaceScaleLevel:	Set the strength of face slimming filter.
setFaceVLevel:	Set the strength of chin slimming filter.
setChinLevel:	Set the strength of chin lengthening/shortening filter.
setFaceShortLevel:	Set the strength of face shortening filter.
setNoseSlimLevel:	Set the strength of nose slimming filter.
selectMotionTmpl:	Set animated sticker.
setMotionMute:	Mute animated sticker.
setFilter:	Set color filter.
setFilterConcentration:	Set the strength of color filter.
setGreenScreenFile:	Set green screen video.
setReverbType:	Set reverb effect.
setVoiceChangerType:	Set voice changing type.
enableAudioEarMonitoring:	Enable or disable in-ear monitoring.
enableAudioVolumeEvaluation:	Enable volume reminder.
enableAudioVolumeEvaluation:enable_vad:	Enable volume reminder.
switchCamera	Switch camera.
isCameraZoomSupported	Query whether the current camera supports zoom.
setZoom:	Set camera zoom ratio (focal length).
isCameraTorchSupported	Query whether the device supports flash.
enbaleTorch:	Enable/Disable flash.
isCameraFocusPositionInPreviewSupported	Query whether the camera supports setting focus.
setFocusPosition:	Set the focal position of camera.
isCameraAutoFocusFaceModeSupported	Query whether the device supports the automatic recognition of face position.
enableAutoFaceFoucs:	Enable/Disable face auto focus.
setSystemVolumeType:	Setting the system volume type (for mobile OS).
snapshotVideo:type:	Screencapture video.
startScreenCaptureByReplaykit:appGroup:	Start system-level screen sharing (for iOS 11.0 and above only).
startLocalAudio	Set sound quality.
startRemoteView:view:	Start displaying remote video image.
stopRemoteView:	Stop displaying remote video image and pulling the video data stream of remote user.
setLocalViewFillMode:	Set the rendering mode of local image.
setLocalViewRotation:	Set the clockwise rotation angle of local image.
setLocalViewMirror:	Set the mirror mode of local camera's preview image.
setRemoteViewFillMode:mode:	Set the fill mode of substream image.
setRemoteViewRotation:rotation:	Set the clockwise rotation angle of remote image.
startRemoteSubStreamView:view:	Start displaying the substream image of remote user.
stopRemoteSubStreamView:	Stop displaying the substream image of remote user.
setRemoteSubStreamViewFillMode:mode:	Set the fill mode of substream image.
setRemoteSubStreamViewRotation:rotation:	Set the clockwise rotation angle of substream image.
setAudioQuality:	Set sound quality.
setPriorRemoteVideoStreamType:	Specify whether to view the big or small image.
setMicVolumeOnMixing:	Set mic volume.
playBGM:	Start background music.
stopBGM	Stop background music.
pauseBGM	Stop background music.
resumeBGM	Stop background music.
getBGMDuration:	Get the total length of background music in ms.
setBGMPosition:	Set background music playback progress.
setBGMVolume:	Set background music volume.
setBGMPlayoutVolume:	Set the local playback volume of background music.
setBGMPublishVolume:	Set the remote playback volume of background music.
playAudioEffect:	Play sound effect.
setAudioEffectVolume:volume:	Set sound effect volume.
stopAudioEffect:	Stop sound effect.
stopAllAudioEffects	Stop all sound effects.
setAllAudioEffectsVolume:	Set the volume of all sound effects.
pauseAudioEffect:	Pause sound effect.
resumeAudioEffect:	Pause sound effect.
enableCustomVideoCapture:	Enable custom video capturing mode.
sendCustomVideoData:	Deliver captured video data to SDK.
muteLocalVideo:	Pause/Resume publishing local video stream.
muteRemoteVideoStream:mute:	Pause/Resume subscribing to remote user's video stream.
startSpeedTest:userId:userSig:	Start network speed test (used before room entry).
startScreenCapture:	Start screen sharing.
getCameraDevicesList	Get the list of cameras.
setCurrentCameraDevice:	Set the camera to be used currently.
getCurrentCameraDevice	Get the currently used camera.
getMicDevicesList	Get the list of mics.
getCurrentMicDevice	Get the current mic device.
setCurrentMicDevice:	Select the currently used mic.
getCurrentMicDeviceVolume	Get the current mic volume.
setCurrentMicDeviceVolume:	Set the current mic volume.
setCurrentMicDeviceMute:	Set the mute status of the current system mic.
getCurrentMicDeviceMute	Get the mute status of the current system mic.
getSpeakerDevicesList	Get the list of speakers.
getCurrentSpeakerDevice	Get the currently used speaker.
setCurrentSpeakerDevice:	Set the speaker to use.
getCurrentSpeakerDeviceVolume	Get the current speaker volume.
setCurrentSpeakerDeviceVolume:	Set the current speaker volume.
getCurrentSpeakerDeviceMute	Get the mute status of the current system speaker.
setCurrentSpeakerDeviceMute:	Set whether to mute the current system speaker.
startCameraDeviceTestInView:	Start camera test.
stopCameraDeviceTest	Start camera test.
startMicDeviceTest:	Start mic test.
stopMicDeviceTest	Start mic test.
startSpeakerDeviceTest:	Start speaker test.
stopSpeakerDeviceTest	Stop speaker test.
startScreenCaptureInApp:	start in-app screen sharing (for iOS 13.0 and above only).
setVideoEncoderRotation:	Set the direction of image output by video encoder.
setVideoEncoderMirror:	Set the mirror mode of image output by encoder.
setGSensorMode:	Set the adaptation mode of G-sensor.
startPublishing:type:	Start publishing audio/video streams to Tencent Cloud CSS CDN.
stopPublishing	Stop publishing audio/video streams to Tencent Cloud CSS CDN.
startPublishCDNStream:	Start publishing audio/video streams to non-Tencent Cloud CDN.
stopPublishCDNStream	Stop publishing audio/video streams to non-Tencent Cloud CDN.
setMixTranscodingConfig:	Set the layout and transcoding parameters of On-Cloud MixTranscoding.

- (void)setBeautyStyle:	(TRTCBeautyStyle)beautyStyle
beautyLevel:	(NSInteger)beautyLevel
whitenessLevel:	(NSInteger)whitenessLevel
ruddinessLevel:	(NSInteger)ruddinessLevel

- (void)enableAudioVolumeEvaluation:	(NSUInteger)interval
enable_vad:	(BOOL)enable_vad

- (void)snapshotVideo:	(NSString *)userId
type:	(TRTCVideoStreamType)streamType

- (void)startScreenCaptureByReplaykit:	(TRTCVideoEncParam *)encParams
appGroup:	(NSString *)appGroup

- (void)startRemoteView:	(NSString *)userId
view:	(TXView *)view

- (void)setRemoteViewFillMode:	(NSString*)userId
mode:	(TRTCVideoFillMode)mode

- (void)setRemoteViewRotation:	(NSString*)userId
rotation:	(TRTCVideoRotation)rotation

- (void)startRemoteSubStreamView:	(NSString *)userId
view:	(TXView *)view

- (void)setRemoteSubStreamViewFillMode:	(NSString *)userId
mode:	(TRTCVideoFillMode)mode

- (void)setRemoteSubStreamViewRotation:	(NSString*)userId
rotation:	(TRTCVideoRotation)rotation

- (void)setAudioEffectVolume:	(int)effectId
volume:	(int) volume

- (void)muteRemoteVideoStream:	(NSString*)userId
mute:	(BOOL)mute

- (void)startSpeedTest:	(uint32_t)sdkAppId
userId:	(NSString *)userId
userSig:	(NSString *)userSig

- (void)startPublishing:	(NSString *)streamId
type:	(TRTCVideoStreamType)streamType

tencent cloud

TRTCCloud

destroySharedIntance

delegate

setBeautyStyle:beautyLevel:whitenessLevel:ruddinessLevel:

setEyeScaleLevel:

setFaceScaleLevel:

setFaceVLevel:

setChinLevel:

setFaceShortLevel:

setNoseSlimLevel:

selectMotionTmpl:

setMotionMute:

setFilter:

setFilterConcentration:

setGreenScreenFile:

setReverbType:

setVoiceChangerType:

enableAudioEarMonitoring:

enableAudioVolumeEvaluation:

enableAudioVolumeEvaluation:enable_vad:

switchCamera

isCameraZoomSupported

setZoom:

isCameraTorchSupported

enbaleTorch:

isCameraFocusPositionInPreviewSupported

setFocusPosition:

isCameraAutoFocusFaceModeSupported

enableAutoFaceFoucs:

setSystemVolumeType:

snapshotVideo:type:

startScreenCaptureByReplaykit:appGroup:

startLocalAudio

startRemoteView:view:

stopRemoteView:

setLocalViewFillMode:

setLocalViewRotation:

setLocalViewMirror:

setRemoteViewFillMode:mode:

setRemoteViewRotation:rotation:

startRemoteSubStreamView:view:

stopRemoteSubStreamView:

setRemoteSubStreamViewFillMode:mode:

setRemoteSubStreamViewRotation:rotation:

setAudioQuality:

setPriorRemoteVideoStreamType:

setMicVolumeOnMixing:

playBGM:

stopBGM

pauseBGM

resumeBGM

getBGMDuration:

setBGMPosition:

setBGMVolume:

setBGMPlayoutVolume:

setBGMPublishVolume:

playAudioEffect:

setAudioEffectVolume:volume:

stopAudioEffect:

stopAllAudioEffects

setAllAudioEffectsVolume:

pauseAudioEffect:

resumeAudioEffect:

enableCustomVideoCapture:

sendCustomVideoData:

muteLocalVideo:

muteRemoteVideoStream:mute:

startSpeedTest:userId:userSig:

startScreenCapture:

getCameraDevicesList

setCurrentCameraDevice:

getCurrentCameraDevice

getMicDevicesList

getCurrentMicDevice

setCurrentMicDevice:

getCurrentMicDeviceVolume

setCurrentMicDeviceVolume:

setCurrentMicDeviceMute:

getCurrentMicDeviceMute