gxAudioFilter Class Reference

An audio filter, such as a soft synth or an effect. More...

#include <gxAudioFilter.h>

Inheritance diagram for gxAudioFilter:

List of all members.

Public Member Functions
virtual	~gxAudioFilter ()
virtual bool	accept (gxAudioFilterVisitor *visitor)=0
virtual gxAudioClockSink *	castClockSink ()=0
	Specifies whether this filter is a clock sync, and if so, provides a reference to the gxAudioClockSink interface implemented by this filter.
virtual gxAudioClockSource *	castClockSource ()=0
	Specifies whether this filter is a clock source, and if so, provides a reference to the gxAudioClockSource interface implemented by this filter.
virtual int	createPanel (gxPanel **panel)=0
	Create a GUI panel for this filter.
virtual gxAudioPin *	findPinById (const char *id)=0
	Finds a pin on the filter with the given id (or NULL if no such pin found.
virtual gxAudioPin *	findPinByName (const char *name)=0
	Finds a pin on the filter with the given name (or NULL if no such pin found.
virtual gxAudioGraph *	getGraph ()=0
	Return the graph that contains this filter.
virtual std::string	getName ()=0
	Returns the name of the filter instance.
virtual gxAudioPin *	getPin (int index)=0
	Returns a reference to the specified pin.
virtual int	getPinCount ()=0
	Returns the total number of pins (both input and output) of the filter.
virtual state_t	getState ()=0
	Return the run state of the filter.
virtual bool	isRunDirectly ()=0
	Specifies whether the graph must directly invoke the run/pause/stop methods on this object.
virtual bool	isSoundSource ()=0
	Specifies whether this filter is a sound source such as a soft synth.
virtual int	loadFile (const char *fileName)=0
	If the filter supports persistence, load its state from the specified file.
virtual int	pause ()=0
	Pause the filter.
virtual int	run ()=0
	Run the filter.
virtual int	saveFile (const char *fileName)=0
	If the filter supports persistence, save its state to the specified file.
virtual int	stop ()=0
	Stop the filter.
virtual void	groupPins (const char *groupName, int pinType, bool isInput)=0
	For each pin in the filter that matches the type and isInput arguments, have that pin join the named group.
virtual gxAudioCard *	getAudioCard ()=0
virtual int	loadString (const char *str)=0
virtual int	saveString (std::string *str)=0
virtual gxProperties &	getProperties ()=0
Protected Member Functions
	gxAudioFilter ()

---

Detailed Description

An audio filter, such as a soft synth or an effect.

---

Constructor & Destructor Documentation

gxAudioFilter::gxAudioFilter (   )  [inline, protected]

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

---

Member Function Documentation

virtual bool gxAudioFilter::accept (  gxAudioFilterVisitor *  visitor  )  [pure virtual]

virtual gxAudioClockSink* gxAudioFilter::castClockSink (   )  [pure virtual]

Specifies whether this filter is a clock sync, and if so, provides a reference to the gxAudioClockSink interface implemented by this filter. Returns NULL if this filter is not a clock sink.

virtual gxAudioClockSource* gxAudioFilter::castClockSource (   )  [pure virtual]

Specifies whether this filter is a clock source, and if so, provides a reference to the gxAudioClockSource interface implemented by this filter. Returns NULL if this filter is not a clock sink.

virtual int gxAudioFilter::createPanel (  gxPanel **  panel  )  [pure virtual]

Create a GUI panel for this filter. The panel can be displayed as a child of any window in the application.

virtual gxAudioPin* gxAudioFilter::findPinById (  const char *  id  )  [pure virtual]

Finds a pin on the filter with the given id (or NULL if no such pin found. )

virtual gxAudioPin* gxAudioFilter::findPinByName (  const char *  name  )  [pure virtual]

Finds a pin on the filter with the given name (or NULL if no such pin found. )

virtual gxAudioCard* gxAudioFilter::getAudioCard (   )  [pure virtual]

virtual gxAudioGraph* gxAudioFilter::getGraph (   )  [pure virtual]

Return the graph that contains this filter. If the filter is not in a graph, return NULL.

virtual std::string gxAudioFilter::getName (   )  [pure virtual]

Returns the name of the filter instance. This value is only meaningful when the filter has been added to a graph.

virtual gxAudioPin* gxAudioFilter::getPin (  int  index  )  [pure virtual]

Returns a reference to the specified pin. index is zero-based and must be a positive integer between 0 and "getPinCount() - 1".

virtual int gxAudioFilter::getPinCount (   )  [pure virtual]

Returns the total number of pins (both input and output) of the filter.

virtual gxProperties& gxAudioFilter::getProperties (   )  [pure virtual]

virtual state_t gxAudioFilter::getState (   )  [pure virtual]

Return the run state of the filter.

virtual void gxAudioFilter::groupPins (  const char *  groupName, int  pinType, bool  isInput )  [pure virtual]

For each pin in the filter that matches the type and isInput arguments, have that pin join the named group.

virtual bool gxAudioFilter::isRunDirectly (   )  [pure virtual]

Specifies whether the graph must directly invoke the run/pause/stop methods on this object. (DirectX filters will return false because they get their run/pause/stop from IFilterGraph

virtual bool gxAudioFilter::isSoundSource (   )  [pure virtual]

Specifies whether this filter is a sound source such as a soft synth. If so, it will have an input pin that needs a null source driven by the audio clock.

virtual int gxAudioFilter::loadFile (  const char *  fileName  )  [pure virtual]

If the filter supports persistence, load its state from the specified file. If the filter does not support persistence, it returns a non-zero value.

virtual int gxAudioFilter::loadString (  const char *  str  )  [pure virtual]

virtual int gxAudioFilter::pause (   )  [pure virtual]

Pause the filter. Implements gxMediaControl.

virtual int gxAudioFilter::run (   )  [pure virtual]

Run the filter. Implements gxMediaControl.

virtual int gxAudioFilter::saveFile (  const char *  fileName  )  [pure virtual]

If the filter supports persistence, save its state to the specified file. If the filter does not support persistence, it returns a non-zero value.

virtual int gxAudioFilter::saveString (  std::string *  str  )  [pure virtual]

virtual int gxAudioFilter::stop (   )  [pure virtual]

Stop the filter. Implements gxMediaControl.

---

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

• gxAudioFilter.h

---