Inherits agora::rtc::IAudioFilterBase.
Inherited by agora::rtc::IAudioFilterV2.
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.
◆ ~IAudioFilter()
agora::rtc::IAudioFilter::~IAudioFilter |
( |
| ) |
|
|
inlineprotected |
◆ setEnabled()
virtual void agora::rtc::IAudioFilter::setEnabled |
( |
bool |
enable | ) |
|
|
pure virtual |
Enables or disables the audio filter.
- Parameters
-
enable | Whether to enable the audio filter:
true : Enable the audio filter.
false : Do not enable the audio filter.
|
◆ isEnabled()
virtual bool agora::rtc::IAudioFilter::isEnabled |
( |
| ) |
const |
|
pure virtual |
Checks whether the audio filter is enabled.
- Returns
true
: The audio filter is enabled.
false
: The audio filter is not enabled.
◆ setProperty()
virtual int agora::rtc::IAudioFilter::setProperty |
( |
const char * |
key, |
|
|
const void * |
buf, |
|
|
int |
buf_size |
|
) |
| |
|
pure virtual |
Sets a private property in the IAudioFilter
class.
- Parameters
-
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. |
- Returns
- The actual size of the private property, if the method call succeeds.
- -1, if the method call fails.
◆ getProperty()
virtual int agora::rtc::IAudioFilter::getProperty |
( |
const char * |
key, |
|
|
void * |
buf, |
|
|
int |
buf_size |
|
) |
| const |
|
pure virtual |
Gets a private property in the IAudioFilter
class.
- Parameters
-
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. |
- Returns
- The actual size of the private property, if the method call succeeds.
- -1, if the method call fails.
◆ getName()
virtual const char* agora::rtc::IAudioFilter::getName |
( |
| ) |
const |
|
pure virtual |
Gets the name of the IAudioFilter
class.
- Returns
- The name of the audio filter, if the method call succeeds.
- An empty string, if the method call fails.
◆ getPreferredSampleRate()
virtual int agora::rtc::IAudioFilter::getPreferredSampleRate |
( |
| ) |
|
|
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.
- Returns
- 0: Audio data will not be resampled.
- > 0: Audio data will be resampled to this sample rate.
Implements agora::rtc::IAudioFilterBase.
◆ getPreferredChannelNumbers()
virtual int agora::rtc::IAudioFilter::getPreferredChannelNumbers |
( |
| ) |
|
|
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.
- Returns
- 0: Audio data will not be resampled.
- > 0: Audio data will be resampled to this sample rate.
Implements agora::rtc::IAudioFilterBase.