Tencent Real-Time Communication Tencent Real-Time Communication Client APIs Product Documentation ©2013-2019 Tencent Cloud. All rights reserved. Page 1 of 184 Tencent Real-Time Communication Copyright Notice ©2013-2019 Tencent Cloud. All rights reserved. Copyright in this document is exclusively owned by Tencent Cloud. You must not reproduce, modify, copy or distribute in any way, in whole or in part, the contents of this document without Tencent Cloud's the prior written consent. Trademark Notice All trademarks associated with Tencent Cloud and its services are owned by Tencent Cloud Computing (Beijing) Company Limited and its affiliated companies. Trademarks of third parties referred to in this document are owned by their respective proprietors. Service Statement This document is intended to provide users with general information about Tencent Cloud's products and services only and does not form part of Tencent Cloud's terms and conditions. Tencent Cloud's products or services are subject to change. Specific products and services and the standards applicable to them are exclusively provided for in Tencent Cloud's applicable terms and conditions. ©2013-2019 Tencent Cloud. All rights reserved. Page 2 of 184 Tencent Real-Time Communication Contents Client APIs iOS & macOS Overview Error Codes Android Overview Error Codes All Platforms (C++) Overview Error Codes Web Overview Error Codes Electron Overview Error Codes Flutter Overview Error Codes Unity Overview Error Codes Desktop Browser Overview Error Codes ©2013-2019 Tencent Cloud. All rights reserved. Page 3 of 184 Tencent Real-Time Communication Client APIs iOS & macOS Overview Last updated：2021-09-09 11:40:52 Create Instance And Event Callback API DESC sharedInstance Create TRTCCloud instance (singleton mode) destroySharedIntance Terminate TRTCCloud instance (singleton mode) delegate Set TRTC event callback delegateQueue Set the queue that drives the TRTCCloudDelegate event callback Room APIs API DESC enterRoom Enter room exitRoom Exit room switchRole Switch role switchRoom Switch room connectOtherRoom Request cross-room call disconnectOtherRoom Exit cross-room call Set subscription mode (which must be set before room entry for setDefaultStreamRecvMode it to take effect) createSubCloud Create room subinstance (for concurrent multi-room listen/watch) destroySubCloud Terminate room subinstance CDN APIs API DESC ©2013-2019 Tencent Cloud. All rights reserved. Page 4 of 184 Tencent Real-Time Communication API DESC startPublishing 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 Set the layout and transcoding parameters of On-Cloud setMixTranscodingConfig MixTranscoding Video APIs API DESC startLocalPreview Enable the preview image of local camera (mobile) startLocalPreview Enable the preview image of local camera (desktop) updateLocalView Update the preview image of local camera stopLocalPreview Stop camera preview muteLocalVideo Pause/Resume publishing local video stream setVideoMuteImage Set placeholder image during local video pause Subscribe to remote user's video stream and bind video startRemoteView rendering control updateRemoteView Update remote user's video rendering control Stop subscribing to remote user's video stream and release stopRemoteView rendering control Stop subscribing to all remote users' video streams and release stopAllRemoteView all rendering resources muteRemoteVideoStream Pause/Resume subscribing to remote user's video stream muteAllRemoteVideoStreams Pause/Resume subscribing to all remote users' video streams setVideoEncoderParam Set the encoding parameters of video encoder setNetworkQosParam Set network quality control parameters ©2013-2019 Tencent Cloud. All rights reserved. Page 5 of 184 Tencent Real-Time Communication API DESC setLocalRenderParams Set the rendering parameters of local video image setRemoteRenderParams Set the rendering mode of remote video image 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 enableEncSmallVideoStream Enable dual-channel encoding mode with big and small images setRemoteVideoStreamType Switch the big/small image of specified remote user snapshotVideo Screencapture video Audio APIs API DESC startLocalAudio Enable local audio capturing and publishing stopLocalAudio Stop local audio capturing and publishing muteLocalAudio Pause/Resume publishing local audio stream muteRemoteAudio Pause/Resume playing back remote audio stream muteAllRemoteAudio Pause/Resume playing back all remote users' audio streams setAudioRoute Set audio route setRemoteAudioVolume Set the audio playback volume of remote user setAudioCaptureVolume Set the capturing volume of local audio getAudioCaptureVolume Get the capturing volume of local audio setAudioPlayoutVolume Set the playback volume of remote audio getAudioPlayoutVolume Get the playback volume of remote audio enableAudioVolumeEvaluation Enable volume reminder startAudioRecording Start audio recording ©2013-2019 Tencent Cloud. All rights reserved. Page 6 of 184 Tencent Real-Time Communication API DESC stopAudioRecording Stop audio recording startLocalRecording Start local media recording stopLocalRecording Stop local media recording Device management APIs API DESC getDeviceManager Get device management class (TXDeviceManager) Beauty filter and watermark APIs API DESC getBeautyManager Get beauty filter management class (TXBeautyManager) setWatermark Add watermark Background music and sound effect APIs API DESC Get sound effect management class getAudioEffectManager (TXAudioEffectManager) startSystemAudioLoopback Enable system audio capturing (for desktop systems only) stopSystemAudioLoopback Stop system audio capturing (for desktop systems only) setSystemAudioLoopbackVolume Set the volume of system audio capturing Screen sharing APIs API DESC Start in-app screen sharing (for iOS 13.0 and startScreenCaptureInApp above only) Start system-level screen sharing (for iOS 11.0 startScreenCaptureByReplaykit and above only) ©2013-2019 Tencent Cloud. All rights reserved. Page 7 of 184 Tencent Real-Time Communication API DESC Start desktop screen sharing (for desktop startScreenCapture systems only) stopScreenCapture Stop screen sharing pauseScreenCapture Pause screen sharing resumeScreenCapture Resume screen sharing Enumerate shareable screens and windows (for getScreenCaptureSourcesWithThumbnailSize macOS only) Select the screen or window to share (for selectScreenCaptureTarget macOS only) Set the video encoding parameters of screen setSubStreamEncoderParam sharing (i.e., substream) (for desktop systems only) Set the audio mixing volume of screen sharing setSubStreamMixVolume (for desktop systems only) Add specified windows to the exclusion list of addExcludedShareWindow screen sharing (for desktop systems only) Remove specified windows from the exclusion removeExcludedShareWindow list of screen sharing (for desktop systems only) Remove all windows from the exclusion list of removeAllExcludedShareWindows screen sharing (for desktop systems only) Add specified windows to the inclusion list of addIncludedShareWindow screen sharing (for desktop systems only) Remove specified windows from the inclusion removeIncludedShareWindow list of screen sharing (for desktop systems only) Remove all windows from the inclusion list of removeAllIncludedShareWindows screen sharing (for desktop systems only) Custom capturing and rendering APIs API DESC enableCustomVideoCapture Enable/Disable custom video capturing mode ©2013-2019 Tencent Cloud. All rights reserved. Page 8 of 184 Tencent Real-Time Communication API DESC sendCustomVideoData Deliver captured video frames to SDK enableCustomAudioCapture Enable custom audio capturing mode sendCustomAudioData Deliver captured audio data to SDK enableMixExternalAudioFrame Enable/Disable custom audio track mixExternalAudioFrame Mix custom audio track into SDK Set the publish volume and playback volume setMixExternalAudioVolume of mixed custom audio track generateCustomPTS Generate custom capturing timestamp Set video data callback for third-party beauty setLocalVideoProcessDelegete filters Set the callback of custom rendering for local setLocalVideoRenderDelegate video Set the callback of custom rendering for setRemoteVideoRenderDelegate remote video setAudioFrameDelegate Set custom audio data callback Set the callback format of original audio setCapturedRawAudioFrameDelegateFormat frames captured by local mic Set the callback format of preprocessed local setLocalProcessedAudioFrameDelegateFormat audio frames Set the callback format of audio frames to be setMixedPlayAudioFrameDelegateFormat played back by system enableCustomAudioRendering Enabling custom audio playback getCustomAudioRenderingFrame Getting playable audio data Custom message sending APIs API DESC sendCustomCmdMsg Use UDP channel to send custom message to all users in room ©2013-2019 Tencent Cloud. All rights reserved. Page 9 of 184 Tencent Real-Time Communication API DESC sendSEIMsg Use SEI channel to send custom message to all users in room Network test APIs API DESC startSpeedTest Start network speed test (used before room entry) stopSpeedTest Stop network speed test Debugging APIs API DESC getSDKVersion Get SDK version information