iso::synth::JackInputUnit Class Reference

unit that reads input from jack input ports More...

#include <iso_synth_jack_input_unit.h>

Inherits iso::synth::InputUnit.

Inheritance diagram for iso::synth::JackInputUnit:

[legend]Collaboration diagram for iso::synth::JackInputUnit:

[legend]List of all members.

Public Member Functions
	JackInputUnit (unsigned int pChannelCount, const String &pJackTargetPortName="", ChannelMap *pChannelMap=NULL) throw (SynthException)
	parameter based contructor
	JackInputUnit (const base::String &pName, unsigned int pChannelCount, const String &pJackTargetPortName="", ChannelMap *pChannelMap=NULL) throw (SynthException)
	parameter based contructor
	~JackInputUnit ()
	destructor
const String &	jackPortName () const
	return target jack port name
const ChannelMap *	jackPortMap () const
	return target jack port map
virtual void	process (Buffer *pBuffer) throw (SynthException)
	processes buffer
virtual String	info (bool pPropagate=false, bool pShowPorts=true) const
	obtain textual unit information
Static Public Attributes
static const String	sClassName
	default name
Protected Member Functions
	JackInputUnit ()
	default constructor
void	addJackPort (JackPort *pJackPort)
	parameter based contructor add Jack Port
Protected Attributes
JackPorts	mJackPorts
	Jack Ports.
String	mJackTargetPortName
	name of target port this unit should automatically connect to
ChannelMap *	mJackTargetPortMap
	jack port connection scheme
Static Protected Attributes
static unsigned int	sUnitCount
	total number of Jack Input Units
Friends
class	JackClient
std::ostream &	operator<< (std::ostream &pOstream, const JackInputUnit &pUnit)
	print unit information

---

Detailed Description

unit that reads input from jack input ports

reads input from jack input ports

This unit retrieves audio data from a number of jack input ports that is equivalent to the channel count of the unit
Subsequently, the audio data is sent as an audio buffer through it's audio output port
Instances of this unit are created by calling the jack managers createInputUnit function

Created by Daniel Bisig on 6/26/06. Copyright 2006 Daniel Bisig All rights reserved.

---

Constructor & Destructor Documentation

JackInputUnit::JackInputUnit	(	unsigned int	pChannelCount,
		const String &	pJackTargetPortName = "",
		ChannelMap *	pChannelMap = NULL
	)			throw (SynthException)

parameter based contructor

Parameters:

	pChannelCount	number of channels
	pJackTargetPortName	name of target port this unit should automatically connect to
	pChannelMap	port connection map

JackInputUnit::JackInputUnit	(	const base::String &	pName,
		unsigned int	pChannelCount,
		const String &	pJackTargetPortName = "",
		ChannelMap *	pChannelMap = NULL
	)			throw (SynthException)

parameter based contructor

Parameters:

	pName	unit name
	pChannelCount	number of channels
	pJackTargetPortName	name of target port this unit should automatically connect to
	pChannelMap	port connection map

JackInputUnit::~JackInputUnit

(

)

destructor

JackInputUnit::JackInputUnit

(

)

[protected]

default constructor

---

Member Function Documentation

const String & JackInputUnit::jackPortName

(

)

const

return target jack port name

Returns:

target jack port name

const ChannelMap * JackInputUnit::jackPortMap

(

)

const

return target jack port map

Returns:

target jack port map

void JackInputUnit::process

(

Buffer *

pBuffer

)

throw (SynthException) [virtual]

processes buffer

Parameters:

pBuffer

buffer to process

fills buffer according to it's function

Reimplemented from iso::synth::InputUnit.

String JackInputUnit::info	(	bool	pPropagate = false,
		bool	pShowPorts = true
	)			const [virtual]

obtain textual unit information

Parameters:

	pPropagate	if true, the unit calls the info methods of its input ports
	pShowPorts	print port information

Returns:

String containing unit information

Reimplemented from iso::synth::InputUnit.

void JackInputUnit::addJackPort

(

JackPort *

pJackPort

)

[protected]

parameter based contructor add Jack Port

Parameters:

pJackPort

Jack Port to be added

---

Friends And Related Function Documentation

friend class JackClient [friend]

std::ostream& operator<<	(	std::ostream &	pOstream,
		const JackInputUnit &	pUnit
	)			[friend]

print unit information

---

Member Data Documentation

const String JackInputUnit::sClassName [static]

default name

Reimplemented from iso::synth::InputUnit.

unsigned int JackInputUnit::sUnitCount [static, protected]

total number of Jack Input Units

Reimplemented from iso::synth::InputUnit.

JackPorts iso::synth::JackInputUnit::mJackPorts [protected]

Jack Ports.

String iso::synth::JackInputUnit::mJackTargetPortName [protected]

name of target port this unit should automatically connect to

ChannelMap* iso::synth::JackInputUnit::mJackTargetPortMap [protected]

jack port connection scheme

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_jack_input_unit.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/unit/iso_synth_jack_input_unit.cpp

---