iso::synth::JackOutputUnit Class Reference

unit that writes audio data to jack output ports More...

#include <iso_synth_jack_output_unit.h>

Inherits iso::synth::OutputUnit.

Inheritance diagram for iso::synth::JackOutputUnit:

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

[legend]List of all members.

Public Member Functions
	JackOutputUnit (unsigned int pChannelCount, const String &pJackTargetPortName="") throw (SynthException)
	parameter based contructor
	JackOutputUnit (const base::String &pName, unsigned int pChannelCount, const String &pJackTargetPortName="") throw (SynthException)
	parameter based contructor
	JackOutputUnit (const data::Values &pValues) throw (SynthException)
	values based constructor
	~JackOutputUnit ()
	destructor
const String &	jackPortName () const
	return target jack port name
virtual void	process (Buffer *pBuffer=NULL) throw (SynthException)
	starts processing chain
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
	JackOutputUnit ()
	default constructor
void	addJackPort (JackPort *pJackPort)
	add Jack Port
void	MapBufferToJackPorts () throw (SynthException)
	copy the content of the audio buffer to the buffers associated with the jack ports
Protected Attributes
JackPorts	mJackPorts
	Jack Ports.
String	mJackTargetPortName
	name of target port this unit should automatically connect to
Static Protected Attributes
static unsigned int	sUnitCount
	total number of Jack Input Units
Friends
class	JackClient
std::ostream &	operator<< (std::ostream &pOstream, const JackOutputUnit &pUnit)
	print unit information

---

Detailed Description

unit that writes audio data to jack output ports

writes audio data to jack output ports

This unit retrieves audio data from it's input port and writes each audio channel to a jack output port.
The total number of jack output ports this units writes to is equivelent to the number of audio channels of the unit.
Instances of this unit are created by calling the jack managers createOutputUnit function

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

---

Constructor & Destructor Documentation

JackOutputUnit::JackOutputUnit	(	unsigned int	pChannelCount,
		const String &	pJackTargetPortName = ""
	)			throw (SynthException)

parameter based contructor

Parameters:

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

JackOutputUnit::JackOutputUnit	(	const base::String &	pName,
		unsigned int	pChannelCount,
		const String &	pJackTargetPortName = ""
	)			throw (SynthException)

parameter based contructor

Parameters:

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

JackOutputUnit::JackOutputUnit

(

const data::Values &

pValues

)

throw (SynthException)

values based constructor

Parameters:

pValues

unit values

Exceptions:

SynthException

failed to create unit

pValues structure & data types: 0: const String& : unit name 1: unsigned int : number of channels 2: const String& : name of target port this unit should automatically connect to

JackOutputUnit::~JackOutputUnit

(

)

destructor

JackOutputUnit::JackOutputUnit

(

)

[protected]

default constructor

---

Member Function Documentation

const String & JackOutputUnit::jackPortName

(

)

const

return target jack port name

Returns:

target jack port name

void JackOutputUnit::process

(

Buffer *

pBuffer = NULL

)

throw (SynthException) [virtual]

starts processing chain

Reimplemented from iso::synth::OutputUnit.

String JackOutputUnit::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::OutputUnit.

void JackOutputUnit::addJackPort

(

JackPort *

pJackPort

)

[protected]

add Jack Port

Parameters:

pJackPort

Jack Port to be added

void JackOutputUnit::MapBufferToJackPorts

(

)

throw (SynthException) [protected]

copy the content of the audio buffer to the buffers associated with the jack ports

---

Friends And Related Function Documentation

friend class JackClient [friend]

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

print unit information

---

Member Data Documentation

const String JackOutputUnit::sClassName [static]

default name

Reimplemented from iso::synth::OutputUnit.

unsigned int JackOutputUnit::sUnitCount [static, protected]

total number of Jack Input Units

Reimplemented from iso::synth::OutputUnit.

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

Jack Ports.

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

name of target port this unit should automatically connect to

---

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

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

---