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

Agora C++ API Reference for All Platforms

Index IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager Warning Codes Error Codes

Public Member Functions

 RtcEngineParameters (IRtcEngine &engine)
 
 RtcEngineParameters (IRtcEngine *engine)
 
int enableLocalVideo (bool enabled)
 
int muteLocalVideoStream (bool mute)
 
int muteAllRemoteVideoStreams (bool mute)
 
int setDefaultMuteAllRemoteVideoStreams (bool mute)
 
int muteRemoteVideoStream (uid_t uid, bool mute)
 
int setPlaybackDeviceVolume (int volume)
 
int startAudioRecording (const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)
 
int startAudioRecording (const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)
 
int stopAudioRecording ()
 
int startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle)
 
int stopAudioMixing ()
 
int pauseAudioMixing ()
 
int resumeAudioMixing ()
 
int adjustAudioMixingVolume (int volume)
 
int adjustAudioMixingPlayoutVolume (int volume)
 
int getAudioMixingPlayoutVolume ()
 
int adjustAudioMixingPublishVolume (int volume)
 
int getAudioMixingPublishVolume ()
 
int getAudioMixingDuration ()
 
int getAudioMixingCurrentPosition ()
 
int setAudioMixingPosition (int pos)
 
int getEffectsVolume ()
 
int setEffectsVolume (int volume)
 
int setVolumeOfEffect (int soundId, int volume)
 
int playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false)
 
int stopEffect (int soundId)
 
int stopAllEffects ()
 
int preloadEffect (int soundId, char *filePath)
 
int unloadEffect (int soundId)
 
int pauseEffect (int soundId)
 
int pauseAllEffects ()
 
int resumeEffect (int soundId)
 
int resumeAllEffects ()
 
int enableSoundPositionIndication (bool enabled)
 
int setRemoteVoicePosition (uid_t uid, double pan, double gain)
 
int setLocalVoicePitch (double pitch)
 
int setLocalVoiceEqualization (AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)
 
int setLocalVoiceReverb (AUDIO_REVERB_TYPE reverbKey, int value)
 
int setLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)
 
int setLocalVoiceReverbPreset (AUDIO_REVERB_PRESET reverbPreset)
 
int pauseAudio ()
 
int resumeAudio ()
 
int setHighQualityAudioParameters (bool fullband, bool stereo, bool fullBitrate)
 
int adjustRecordingSignalVolume (int volume)
 
int adjustPlaybackSignalVolume (int volume)
 
int enableAudioVolumeIndication (int interval, int smooth, bool report_vad)
 
int muteLocalAudioStream (bool mute)
 
int muteRemoteAudioStream (uid_t uid, bool mute)
 
int muteAllRemoteAudioStreams (bool mute)
 
int setDefaultMuteAllRemoteAudioStreams (bool mute)
 
int setExternalAudioSource (bool enabled, int sampleRate, int channels)
 
int setExternalAudioSink (bool enabled, int sampleRate, int channels)
 
int setLogFile (const char *filePath)
 
int setLogFilter (unsigned int filter)
 
int setLogFileSize (unsigned int fileSizeInKBytes)
 
int setLocalRenderMode (RENDER_MODE_TYPE renderMode)
 
int setRemoteRenderMode (uid_t uid, RENDER_MODE_TYPE renderMode)
 
int setCameraCapturerConfiguration (const CameraCapturerConfiguration &config)
 
int enableDualStreamMode (bool enabled)
 
int setRemoteVideoStreamType (uid_t uid, REMOTE_VIDEO_STREAM_TYPE streamType)
 
int setRemoteDefaultVideoStreamType (REMOTE_VIDEO_STREAM_TYPE streamType)
 
int setRecordingAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)
 
int setPlaybackAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)
 
int setMixedAudioFrameParameters (int sampleRate, int samplesPerCall)
 
int enableWebSdkInteroperability (bool enabled)
 
int setVideoQualityParameters (bool preferFrameRateOverImageQuality)
 
int setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode)
 
int setLocalPublishFallbackOption (STREAM_FALLBACK_OPTIONS option)
 
int setRemoteSubscribeFallbackOption (STREAM_FALLBACK_OPTIONS option)
 
