agora::rtc::IAudioTrack Class Reference

#include <NGIAgoraAudioTrack.h>

Public Types
enum	AudioFilterPosition {   RecordingLocalPlayback , PostAudioProcessing , PcmSource , PcmSourceSending ,   PcmSourceLocalPlayback }

Public Member Functions
virtual bool	addAudioSink (agora_refptr< IAudioSinkBase > sink, const AudioSinkWants &wants)=0
virtual bool	removeAudioSink (agora_refptr< IAudioSinkBase > sink)=0

Detailed Description

The IAudioTrack class.

Member Enumeration Documentation

AudioFilterPosition

enum agora::rtc::IAudioTrack::AudioFilterPosition

The position of the audio filter in audio frame.

Enumerator
RecordingLocalPlayback	Work on the local playback
PostAudioProcessing	Work on the post audio processing.
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.

Member Function Documentation

addAudioSink()

virtual bool agora::rtc::IAudioTrack::addAudioSink ( agora_refptr< IAudioSinkBase >  sink, const AudioSinkWants &  wants  )

pure virtual

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()

virtual bool agora::rtc::IAudioTrack::removeAudioSink ( agora_refptr< IAudioSinkBase >  sink )

pure virtual

Removes an audio sink.

Parameters

sink	The pointer to the audio sink to be removed. See IAudioSinkBase.

Returns

• true: Success.
• false: Failure.

---

The documentation for this class was generated from the following file:

• NGIAgoraAudioTrack.h