gxAudioPin Class Reference

#include <gxAudioPin.h>

List of all members.

Public Types
enum	pintype_t { PINTYPE_DIRECTX_AUDIO = 1, PINTYPE_DIRECTX_MIDI = 2 }
Public Member Functions
virtual	~gxAudioPin ()
virtual gxAudioPin *	getOtherPin ()=0
	Get the other pin that is connected to this one (if any).
virtual void	enable (bool isEnabled)=0
	Enables or disabled the pin.
virtual bool	isEnabled ()=0
	Specifies whether the pin is enabled.
virtual std::string	getId ()=0
	Get this pin's identification string.
virtual std::string	getName ()=0
	Get the display name for this pin.
virtual bool	isInput ()=0
	Returns true if this is an input pin.
virtual gxAudioFilter *	getFilter ()=0
	Get the filter that "owns" this pin.
virtual bool	isPinType (pintype_t theType)=0
virtual bool	isMemberOf (const char *groupName)=0
	Specifies whether this pin is member of the named group.
virtual void	joinGroup (const char *groupName)=0
	Causes this pin to join the named group.
virtual void	leaveGroup (const char *groupName)=0
	Causes this pin to leave the named group.
virtual void	setMidiTransform (gxMidiTransform *transform, bool own=true)=0
	Add a midi transform for this pin.
virtual gxMidiTransform *	getMidiTransform ()=0
	Return a reference to the midi transform assigned to this pin.
virtual int	onMidiInput (gxMidiDataQueue *queue)=0
	MIDI input pins should override this to receive MIDI events.
Protected Member Functions
	gxAudioPin ()

---

Member Enumeration Documentation

enum gxAudioPin::pintype_t

Enumerator: PINTYPE_DIRECTX_AUDIO  PINTYPE_DIRECTX_MIDI

---

Constructor & Destructor Documentation

gxAudioPin::gxAudioPin (   )  [inline, protected]

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

---

Member Function Documentation

virtual void gxAudioPin::enable (  bool  isEnabled  )  [pure virtual]

Enables or disabled the pin. Not all pin types support enabling. This feature is typically used with pins attached to midi in/out ports to open/close the respective port.

virtual gxAudioFilter* gxAudioPin::getFilter (   )  [pure virtual]

Get the filter that "owns" this pin.

virtual std::string gxAudioPin::getId (   )  [pure virtual]

Get this pin's identification string. Must be unique within the filter.

virtual gxMidiTransform* gxAudioPin::getMidiTransform (   )  [pure virtual]

Return a reference to the midi transform assigned to this pin. If there is no transform, return NULL.

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

Get the display name for this pin.

virtual gxAudioPin* gxAudioPin::getOtherPin (   )  [pure virtual]

Get the other pin that is connected to this one (if any).

virtual bool gxAudioPin::isEnabled (   )  [pure virtual]

Specifies whether the pin is enabled. Not all pin types support enabling. This feature is typically used with pins attached to midi in/out ports to open/close the respective port.

virtual bool gxAudioPin::isInput (   )  [pure virtual]

Returns true if this is an input pin. False if this is an output pin.

virtual bool gxAudioPin::isMemberOf (  const char *  groupName  )  [pure virtual]

Specifies whether this pin is member of the named group.

virtual bool gxAudioPin::isPinType (  pintype_t  theType  )  [pure virtual]

virtual void gxAudioPin::joinGroup (  const char *  groupName  )  [pure virtual]

Causes this pin to join the named group.

virtual void gxAudioPin::leaveGroup (  const char *  groupName  )  [pure virtual]

Causes this pin to leave the named group.

virtual int gxAudioPin::onMidiInput (  gxMidiDataQueue *  queue  )  [pure virtual]

MIDI input pins should override this to receive MIDI events.

virtual void gxAudioPin::setMidiTransform (  gxMidiTransform *  transform, bool  own = true )  [pure virtual]

Add a midi transform for this pin. Only meaningful for midi pins. If "own" is true, the transform must be allocated on the heap and is "owned" by the output pin which will eventually delete it. The transform will be invoked on all midi data being sent to this pin. To disable the transform, invoke this method passing NULL as the transform argument.

---

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

• gxAudioPin.h

---