int enableLoopbackRecording (bool enabled, const char *deviceName=NULL)
 
int setInEarMonitoringVolume (int volume)
 

Protected Member Functions

AParameter & parameter ()
 
int setParameters (const char *format,...)
 
int setObject (const char *key, const char *format,...)
 
int stopAllRemoteVideo ()
 

Detailed Description

DEPRECATED The RtcEngineParameters class is deprecated, use the IRtcEngine class instead.

Constructor & Destructor Documentation

◆ RtcEngineParameters() [1/2]

agora::rtc::RtcEngineParameters::RtcEngineParameters ( IRtcEngine &  engine)
inline

◆ RtcEngineParameters() [2/2]

agora::rtc::RtcEngineParameters::RtcEngineParameters ( IRtcEngine *  engine)
inline

Member Function Documentation

◆ enableLocalVideo()

int agora::rtc::RtcEngineParameters::enableLocalVideo ( bool  enabled)
inline

◆ muteLocalVideoStream()

int agora::rtc::RtcEngineParameters::muteLocalVideoStream ( bool  mute)
inline

◆ muteAllRemoteVideoStreams()

int agora::rtc::RtcEngineParameters::muteAllRemoteVideoStreams ( bool  mute)
inline

◆ setDefaultMuteAllRemoteVideoStreams()

int agora::rtc::RtcEngineParameters::setDefaultMuteAllRemoteVideoStreams ( bool  mute)
inline

◆ muteRemoteVideoStream()

int agora::rtc::RtcEngineParameters::muteRemoteVideoStream ( uid_t  uid,
bool  mute 
)
inline

◆ setPlaybackDeviceVolume()

int agora::rtc::RtcEngineParameters::setPlaybackDeviceVolume ( int  volume)
inline

◆ startAudioRecording() [1/2]

int agora::rtc::RtcEngineParameters::startAudioRecording ( const char *  filePath,
AUDIO_RECORDING_QUALITY_TYPE  quality 
)
inline

◆ startAudioRecording() [2/2]

int agora::rtc::RtcEngineParameters::startAudioRecording ( const char *  filePath,
int  sampleRate,
AUDIO_RECORDING_QUALITY_TYPE  quality 
)
inline

◆ stopAudioRecording()

int agora::rtc::RtcEngineParameters::stopAudioRecording ( )
inline

◆ startAudioMixing()

int agora::rtc::RtcEngineParameters::startAudioMixing ( const char *  filePath,
bool  loopback,
bool  replace,
int  cycle 
)
inline

◆ stopAudioMixing()

int agora::rtc::RtcEngineParameters::stopAudioMixing ( )
inline

◆ pauseAudioMixing()

int agora::rtc::RtcEngineParameters::pauseAudioMixing ( )
inline

◆ resumeAudioMixing()

int agora::rtc::RtcEngineParameters::resumeAudioMixing ( )
inline

◆ adjustAudioMixingVolume()

int agora::rtc::RtcEngineParameters::adjustAudioMixingVolume ( int  volume)
inline

◆ adjustAudioMixingPlayoutVolume()

int agora::rtc::RtcEngineParameters::adjustAudioMixingPlayoutVolume ( int  volume)
inline

◆ getAudioMixingPlayoutVolume()

int agora::rtc::RtcEngineParameters::getAudioMixingPlayoutVolume ( )
inline

◆ adjustAudioMixingPublishVolume()

int agora::rtc::RtcEngineParameters::adjustAudioMixingPublishVolume ( int  volume)
inline

◆ getAudioMixingPublishVolume()

int agora::rtc::RtcEngineParameters::getAudioMixingPublishVolume ( )
inline

◆ getAudioMixingDuration()

int agora::rtc::RtcEngineParameters::getAudioMixingDuration ( )
inline

◆ getAudioMixingCurrentPosition()

int agora::rtc::RtcEngineParameters::getAudioMixingCurrentPosition ( )
inline

◆ setAudioMixingPosition()

int agora::rtc::RtcEngineParameters::setAudioMixingPosition ( int  pos)
inline

◆ getEffectsVolume()

int agora::rtc::RtcEngineParameters::getEffectsVolume ( )
inline

◆ setEffectsVolume()

int agora::rtc::RtcEngineParameters::setEffectsVolume ( int  volume)
inline

