- Release Notes and Announcements
- Release Notes
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Service Level Agreement
- TRTC Policy
- Glossary
- Release Notes and Announcements
- Release Notes
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Service Level Agreement
- TRTC Policy
- Glossary
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
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 |
Set the rendering mode of local image
setLocalViewRotation
setLocalViewRotation
void setLocalViewRotation |
Set the clockwise rotation angle of local image
setLocalViewMirror
setLocalViewMirror
void setLocalViewMirror | (bool mirror) |
Set the mirror mode of local camera's preview image
setRemoteViewFillMode
setRemoteViewFillMode
void setRemoteViewFillMode | (const char* userId |
|
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 |
|
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 |
|
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 |
|
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 |
Set sound quality
setPriorRemoteVideoStreamType
setPriorRemoteVideoStreamType
void setPriorRemoteVideoStreamType |
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
playBGM
playBGM
void playBGM | (const char* path) |
Start background music
stopBGM
stopBGM
Stop background music
pauseBGM
pauseBGM
Stop background music
resumeBGM
resumeBGM
Stop background music
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 |
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
sendCustomVideoData
sendCustomVideoData
void sendCustomVideoData |
Deliver captured video data to SDK
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)
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 | |
| |
|
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 |
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.
Yes
No
Was this page helpful?