Video SDK v3.7.1 API Reference for All Platforms (C++)
agora::rtc::IRtcEngine Member List

This is the complete list of members for agora::rtc::IRtcEngine, including all inherited members.

addInjectStreamUrl(const char *url, const InjectStreamConfig &config)=0agora::rtc::IRtcEnginepure virtual
addPublishStreamUrl(const char *url, bool transcodingEnabled) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
addVideoWatermark(const RtcImage &watermark)=0agora::rtc::IRtcEnginepure virtual
addVideoWatermark(const char *watermarkUrl, const WatermarkOptions &options)=0agora::rtc::IRtcEnginepure virtual
adjustAudioMixingPlayoutVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustAudioMixingPublishVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustAudioMixingVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustLoopbackRecordingSignalVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustPlaybackSignalVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustRecordingSignalVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
adjustUserPlaybackSignalVolume(unsigned int uid, int volume)=0agora::rtc::IRtcEnginepure virtual
clearVideoWatermarks()=0agora::rtc::IRtcEnginepure virtual
complain(const char *callId, const char *description)=0agora::rtc::IRtcEnginepure virtual
createDataStream(int *streamId, bool reliable, bool ordered) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
createDataStream(int *streamId, DataStreamConfig &config)=0agora::rtc::IRtcEnginepure virtual
disableAudio()=0agora::rtc::IRtcEnginepure virtual
disableLastmileTest()=0agora::rtc::IRtcEnginepure virtual
disableVideo()=0agora::rtc::IRtcEnginepure virtual
enableAudio()=0agora::rtc::IRtcEnginepure virtual
enableAudioVolumeIndication(int interval, int smooth, bool report_vad)=0agora::rtc::IRtcEnginepure virtual
enableDeepLearningDenoise(bool enable)=0agora::rtc::IRtcEnginepure virtual
enableDualStreamMode(bool enabled)=0agora::rtc::IRtcEnginepure virtual
enableEncryption(bool enabled, const EncryptionConfig &config)=0agora::rtc::IRtcEnginepure virtual
enableFaceDetection(bool enable)=0agora::rtc::IRtcEnginepure virtual
enableInEarMonitoring(bool enabled)=0agora::rtc::IRtcEnginepure virtual
enableLastmileTest()=0agora::rtc::IRtcEnginepure virtual
enableLocalAudio(bool enabled)=0agora::rtc::IRtcEnginepure virtual
enableLocalVideo(bool enabled)=0agora::rtc::IRtcEnginepure virtual
enableLocalVoicePitchCallback(int interval)=0agora::rtc::IRtcEnginepure virtual
enableLoopbackRecording(bool enabled, const char *deviceName=NULL)=0agora::rtc::IRtcEnginepure virtual
enableRemoteSuperResolution(uid_t userId, bool enable) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
enableRemoteSuperResolution(bool enabled, SR_MODE mode, uid_t userId)=0agora::rtc::IRtcEnginepure virtual
enableSoundPositionIndication(bool enabled)=0agora::rtc::IRtcEnginepure virtual
enableVideo()=0agora::rtc::IRtcEnginepure virtual
enableVirtualBackground(bool enabled, VirtualBackgroundSource backgroundSource)=0agora::rtc::IRtcEnginepure virtual
enableWebSdkInteroperability(bool enabled) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
getAudioFileInfo(const char *filePath)=0agora::rtc::IRtcEnginepure virtual
getAudioMixingCurrentPosition()=0agora::rtc::IRtcEnginepure virtual
getAudioMixingDuration() AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
getAudioMixingPlayoutVolume()=0agora::rtc::IRtcEnginepure virtual
getAudioMixingPublishVolume()=0agora::rtc::IRtcEnginepure virtual
getAudioTrackCount()=0agora::rtc::IRtcEnginepure virtual
getCallId(agora::util::AString &callId)=0agora::rtc::IRtcEnginepure virtual
getCameraMaxZoomFactor()=0agora::rtc::IRtcEnginepure virtual
getConnectionState()=0agora::rtc::IRtcEnginepure virtual
getEffectCurrentPosition(int soundId)=0agora::rtc::IRtcEnginepure virtual
getEffectDuration(const char *filePath)=0agora::rtc::IRtcEnginepure virtual
getEffectsVolume()=0agora::rtc::IRtcEnginepure virtual
getErrorDescription(int code)=0agora::rtc::IRtcEnginepure virtual
getScreenCaptureSources(const SIZE &thumbSize, const SIZE &iconSize, const bool includeScreen)=0agora::rtc::IRtcEnginepure virtual
getUserInfoByUid(uid_t uid, UserInfo *userInfo)=0agora::rtc::IRtcEnginepure virtual
getUserInfoByUserAccount(const char *userAccount, UserInfo *userInfo)=0agora::rtc::IRtcEnginepure virtual
getVersion(int *build)=0agora::rtc::IRtcEnginepure virtual
initialize(const RtcEngineContext &context)=0agora::rtc::IRtcEnginepure virtual
isCameraAutoFocusFaceModeSupported()=0agora::rtc::IRtcEnginepure virtual
isCameraExposurePositionSupported()=0agora::rtc::IRtcEnginepure virtual
isCameraFocusSupported()=0agora::rtc::IRtcEnginepure virtual
isCameraTorchSupported()=0agora::rtc::IRtcEnginepure virtual
isCameraZoomSupported()=0agora::rtc::IRtcEnginepure virtual
isSpeakerphoneEnabled()=0agora::rtc::IRtcEnginepure virtual
joinChannel(const char *token, const char *channelId, const char *info, uid_t uid)=0agora::rtc::IRtcEnginepure virtual
joinChannel(const char *token, const char *channelId, const char *info, uid_t uid, const ChannelMediaOptions &options)=0agora::rtc::IRtcEnginepure virtual
joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount)=0agora::rtc::IRtcEnginepure virtual
joinChannelWithUserAccount(const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options)=0agora::rtc::IRtcEnginepure virtual
leaveChannel()=0agora::rtc::IRtcEnginepure virtual
muteAllRemoteAudioStreams(bool mute)=0agora::rtc::IRtcEnginepure virtual
muteAllRemoteVideoStreams(bool mute)=0agora::rtc::IRtcEnginepure virtual
muteLocalAudioStream(bool mute)=0agora::rtc::IRtcEnginepure virtual
muteLocalVideoStream(bool mute)=0agora::rtc::IRtcEnginepure virtual
muteRemoteAudioStream(uid_t userId, bool mute)=0agora::rtc::IRtcEnginepure virtual
muteRemoteVideoStream(uid_t userId, bool mute)=0agora::rtc::IRtcEnginepure virtual
pauseAllChannelMediaRelay()=0agora::rtc::IRtcEnginepure virtual
pauseAllEffects()=0agora::rtc::IRtcEnginepure virtual
pauseAudioMixing()=0agora::rtc::IRtcEnginepure virtual
pauseEffect(int soundId)=0agora::rtc::IRtcEnginepure virtual
playEffect(int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
playEffect(int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish, int startPos)=0agora::rtc::IRtcEnginepure virtual
preloadEffect(int soundId, const char *filePath)=0agora::rtc::IRtcEnginepure virtual
queryInterface(INTERFACE_ID_TYPE iid, void **inter)=0agora::rtc::IRtcEnginepure virtual
rate(const char *callId, int rating, const char *description)=0agora::rtc::IRtcEnginepure virtual
registerEventHandler(IRtcEngineEventHandler *eventHandler)=0agora::rtc::IRtcEnginepure virtual
registerLocalUserAccount(const char *appId, const char *userAccount)=0agora::rtc::IRtcEnginepure virtual
registerMediaMetadataObserver(IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0agora::rtc::IRtcEnginepure virtual
registerPacketObserver(IPacketObserver *observer)=0agora::rtc::IRtcEnginepure virtual
release(bool sync=false)agora::rtc::IRtcEnginestatic
removeInjectStreamUrl(const char *url)=0agora::rtc::IRtcEnginepure virtual
removePublishStreamUrl(const char *url) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
renewToken(const char *token)=0agora::rtc::IRtcEnginepure virtual
resumeAllChannelMediaRelay()=0agora::rtc::IRtcEnginepure virtual
resumeAllEffects()=0agora::rtc::IRtcEnginepure virtual
resumeAudioMixing()=0agora::rtc::IRtcEnginepure virtual
resumeEffect(int soundId)=0agora::rtc::IRtcEnginepure virtual
selectAudioTrack(int index)=0agora::rtc::IRtcEnginepure virtual
sendCustomReportMessage(const char *id, const char *category, const char *event, const char *label, int value)=0agora::rtc::IRtcEnginepure virtual
sendStreamMessage(int streamId, const char *data, size_t length)=0agora::rtc::IRtcEnginepure virtual
setAudioEffectParameters(AUDIO_EFFECT_PRESET preset, int param1, int param2)=0agora::rtc::IRtcEnginepure virtual
setAudioEffectPreset(AUDIO_EFFECT_PRESET preset)=0agora::rtc::IRtcEnginepure virtual
setAudioMixingDualMonoMode(agora::media::AUDIO_MIXING_DUAL_MONO_MODE mode)=0agora::rtc::IRtcEnginepure virtual
setAudioMixingPitch(int pitch)=0agora::rtc::IRtcEnginepure virtual
setAudioMixingPlaybackSpeed(int speed)=0agora::rtc::IRtcEnginepure virtual
setAudioMixingPosition(int pos)=0agora::rtc::IRtcEnginepure virtual
setAudioProfile(AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario)=0agora::rtc::IRtcEnginepure virtual
setAudioSessionOperationRestriction(AUDIO_SESSION_OPERATION_RESTRICTION restriction)=0agora::rtc::IRtcEnginepure virtual
setBeautyEffectOptions(bool enabled, BeautyOptions options)=0agora::rtc::IRtcEnginepure virtual
setCameraAutoFocusFaceModeEnabled(bool enabled)=0agora::rtc::IRtcEnginepure virtual
setCameraCapturerConfiguration(const CameraCapturerConfiguration &config)=0agora::rtc::IRtcEnginepure virtual
setCameraExposurePosition(float positionXinView, float positionYinView)=0agora::rtc::IRtcEnginepure virtual
setCameraFocusPositionInPreview(float positionX, float positionY)=0agora::rtc::IRtcEnginepure virtual
setCameraTorchOn(bool isOn)=0agora::rtc::IRtcEnginepure virtual
setCameraZoomFactor(float factor)=0agora::rtc::IRtcEnginepure virtual
setChannelProfile(CHANNEL_PROFILE_TYPE profile)=0agora::rtc::IRtcEnginepure virtual
setClientRole(CLIENT_ROLE_TYPE role)=0agora::rtc::IRtcEnginepure virtual
setClientRole(CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0agora::rtc::IRtcEnginepure virtual
setCloudProxy(CLOUD_PROXY_TYPE proxyType)=0agora::rtc::IRtcEnginepure virtual
setColorEnhanceOptions(bool enabled, ColorEnhanceOptions options)=0agora::rtc::IRtcEnginepure virtual
setDefaultAudioRouteToSpeakerphone(bool defaultToSpeaker)=0agora::rtc::IRtcEnginepure virtual
setDefaultMuteAllRemoteAudioStreams(bool mute) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setDefaultMuteAllRemoteVideoStreams(bool mute) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setEffectPosition(int soundId, int pos)=0agora::rtc::IRtcEnginepure virtual
setEffectsVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
setEnableSpeakerphone(bool speakerOn)=0agora::rtc::IRtcEnginepure virtual
setEncryptionMode(const char *encryptionMode) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setEncryptionSecret(const char *secret) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setExternalAudioSink(bool enabled, int sampleRate, int channels)=0agora::rtc::IRtcEnginepure virtual
setExternalAudioSource(bool enabled, int sampleRate, int channels)=0agora::rtc::IRtcEnginepure virtual
setHighQualityAudioParameters(bool fullband, bool stereo, bool fullBitrate)=0agora::rtc::IRtcEnginepure virtual
setInEarMonitoringVolume(int volume)=0agora::rtc::IRtcEnginepure virtual
setLiveTranscoding(const LiveTranscoding &transcoding) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLocalPublishFallbackOption(STREAM_FALLBACK_OPTIONS option)=0agora::rtc::IRtcEnginepure virtual
setLocalRenderMode(RENDER_MODE_TYPE renderMode) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLocalRenderMode(RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0agora::rtc::IRtcEnginepure virtual
setLocalVideoMirrorMode(VIDEO_MIRROR_MODE_TYPE mirrorMode) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLocalVideoRenderer(IVideoSink *videoSink)=0agora::rtc::IRtcEnginepure virtual
setLocalVoiceChanger(VOICE_CHANGER_PRESET voiceChanger) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLocalVoiceEqualization(AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0agora::rtc::IRtcEnginepure virtual
setLocalVoicePitch(double pitch)=0agora::rtc::IRtcEnginepure virtual
setLocalVoiceReverb(AUDIO_REVERB_TYPE reverbKey, int value)=0agora::rtc::IRtcEnginepure virtual
setLocalVoiceReverbPreset(AUDIO_REVERB_PRESET reverbPreset) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLogFile(const char *filePath) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLogFileSize(unsigned int fileSizeInKBytes) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLogFilter(unsigned int filter) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setLowlightEnhanceOptions(bool enabled, LowLightEnhanceOptions options)=0agora::rtc::IRtcEnginepure virtual
setMixedAudioFrameParameters(int sampleRate, int samplesPerCall)=0agora::rtc::IRtcEnginepure virtual
setParameters(const char *parameters)=0agora::rtc::IRtcEnginepure virtual
setPlaybackAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0agora::rtc::IRtcEnginepure virtual
setRecordingAudioFrameParameters(int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0agora::rtc::IRtcEnginepure virtual
setRemoteDefaultVideoStreamType(REMOTE_VIDEO_STREAM_TYPE streamType)=0agora::rtc::IRtcEnginepure virtual
setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setRemoteRenderMode(uid_t userId, RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0agora::rtc::IRtcEnginepure virtual
setRemoteSubscribeFallbackOption(STREAM_FALLBACK_OPTIONS option)=0agora::rtc::IRtcEnginepure virtual
setRemoteUserPriority(uid_t uid, PRIORITY_TYPE userPriority)=0agora::rtc::IRtcEnginepure virtual
setRemoteVideoRenderer(uid_t uid, IVideoSink *videoSink)=0agora::rtc::IRtcEnginepure virtual
setRemoteVideoStreamType(uid_t userId, REMOTE_VIDEO_STREAM_TYPE streamType)=0agora::rtc::IRtcEnginepure virtual
setRemoteVoicePosition(uid_t uid, double pan, double gain)=0agora::rtc::IRtcEnginepure virtual
setScreenCaptureContentHint(VideoContentHint contentHint)=0agora::rtc::IRtcEnginepure virtual
setScreenCaptureScenario(SCREEN_SCENARIO_TYPE screenScenario)=0agora::rtc::IRtcEnginepure virtual
setupLocalVideo(const VideoCanvas &canvas)=0agora::rtc::IRtcEnginepure virtual
setupRemoteVideo(const VideoCanvas &canvas)=0agora::rtc::IRtcEnginepure virtual
setVideoDenoiserOptions(bool enabled, VideoDenoiserOptions options)=0agora::rtc::IRtcEnginepure virtual
setVideoEncoderConfiguration(const VideoEncoderConfiguration &config)=0agora::rtc::IRtcEnginepure virtual
setVideoProfile(VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
setVideoQualityParameters(bool preferFrameRateOverImageQuality)=0agora::rtc::IRtcEnginepure virtual
setVideoSource(IVideoSource *source)=0agora::rtc::IRtcEnginepure virtual
setVoiceBeautifierParameters(VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0agora::rtc::IRtcEnginepure virtual
setVoiceBeautifierPreset(VOICE_BEAUTIFIER_PRESET preset)=0agora::rtc::IRtcEnginepure virtual
setVoiceConversionPreset(VOICE_CONVERSION_PRESET preset)=0agora::rtc::IRtcEnginepure virtual
setVolumeOfEffect(int soundId, int volume)=0agora::rtc::IRtcEnginepure virtual
startAudioMixing(const char *filePath, bool loopback, bool replace, int cycle) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
startAudioMixing(const char *filePath, bool loopback, bool replace, int cycle, int startPos)=0agora::rtc::IRtcEnginepure virtual
startAudioRecording(const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
startAudioRecording(const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality) AGORA_DEPRECATED_ATTRIBUTE=0agora::rtc::IRtcEnginepure virtual
startAudioRecording(const AudioRecordingConfiguration &config)=0agora::rtc::IRtcEnginepure virtual
startChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0agora::rtc::IRtcEnginepure virtual
startEchoTest()=0agora::rtc::IRtcEnginepure virtual
startEchoTest(int intervalInSeconds)=0agora::rtc::IRtcEnginepure virtual
startEchoTest(const EchoTestConfiguration &config)=0agora::rtc::IRtcEnginepure virtual
startLastmileProbeTest(const LastmileProbeConfig &config)=0agora::rtc::IRtcEnginepure virtual
startPreview()=0agora::rtc::IRtcEnginepure virtual
startRtmpStreamWithoutTranscoding(const char *url)=0agora::rtc::IRtcEnginepure virtual
startRtmpStreamWithTranscoding(const char *url, const LiveTranscoding &transcoding)=0agora::rtc::IRtcEnginepure virtual
startScreenCapture(WindowIDType windowId, int captureFreq, const Rect *rect, int bitrate)=0agora::rtc::IRtcEnginepure virtual
startScreenCaptureByDisplayId(unsigned int displayId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0agora::rtc::IRtcEnginepure virtual
startScreenCaptureByScreenRect(const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0agora::rtc::IRtcEnginepure virtual
startScreenCaptureByWindowId(view_t windowId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0agora::rtc::IRtcEnginepure virtual
stopAllEffects()=0agora::rtc::IRtcEnginepure virtual
stopAudioMixing()=0agora::rtc::IRtcEnginepure virtual
stopAudioRecording()=0agora::rtc::IRtcEnginepure virtual
stopChannelMediaRelay()=0agora::rtc::IRtcEnginepure virtual
stopEchoTest()=0agora::rtc::IRtcEnginepure virtual
stopEffect(int soundId)=0agora::rtc::IRtcEnginepure virtual
stopLastmileProbeTest()=0agora::rtc::IRtcEnginepure virtual
stopPreview()=0agora::rtc::IRtcEnginepure virtual
stopRtmpStream(const char *url)=0agora::rtc::IRtcEnginepure virtual
stopScreenCapture()=0agora::rtc::IRtcEnginepure virtual
switchCamera()=0agora::rtc::IRtcEnginepure virtual
switchChannel(const char *token, const char *channelId)=0agora::rtc::IRtcEnginepure virtual
switchChannel(const char *token, const char *channelId, const ChannelMediaOptions &options)=0agora::rtc::IRtcEnginepure virtual
takeSnapshot(const char *channel, uid_t uid, const char *filePath)=0agora::rtc::IRtcEnginepure virtual
unloadEffect(int soundId)=0agora::rtc::IRtcEnginepure virtual
unregisterEventHandler(IRtcEngineEventHandler *eventHandler)=0agora::rtc::IRtcEnginepure virtual
updateChannelMediaRelay(const ChannelMediaRelayConfiguration &configuration)=0agora::rtc::IRtcEnginepure virtual
updateRtmpTranscoding(const LiveTranscoding &transcoding)=0agora::rtc::IRtcEnginepure virtual
updateScreenCaptureParameters(const ScreenCaptureParameters &captureParams)=0agora::rtc::IRtcEnginepure virtual
updateScreenCaptureRegion(const Rectangle &regionRect)=0agora::rtc::IRtcEnginepure virtual
updateScreenCaptureRegion(const Rect *rect)=0agora::rtc::IRtcEnginepure virtual
WindowIDType typedefagora::rtc::IRtcEngine
WindowIDType typedefagora::rtc::IRtcEngine
~IRtcEngine()agora::rtc::IRtcEngineinlineprotectedvirtual