Inherits agora::RefCountInterface.
Inherited by agora::rtc::ILocalAudioTrack, and agora::rtc::IRemoteAudioTrack.
|
virtual int | adjustPlayoutVolume (int volume)=0 |
|
virtual int | getPlayoutVolume (int *volume)=0 |
|
virtual bool | addAudioFilter (agora_refptr< IAudioFilter > filter, AudioFilterPosition position)=0 |
|
virtual bool | removeAudioFilter (agora_refptr< IAudioFilter > filter, AudioFilterPosition position)=0 |
|
virtual int | enableAudioFilter (const char *id, bool enable, AudioFilterPosition position) |
|
virtual int | setFilterProperty (const char *id, const char *key, const char *jsonValue, AudioFilterPosition position) |
|
virtual int | getFilterProperty (const char *id, const char *key, char *jsonValue, size_t bufSize, AudioFilterPosition position) |
|
virtual agora_refptr< IAudioFilter > | getAudioFilter (const char *name, AudioFilterPosition position) const =0 |
|
virtual bool | addAudioSink (agora_refptr< IAudioSinkBase > sink, const AudioSinkWants &wants)=0 |
|
virtual bool | removeAudioSink (agora_refptr< IAudioSinkBase > sink)=0 |
|
virtual void | AddRef () const =0 |
|
virtual RefCountReleaseStatus | Release () const =0 |
|
virtual bool | HasOneRef () const =0 |
|
◆ AudioFilterPosition
The position of the audio filter in audio frame.
Enumerator |
---|
RecordingLocalPlayback | Work on the local playback
|
PostAudioProcessing | Work on the post audio processing.
|
RemoteUserPlayback | Work on the remote audio before mixing.
|
PcmSource | Work on the pcm source.
|
PcmSourceSending | Work on the sending branch of the pcm source.
|
PcmSourceLocalPlayback | Work on the local playback branch of the pcm source.
|
RemoteMixedPlayback | Work on the playback after remote-audio mix.
|
◆ adjustPlayoutVolume()
virtual int agora::rtc::IAudioTrack::adjustPlayoutVolume |
( |
int |
volume | ) |
|
|
pure virtual |
Adjusts the playback volume.
- Parameters
-
volume | The playback volume. The value ranges between 0 and 100 (default). |
- Returns
- 0: Success.
- < 0: Failure.
◆ getPlayoutVolume()
virtual int agora::rtc::IAudioTrack::getPlayoutVolume |
( |
int * |
volume | ) |
|
|
pure virtual |
Gets the current playback volume.
- Parameters
-
volume | A pointer to the playback volume. |
- Returns
- 0: Success.
- < 0: Failure.
◆ addAudioFilter()
Adds an audio filter.
By adding an audio filter, you can apply various audio effects to the audio, for example, voice change.
- Parameters
-
- Returns
true
: Success.
false
: Failure.
◆ removeAudioFilter()
Removes the audio filter added by callling addAudioFilter
.
- Parameters
-
- Returns
true
: Success.
false
: Failure.
◆ enableAudioFilter()
virtual int agora::rtc::IAudioTrack::enableAudioFilter |
( |
const char * |
id, |
|
|
bool |
enable, |
|
|
AudioFilterPosition |
position |
|
) |
| |
|
inlinevirtual |
Enable / Disable specified audio filter
- Parameters
-
id | id of the filter |
enable | enable / disable the filter with given id |
position | The position of the audio filter. See AudioFilterPosition. |
- Returns
-
◆ setFilterProperty()
virtual int agora::rtc::IAudioTrack::setFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
const char * |
jsonValue, |
|
|
AudioFilterPosition |
position |
|
) |
| |
|
inlinevirtual |
set the properties of the specified audio filter
- Parameters
-
id | id of the filter |
key | key of the property |
jsonValue | json str value of the property |
position | The position of the audio filter. See AudioFilterPosition. |
- Returns
-
◆ getFilterProperty()
virtual int agora::rtc::IAudioTrack::getFilterProperty |
( |
const char * |
id, |
|
|
const char * |
key, |
|
|
char * |
jsonValue, |
|
|
size_t |
bufSize, |
|
|
AudioFilterPosition |
position |
|
) |
| |
|
inlinevirtual |
get the properties of the specified video filter
- Parameters
-
id | id of the filter |
key | key of the property |
jsonValue | json str value of the property |
bufSize | max length of the json value buffer |
position | The position of the audio filter. See AudioFilterPosition. |
- Returns
-
◆ getAudioFilter()
Gets the audio filter by its name.
- Parameters
-
name | The name of the audio filter. |
position | The position of the audio filter. See AudioFilterPosition. |
- Returns
- The pointer to the audio filter: Success.
- A null pointer: Failure.
◆ addAudioSink()
Adds an audio sink to get PCM data from the audio track.
- Parameters
-
sink | The pointer to the audio sink. See IAudioSinkBase. |
wants | The properties an audio frame should have when it is delivered to the sink. See AudioSinkWants. |
- Returns
true
: Success.
false
: Failure.
◆ removeAudioSink()
Removes an audio sink.
- Parameters
-
- Returns
true
: Success.
false
: Failure.