◆ setVolumeOfEffect()

int agora::rtc::RtcEngineParameters::setVolumeOfEffect ( int  soundId,
int  volume 
)
inline

◆ playEffect()

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

◆ stopEffect()

int agora::rtc::RtcEngineParameters::stopEffect ( int  soundId)
inline

◆ stopAllEffects()

int agora::rtc::RtcEngineParameters::stopAllEffects ( )
inline

◆ preloadEffect()

int agora::rtc::RtcEngineParameters::preloadEffect ( int  soundId,
char *  filePath 
)
inline

◆ unloadEffect()

int agora::rtc::RtcEngineParameters::unloadEffect ( int  soundId)
inline

◆ pauseEffect()

int agora::rtc::RtcEngineParameters::pauseEffect ( int  soundId)
inline

◆ pauseAllEffects()

int agora::rtc::RtcEngineParameters::pauseAllEffects ( )
inline

◆ resumeEffect()

int agora::rtc::RtcEngineParameters::resumeEffect ( int  soundId)
inline

◆ resumeAllEffects()

int agora::rtc::RtcEngineParameters::resumeAllEffects ( )
inline

◆ enableSoundPositionIndication()

int agora::rtc::RtcEngineParameters::enableSoundPositionIndication ( bool  enabled)
inline

◆ setRemoteVoicePosition()

int agora::rtc::RtcEngineParameters::setRemoteVoicePosition ( uid_t  uid,
double  pan,
double  gain 
)
inline

◆ setLocalVoicePitch()

int agora::rtc::RtcEngineParameters::setLocalVoicePitch ( double  pitch)
inline

◆ setLocalVoiceEqualization()

int agora::rtc::RtcEngineParameters::setLocalVoiceEqualization ( AUDIO_EQUALIZATION_BAND_FREQUENCY  bandFrequency,
int  bandGain 
)
inline

◆ setLocalVoiceReverb()

int agora::rtc::RtcEngineParameters::setLocalVoiceReverb ( AUDIO_REVERB_TYPE  reverbKey,
int  value 
)
inline

◆ setLocalVoiceChanger()

int agora::rtc::RtcEngineParameters::setLocalVoiceChanger ( VOICE_CHANGER_PRESET  voiceChanger)
inline

◆ setLocalVoiceReverbPreset()

int agora::rtc::RtcEngineParameters::setLocalVoiceReverbPreset ( AUDIO_REVERB_PRESET  reverbPreset)
inline

◆ pauseAudio()

int agora::rtc::RtcEngineParameters::pauseAudio ( )
inline

◆ resumeAudio()

int agora::rtc::RtcEngineParameters::resumeAudio ( )
inline

◆ setHighQualityAudioParameters()

int agora::rtc::RtcEngineParameters::setHighQualityAudioParameters ( bool  fullband,
bool  stereo,
bool  fullBitrate 
)
inline

◆ adjustRecordingSignalVolume()

int agora::rtc::RtcEngineParameters::adjustRecordingSignalVolume ( int  volume)
inline

◆ adjustPlaybackSignalVolume()

int agora::rtc::RtcEngineParameters::adjustPlaybackSignalVolume ( int  volume)
inline

◆ enableAudioVolumeIndication()

int agora::rtc::RtcEngineParameters::enableAudioVolumeIndication ( int  interval,
int  smooth,
bool  report_vad 
)
inline

◆ muteLocalAudioStream()

int agora::rtc::RtcEngineParameters::muteLocalAudioStream ( bool  mute)
inline

◆ muteRemoteAudioStream()

int agora::rtc::RtcEngineParameters::muteRemoteAudioStream ( uid_t  uid,
bool  mute 
)
inline

◆ muteAllRemoteAudioStreams()

int agora::rtc::RtcEngineParameters::muteAllRemoteAudioStreams ( bool  mute)
inline

◆ setDefaultMuteAllRemoteAudioStreams()

int agora::rtc::RtcEngineParameters::setDefaultMuteAllRemoteAudioStreams ( bool  mute)
inline

◆ setExternalAudioSource()

int agora::rtc::RtcEngineParameters::setExternalAudioSource ( bool  enabled,
int  sampleRate,
int  channels 
)
inline

