Documentation
Interactive Live Streaming Standard (Legacy)
Console 官网 Community Technical support
English
search-icon

Agora C++ API Reference for All Platforms

Index IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager
Member agora::media::IMediaEngine::pushAudioFrame (MEDIA_SOURCE_TYPE type, IAudioFrameObserver::AudioFrame *frame, bool wrap) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated. Use pushAudioFrame [3/3] instead.
Member agora::media::IMediaEngine::pushAudioFrame (IAudioFrameObserver::AudioFrame *frame) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated. Use pushAudioFrame [3/3] instead.
Member agora::media::IMediaEngine::registerVideoRenderFactory (IExternalVideoRenderFactory *factory) AGORA_DEPRECATED_ATTRIBUTE=0
Member agora::media::IVideoFrameObserver::getSmoothRenderingEnabled () AGORA_DEPRECATED_ATTRIBUTE
As of v3.2.0, this callback function no longer works. The SDK smooths the video frames output by onRenderVideoFrame and onRenderVideoFrameEx by default.
Member agora::media::MEDIA_SOURCE_TYPE
Type of audio device.
Member agora::rtc::AGORA_DEPRECATED_ATTRIBUTE
Deprecated from v3.7.0. As of v3.7.0, the SDK no longer throws this error code and automatically adjusts the capture method to capture more types of windows.
Member agora::rtc::AUDIO_MIXING_ERROR_TYPE
Deprecated from v3.4.0. Use AUDIO_MIXING_REASON_TYPE instead.
Member agora::rtc::AUDIO_REVERB_PRESET
Deprecated from v3.2.0.
Member agora::rtc::IChannel::addPublishStreamUrl (const char *url, bool transcodingEnabled) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IChannel::createDataStream (int *streamId, bool reliable, bool ordered) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0. Use the createDataStream [2/2] method instead.
Member agora::rtc::IChannel::enableRemoteSuperResolution (uid_t userId, bool enable) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.7.1. Use enableRemoteSuperResolution [2/2] instead.
Member agora::rtc::IChannel::publish () AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.4.5. Use muteLocalAudioStream (false) or muteLocalVideoStream (false) instead.
Member agora::rtc::IChannel::removePublishStreamUrl (const char *url) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IChannel::setDefaultMuteAllRemoteAudioStreams (bool mute) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0.
Member agora::rtc::IChannel::setDefaultMuteAllRemoteVideoStreams (bool mute) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0.
Member agora::rtc::IChannel::setEncryptionMode (const char *encryptionMode) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated as of v3.1.0. Use the enableEncryption instead.
Member agora::rtc::IChannel::setEncryptionSecret (const char *secret) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated as of v3.1.0. Use the enableEncryption instead.
Member agora::rtc::IChannel::setLiveTranscoding (const LiveTranscoding &transcoding) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IChannel::unpublish () AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.4.5. Use muteLocalAudioStream (true) or muteLocalVideoStream (true) instead.
Member agora::rtc::IRtcEngine::addPublishStreamUrl (const char *url, bool transcodingEnabled) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IRtcEngine::addVideoWatermark (const RtcImage &watermark)=0
Adds a watermark image to the local video or CDN live stream.
Member agora::rtc::IRtcEngine::createDataStream (int *streamId, bool reliable, bool ordered) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0. Use the createDataStream [2/2] method instead.
Member agora::rtc::IRtcEngine::enableRemoteSuperResolution (uid_t userId, bool enable) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.7.1. Use enableRemoteSuperResolution [2/2] instead.
Member agora::rtc::IRtcEngine::enableWebSdkInteroperability (bool enabled) AGORA_DEPRECATED_ATTRIBUTE=0
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 () AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.5.1. Use getAudioFileInfo instead.
Member agora::rtc::IRtcEngine::playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated from v3.4.0. Use playEffect [2/2] instead.
Member agora::rtc::IRtcEngine::removePublishStreamUrl (const char *url) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteAudioStreams (bool mute) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0.
Member agora::rtc::IRtcEngine::setDefaultMuteAllRemoteVideoStreams (bool mute) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0.
Member agora::rtc::IRtcEngine::setEncryptionMode (const char *encryptionMode) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated as of v3.1.0. Use the enableEncryption instead.
Member agora::rtc::IRtcEngine::setEncryptionSecret (const char *secret) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated as of v3.1.0. Use the enableEncryption instead.
Member agora::rtc::IRtcEngine::setHighQualityAudioParameters (bool fullband, bool stereo, bool fullBitrate)=0
Agora does not recommend using this method.
Member agora::rtc::IRtcEngine::setLiveTranscoding (const LiveTranscoding &transcoding) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v3.6.0. See Release Notes for an alternative solution.
Member agora::rtc::IRtcEngine::setLocalRenderMode (RENDER_MODE_TYPE renderMode) AGORA_DEPRECATED_ATTRIBUTE=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) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated, use the setupLocalVideo or setLocalRenderMode method instead.
Member agora::rtc::IRtcEngine::setLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated from v3.2.0. Use the following methods instead:
Member agora::rtc::IRtcEngine::setLocalVoiceReverbPreset (AUDIO_REVERB_PRESET reverbPreset) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated from v3.2.0. Use setAudioEffectPreset or setVoiceBeautifierPreset instead.
Member agora::rtc::IRtcEngine::setLogFile (const char *filePath) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0. Use logConfig in the initialize method instead.
Member agora::rtc::IRtcEngine::setLogFileSize (unsigned int fileSizeInKBytes) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated from v3.3.0. Use logConfig in the initialize method instead.
Member agora::rtc::IRtcEngine::setLogFilter (unsigned int filter) AGORA_DEPRECATED_ATTRIBUTE=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) AGORA_DEPRECATED_ATTRIBUTE=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::setVideoProfile (VIDEO_PROFILE_TYPE profile, bool swapWidthAndHeight) AGORA_DEPRECATED_ATTRIBUTE=0
This method is deprecated as of v2.3. Use the setVideoEncoderConfiguration method instead.
Member agora::rtc::IRtcEngine::setVideoQualityParameters (bool preferFrameRateOverImageQuality)=0
Sets the preferences for the high-quality video. (LIVE_BROADCASTING only).
Member agora::rtc::IRtcEngine::startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated from v3.4.0. Use startAudioMixing [2/2] instead.
Member agora::rtc::IRtcEngine::startAudioRecording (const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality) AGORA_DEPRECATED_ATTRIBUTE=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) AGORA_DEPRECATED_ATTRIBUTE=0
Deprecated from v3.4.0. Use startAudioRecording [3/3] instead.
Member agora::rtc::IRtcEngine::startEchoTest ()=0
This method is deprecated as of v2.4.0.
Member agora::rtc::IRtcEngine::startScreenCapture (WindowIDType windowId, int captureFreq, const Rect *rect, int bitrate)=0
Starts screen sharing.
Member agora::rtc::IRtcEngine::startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
This method is deprecated as of v3.7.0, use startScreenCaptureByDisplayId instead. Agora strongly recommends using startScreenCaptureByDisplayId if you need to start screen sharing on a device connected to another display.
Member agora::rtc::IRtcEngine::updateScreenCaptureRegion (const Rect *rect)=0
Updates the screen capture region.
Member agora::rtc::IRtcEngineEventHandler::onAudioQuality (uid_t uid, int quality, unsigned short delay, unsigned short lost)
Reports the statistics of the audio stream from each remote user/host.
Member agora::rtc::IRtcEngineEventHandler::onCameraReady ()
Occurs when the camera turns on and is ready to capture the video.
Member agora::rtc::IRtcEngineEventHandler::onConnectionBanned ()
Deprecated as of v2.3.2. Replaced by the onConnectionStateChanged(CONNECTION_STATE_FAILED, CONNECTION_CHANGED_BANNED_BY_SERVER) callback.
Member agora::rtc::IRtcEngineEventHandler::onConnectionInterrupted ()
Occurs when the connection between the SDK and the server is interrupted.
Member agora::rtc::IRtcEngineEventHandler::onFirstLocalAudioFrame (int elapsed) AGORA_DEPRECATED_ATTRIBUTE
Deprecated as of v3.1.0. Use the onFirstLocalAudioFramePublished callback instead.
Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioDecoded (uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE
v3.0.0
Member agora::rtc::IRtcEngineEventHandler::onFirstRemoteAudioFrame (uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE
v3.0.0
Member agora::rtc::IRtcEngineEventHandler::onMicrophoneEnabled (bool enabled) AGORA_DEPRECATED_ATTRIBUTE
v2.9.0
Member agora::rtc::IRtcEngineEventHandler::onRemoteAudioTransportStats (uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) AGORA_DEPRECATED_ATTRIBUTE
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) AGORA_DEPRECATED_ATTRIBUTE
This callback is deprecated and replaced by the onRemoteVideoStats callback.
Member agora::rtc::IRtcEngineEventHandler::onStreamPublished (const char *url, int error) AGORA_DEPRECATED_ATTRIBUTE
This method is deprecated, use the onRtmpStreamingStateChanged callback instead.
Member agora::rtc::IRtcEngineEventHandler::onStreamUnpublished (const char *url) AGORA_DEPRECATED_ATTRIBUTE
This method is deprecated, use the onRtmpStreamingStateChanged callback instead.
Member agora::rtc::IRtcEngineEventHandler::onVideoStopped ()
Occurs when the video stops playing.
Member agora::rtc::LiveTranscoding::lowLatency
Latency mode:
Member agora::rtc::LiveTranscoding::metadata
The metadata sent to the CDN live client defined by the RTMP or HTTP-FLV metadata.
Member agora::rtc::Rect
Definition of the rectangular region.
Member agora::rtc::RemoteVideoStats::delay
Time delay (ms).
Member agora::rtc::RENDER_MODE_ADAPTIVE
3: This mode is deprecated.
Member agora::rtc::RTMP_STREAM_LIFE_CYCLE_TYPE
Lifecycle of the CDN live video stream.
Member agora::rtc::VIDEO_PROFILE_TYPE
Video profiles.
Member agora::rtc::VOICE_CHANGER_PRESET
Deprecated from v3.2.0.