Agora RTC Objective-C API Reference  Refactor
Public Types | Public Member Functions
IAudioTrack Class Referenceabstract

Inherits RefCountInterface.

Inherited by ILocalAudioTrack, and IRemoteAudioTrack.

Public Types

enum  AudioFilterPosition {
  RecordingLocalPlayback, PostAudioProcessing, RemoteUserPlayback, PcmSource,
  PcmSourceSending, PcmSourceLocalPlayback
}
 

Public Member Functions

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)
 
virtual int setFilterProperty (const char *id, const char *key, const char *jsonValue)
 
virtual agora_refptr< IAudioFiltergetAudioFilter (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
 

Detailed Description

The IAudioTrack class.

Member Enumeration Documentation

◆ 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.

Member Function Documentation

◆ adjustPlayoutVolume()

virtual int adjustPlayoutVolume ( int  volume)
pure virtual

Adjusts the playback volume.

Parameters
volumeThe playback volume. The value ranges between 0 and 100 (default).
Returns
  • 0: Success.
  • < 0: Failure.

◆ getPlayoutVolume()

virtual int getPlayoutVolume ( int *  volume)
pure virtual

Gets the current playback volume.

Parameters
volumeA pointer to the playback volume.
Returns
  • 0: Success.
  • < 0: Failure.

◆ addAudioFilter()

virtual bool addAudioFilter ( agora_refptr< IAudioFilter filter,
AudioFilterPosition  position 
)
pure virtual

Adds an audio filter.

By adding an audio filter, you can apply various audio effects to the audio, for example, voice change.

Parameters
filterA pointer to the audio filter. See IAudioFilter.
positionThe position of the audio filter. See AudioFilterPosition.
Returns
  • true: Success.
  • false: Failure.

◆ removeAudioFilter()

virtual bool removeAudioFilter ( agora_refptr< IAudioFilter filter,
AudioFilterPosition  position 
)
pure virtual

Removes the audio filter added by callling addAudioFilter.

Parameters
filterThe pointer to the audio filter that you want to remove. See IAudioFilter.
positionThe position of the audio filter. See AudioFilterPosition.
Returns
  • true: Success.
  • false: Failure.

◆ enableAudioFilter()

virtual int enableAudioFilter ( const char *  id,
bool  enable 
)
inlinevirtual

Enable / Disable specified audio filter

Parameters
idid of the filter
enableenable / disable the filter with given id
Returns
  • 0: success
  • <0: failure

◆ setFilterProperty()

virtual int setFilterProperty ( const char *  id,
const char *  key,
const char *  jsonValue 
)
inlinevirtual

set the properties of the specified audio filter

Parameters
idid of the filter
keykey of the property
jsonValuejson str value of the property
Returns
  • 0: success
  • <0: failure

◆ getAudioFilter()

virtual agora_refptr<IAudioFilter> getAudioFilter ( const char *  name,
AudioFilterPosition  position 
) const
pure virtual

Gets the audio filter by its name.

Parameters
nameThe name of the audio filter.
positionThe position of the audio filter. See AudioFilterPosition.
Returns
  • The pointer to the audio filter: Success.
  • A null pointer: Failure.

◆ addAudioSink()

virtual bool addAudioSink ( agora_refptr< IAudioSinkBase sink,
const AudioSinkWants wants 
)
pure virtual

Adds an audio sink to get PCM data from the audio track.

Parameters
sinkThe pointer to the audio sink. See IAudioSinkBase.
wantsThe properties an audio frame should have when it is delivered to the sink. See AudioSinkWants.
Returns
  • true: Success.
  • false: Failure.

◆ removeAudioSink()

virtual bool removeAudioSink ( agora_refptr< IAudioSinkBase sink)
pure virtual

Removes an audio sink.

Parameters
sinkThe pointer to the audio sink to be removed. See IAudioSinkBase.
Returns
  • true: Success.
  • false: Failure.

◆ AddRef()

virtual void AddRef ( ) const
pure virtualinherited

◆ Release()

virtual RefCountReleaseStatus Release ( ) const
pure virtualinherited

◆ HasOneRef()

virtual bool HasOneRef ( ) const
pure virtualinherited