Agora C++ API Reference for All Platforms
|
Inherits agora::rtc::IAudioFilterBase.
Public Member Functions | |
virtual void | setEnabled (bool enable)=0 |
virtual bool | isEnabled () const =0 |
virtual int | setProperty (const char *key, const void *buf, int buf_size)=0 |
virtual int | getProperty (const char *key, void *buf, int buf_size) const =0 |
virtual const char * | getName () const =0 |
virtual int | getPreferredSampleRate () |
virtual int | getPreferredChannelNumbers () |
![]() | |
virtual bool | adaptAudioFrame (const media::base::AudioPcmFrame &inAudioFrame, media::base::AudioPcmFrame &adaptedFrame)=0 |
![]() | |
virtual void | AddRef () const =0 |
virtual RefCountReleaseStatus | Release () const =0 |
virtual bool | HasOneRef () const =0 |
Protected Member Functions | |
~IAudioFilter () | |
![]() | |
~IAudioFilterBase () | |
![]() | |
virtual | ~RefCountInterface () |
The IAudioFilter
class.
This class is the intermediate node for audio, which reads audio frames from the underlying pipeline and writes audio frames back after adaptation.
|
inlineprotected |
|
pure virtual |
Enables or disables the audio filter.
enable | Whether to enable the audio filter:
|
|
pure virtual |
Checks whether the audio filter is enabled.
true
: The audio filter is enabled.false
: The audio filter is not enabled.
|
pure virtual |
Sets a private property in the IAudioFilter
class.
key | The pointer to the property name. |
buf | The pointer to the buffer of this private property. |
buf_size | The buffer size of this private property. |
|
pure virtual |
Gets a private property in the IAudioFilter
class.
name | The pointer to the property name. |
buf | The pointer to the buffer of this private property. |
buf_size | The buffer size of this private property. |
|
pure virtual |
Gets the name of the IAudioFilter
class.
|
inlinevirtual |
Get the sample rate supported by the audio filter, the framework will resample the audio data and then pass it to the audio filter. If the user does not overwrite, resampling will not be done by default.
Implements agora::rtc::IAudioFilterBase.
|
inlinevirtual |
Get the channel number supported by the audio filter, the framework will resample the audio data and then pass it to the audio filter. If the user does not overwrite, resampling will not be done by default.
Implements agora::rtc::IAudioFilterBase.