gxAudioGraph Class Reference

Encapsulates a graph (or network) of audio filters. More...

#include <gxAudioGraph.h>

List of all members.

Public Types
enum	audio_graph_errors { DuplicateFilterName = 1000 }
Public Member Functions
virtual	~gxAudioGraph ()
virtual bool	accept (gxAudioFilterVisitor *visitor, bool alsoVisitPins=false)=0
virtual int	addFilter (gxAudioFilter *filter, const char *name)=0
	Add a filter to the graph.
virtual int	connectPins (gxAudioPin *outPin, gxAudioPin *inPin)=0
	Connect the output pin to the input pin.
virtual int	disconnectPin (gxAudioPin *pin)=0
	Disconnect the pin from its peer.
virtual gxAudioFilter *	findFilter (const char *name)=0
	Find the named filter.
virtual int	pause ()=0
	Pause all the filters in the graph.
virtual int	removeFilter (gxAudioFilter *filter)=0
	Remove a filter from the graph.
virtual int	run ()=0
	Run all the filters in the graph.
virtual int	sendMidi (gxAudioPin *pin, midi_message_t message)=0
virtual int	stop ()=0
	Stop all the filters in the graph.
Protected Member Functions
	gxAudioGraph ()

---

Detailed Description

Encapsulates a graph (or network) of audio filters.

Each filter contains one or more input and output pins, and the graph takes care of connecting the pins of these filters together.

---

Member Enumeration Documentation

enum gxAudioGraph::audio_graph_errors

Enumerator: DuplicateFilterName

---

Constructor & Destructor Documentation

gxAudioGraph::gxAudioGraph (   )  [inline, protected]

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

---

Member Function Documentation

virtual bool gxAudioGraph::accept (  gxAudioFilterVisitor *  visitor, bool  alsoVisitPins = false )  [pure virtual]

virtual int gxAudioGraph::addFilter (  gxAudioFilter *  filter, const char *  name )  [pure virtual]

Add a filter to the graph. Once added, the filter is "owned" by the graph and will be destroyed when the graph is destroyed. The caller must supply a name for the filter. The name must be unique within the graph. The graph must be in the "stopped" state when this method is called.

virtual int gxAudioGraph::connectPins (  gxAudioPin *  outPin, gxAudioPin *  inPin )  [pure virtual]

Connect the output pin to the input pin. Both pins must belong to filters within the graph, and both pins must be disconnected prior to calling this method.

virtual int gxAudioGraph::disconnectPin (  gxAudioPin *  pin  )  [pure virtual]

Disconnect the pin from its peer.

virtual gxAudioFilter* gxAudioGraph::findFilter (  const char *  name  )  [pure virtual]

Find the named filter. Returns a pointer to the filter if found; otherwise NULL.

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

Pause all the filters in the graph.

virtual int gxAudioGraph::removeFilter (  gxAudioFilter *  filter  )  [pure virtual]

Remove a filter from the graph. All references to the filter are removed and it is no longer owned by the graph. It is the callers responsibility to free the filter and its resources. The graph should be in the "stopped" state when this method is called.

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

Run all the filters in the graph.

virtual int gxAudioGraph::sendMidi (  gxAudioPin *  pin, midi_message_t  message )  [pure virtual]

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

Stop all the filters in the graph.

---

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

• gxAudioGraph.h

---