AudioFilter Class Reference

Public interface for all audio filter classes. More...

#include <audio_filters.h>

Inheritance diagram for AudioFilter:

[legend]List of all members.

Public Member Functions
virtual	~AudioFilter ()
virtual char *	GetDescription () const =0
virtual void	GetFrame (int16_t **buffer, int frequency, int channels, int &samples, double position, double frame_delta)=0
virtual bool	IsUsable ()
virtual bool	IsAFrameConsumer () const

---

Detailed Description

Public interface for all audio filter classes.

This contains 2 methods:

• GetDescription simply returns a GUI usable identifier for the implementing class
• GetFrame receives and overwrites an array of audio samples of a given size, relative to the position in the frame sequence

Definition at line 43 of file audio_filters.h.

---

Constructor & Destructor Documentation

virtual AudioFilter::~AudioFilter (   )  [inline, virtual]

Definition at line 46 of file audio_filters.h. {}

---

Member Function Documentation

virtual char* AudioFilter::GetDescription (   )  const [pure virtual]

Implemented in AudioFilterKeep, AudioFilterSilence, AudioFilterFadeOut, AudioFilterFadeIn, AudioGain, AudioDub, AudioMix, and GDKAudioFilterAdapter. Referenced by GDKAudioFilterAdapter::GetDescription(), and GDKAudioFilterRepository::Register().

virtual void AudioFilter::GetFrame (  int16_t **  buffer, int  frequency, int  channels, int &  samples, double  position, double  frame_delta )  [pure virtual]

Implemented in AudioFilterKeep, AudioFilterSilence, AudioFilterFadeOut, AudioFilterFadeIn, AudioGain, AudioDub, AudioMix, and GDKAudioFilterAdapter. Referenced by PageMagickAudioFilter::GetFrame(), and GDKAudioFilterAdapter::GetFrame().

virtual bool AudioFilter::IsAFrameConsumer (   )  const [inline, virtual]

Reimplemented in AudioDub. Definition at line 50 of file audio_filters.h. Referenced by PageMagickAudioFilter::GetFrame(). { return true; }

virtual bool AudioFilter::IsUsable (   )  [inline, virtual]

Definition at line 49 of file audio_filters.h. Referenced by PluginAudioFilterRepository::InstallPlugins(). { return true; }

---

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

• audio_filters.h

---