◆ setExternalAudioSink()

int agora::rtc::RtcEngineParameters::setExternalAudioSink ( bool  enabled,
int  sampleRate,
int  channels 
)
inline

◆ setLogFile()

int agora::rtc::RtcEngineParameters::setLogFile ( const char *  filePath)
inline

◆ setLogFilter()

int agora::rtc::RtcEngineParameters::setLogFilter ( unsigned int  filter)
inline

◆ setLogFileSize()

int agora::rtc::RtcEngineParameters::setLogFileSize ( unsigned int  fileSizeInKBytes)
inline

◆ setLocalRenderMode()

int agora::rtc::RtcEngineParameters::setLocalRenderMode ( RENDER_MODE_TYPE  renderMode)
inline

◆ setRemoteRenderMode()

int agora::rtc::RtcEngineParameters::setRemoteRenderMode ( uid_t  uid,
RENDER_MODE_TYPE  renderMode 
)
inline

◆ setCameraCapturerConfiguration()

int agora::rtc::RtcEngineParameters::setCameraCapturerConfiguration ( const CameraCapturerConfiguration &  config)
inline

◆ enableDualStreamMode()

int agora::rtc::RtcEngineParameters::enableDualStreamMode ( bool  enabled)
inline

◆ setRemoteVideoStreamType()

int agora::rtc::RtcEngineParameters::setRemoteVideoStreamType ( uid_t  uid,
REMOTE_VIDEO_STREAM_TYPE  streamType 
)
inline

◆ setRemoteDefaultVideoStreamType()

int agora::rtc::RtcEngineParameters::setRemoteDefaultVideoStreamType ( REMOTE_VIDEO_STREAM_TYPE  streamType)
inline

◆ setRecordingAudioFrameParameters()

int agora::rtc::RtcEngineParameters::setRecordingAudioFrameParameters ( int  sampleRate,
int  channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE  mode,
int  samplesPerCall 
)
inline

◆ setPlaybackAudioFrameParameters()

int agora::rtc::RtcEngineParameters::setPlaybackAudioFrameParameters ( int  sampleRate,
int  channel,
RAW_AUDIO_FRAME_OP_MODE_TYPE  mode,
int  samplesPerCall 
)
inline

◆ setMixedAudioFrameParameters()

int agora::rtc::RtcEngineParameters::setMixedAudioFrameParameters ( int  sampleRate,
int  samplesPerCall 
)
inline

◆ enableWebSdkInteroperability()

int agora::rtc::RtcEngineParameters::enableWebSdkInteroperability ( bool  enabled)
inline

◆ setVideoQualityParameters()

int agora::rtc::RtcEngineParameters::setVideoQualityParameters ( bool  preferFrameRateOverImageQuality)
inline

◆ setLocalVideoMirrorMode()

int agora::rtc::RtcEngineParameters::setLocalVideoMirrorMode ( VIDEO_MIRROR_MODE_TYPE  mirrorMode)
inline

◆ setLocalPublishFallbackOption()

int agora::rtc::RtcEngineParameters::setLocalPublishFallbackOption ( STREAM_FALLBACK_OPTIONS  option)
inline

◆ setRemoteSubscribeFallbackOption()

int agora::rtc::RtcEngineParameters::setRemoteSubscribeFallbackOption ( STREAM_FALLBACK_OPTIONS  option)
inline

◆ enableLoopbackRecording()

int agora::rtc::RtcEngineParameters::enableLoopbackRecording ( bool  enabled,
const char *  deviceName = NULL 
)
inline

◆ setInEarMonitoringVolume()

int agora::rtc::RtcEngineParameters::setInEarMonitoringVolume ( int  volume)
inline

◆ parameter()

AParameter& agora::rtc::RtcEngineParameters::parameter ( )
inlineprotected

◆ setParameters()

int agora::rtc::RtcEngineParameters::setParameters ( const char *  format,
  ... 
)
inlineprotected

◆ setObject()

int agora::rtc::RtcEngineParameters::setObject ( const char *  key,
const char *  format,
  ... 
)
inlineprotected

◆ stopAllRemoteVideo()

int agora::rtc::RtcEngineParameters::stopAllRemoteVideo ( )
inlineprotected