API Reference

This method is deprecated. As of v3.0.0, the Native SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method. Enables interoperability with the Agora Web SDK.

Member agora::rtc::IRtcEngine::getAudioMixingDuration ()=0

Deprecated from v3.4.0. Use getAudioMixingDuration [2/2] instead.

Member agora::rtc::IRtcEngine::playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false)=0

Deprecated from v3.4.0. Use playEffect [2/2] instead.

Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteAudioStreams (bool mute)=0

This method is deprecated from v3.3.0.

Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteVideoStreams (bool mute)=0

This method is deprecated from v3.3.0.

Member agora::rtc::IRtcEngine::setEncryptionMode (const char *encryptionMode)=0

Deprecated as of v3.1.0. Use the enableEncryption instead.

Member agora::rtc::IRtcEngine::setEncryptionSecret (const char *secret)=0

Deprecated as of v3.1.0. Use the enableEncryption instead.

Member agora::rtc::IRtcEngine::setLocalRenderMode (RENDER_MODE_TYPE renderMode)=0

This method is deprecated, use the setLocalRenderMode [2/2] method instead. Sets the local video display mode.

Member agora::rtc::IRtcEngine::setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode)=0

This method is deprecated, use the setupLocalVideo or setLocalRenderMode method instead.

Member agora::rtc::IRtcEngine::setLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)=0

Deprecated from v3.2.0. Use the following methods instead:

setAudioEffectPreset: Audio effects.
setVoiceBeautifierPreset: Voice beautifier effects.
setVoiceConversionPreset: Voice conversion effects.

Member agora::rtc::IRtcEngine::setLocalVoiceReverbPreset (AUDIO_REVERB_PRESET reverbPreset)=0

Deprecated from v3.2.0. Use setAudioEffectPreset or setVoiceBeautifierPreset instead.

Member agora::rtc::IRtcEngine::setLogFile (const char *filePath)=0

This method is deprecated from v3.3.0. Use logConfig in the initialize method instead.

Member agora::rtc::IRtcEngine::setLogFileSize (unsigned int fileSizeInKBytes)=0

This method is deprecated from v3.3.0. Use logConfig in the initialize method instead.

Member agora::rtc::IRtcEngine::setLogFilter (unsigned int filter)=0

This method is deprecated from v3.3.0. Use logConfig in the initialize method instead.

Member agora::rtc::IRtcEngine::setRemoteRenderMode (uid_t userId, RENDER_MODE_TYPE renderMode)=0

This method is deprecated, use the setRemoteRenderMode [2/2] method instead. Sets the video display mode of a specified remote user.

Member agora::rtc::IRtcEngine::startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle)=0

Deprecated from v3.4.0. Use startAudioMixing [2/2] instead.

Member agora::rtc::IRtcEngine::startAudioRecording (const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0

Deprecated from v2.9.1. Use startAudioRecording [3/3] instead.

Member agora::rtc::IRtcEngine::startAudioRecording (const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0

Deprecated from v3.4.0. Use startAudioRecording [3/3] instead.

Member agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFrame (int elapsed)

Deprecated as of v3.1.0. Use the onFirstLocalAudioFramePublished callback instead.

Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed)

v3.0.0

Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame (uid_t uid, int elapsed)

v3.0.0

Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteVideoDecoded (uid_t uid, int width, int height, int elapsed)

v2.9.0

Member agora::rtc::IRtcEngineEventHandler::onMicrophoneEnabled (bool enabled)

v2.9.0

Member agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)

This callback is deprecated and replaced by the onRemoteAudioStats callback.

Member agora::rtc::IRtcEngineEventHandler::onRemoteVideoTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate)

This callback is deprecated and replaced by the onRemoteVideoStats callback.

Member agora::rtc::IRtcEngineEventHandler::onStreamPublished (const char *url, int error)

This method is deprecated, use the onRtmpStreamingStateChanged callback instead.

Member agora::rtc::IRtcEngineEventHandler::onStreamUnpublished (const char *url)

This method is deprecated, use the onRtmpStreamingStateChanged callback instead.

Member agora::rtc::VIDEO_PROFILE_TYPE

Video profiles.

Member agora::rtc::VOICE_CHANGER_PRESET

Deprecated from v3.2.0.