CLAM-Development: CLAM::RtAAudioDevice Class Reference

CLAM-Development 1.3

#include <RtAAudioDevice.hxx>

List of all members.

Classes
class	Buffer
Public Member Functions
	RtAAudioDevice (const std::string &name, int _device)
	~RtAAudioDevice ()
void	Start (void) throw (Err)
	This method must be called to begin the use of this Device.
void	Stop (void) throw (Err)
	This method must be called to end the use of this Device.
void	Tick (void)
void	Read (Audio &audio, const int channelID)
	Reads the information given by this Device and passes data to an Audio chunk.
void	Write (const Audio &audio, const int channelID)
	Writes the information given by an Audio chunk in the Devices.

Detailed Description

Definition at line 29 of file RtAAudioDevice.hxx.

Constructor & Destructor Documentation

CLAM::RtAAudioDevice::RtAAudioDevice	(	const std::string &	name,
		int	_device
	)

Definition at line 255 of file RtAAudioDevice.cxx.

CLAM::RtAAudioDevice::~RtAAudioDevice ( )

Definition at line 372 of file RtAAudioDevice.cxx.

References Stop().

Member Function Documentation

void CLAM::RtAAudioDevice::Read	(	Audio &	audio,
		const int	channelID
	)		`[virtual]`

Reads the information given by this Device and passes data to an Audio chunk.

Must be implemented by any Device derived from this class.

Parameters:

audio	Audio object where data will be stored.
channelID	Channel to read.

Implements CLAM::AudioDevice.

Definition at line 377 of file RtAAudioDevice.cxx.

References CLAM::Audio::GetSize(), RtAudio::startStream(), and Tick().

void CLAM::RtAAudioDevice::Start ( void ) throw (Err) [virtual]

This method must be called to begin the use of this Device.

Must be implemented by any Device derived from this class

Implements CLAM::AudioDevice.

Definition at line 265 of file RtAAudioDevice.cxx.

References FORMAT, RtAudio::getStreamBuffer(), CLAM::AudioDevice::Latency(), CLAM::AudioDevice::mInputs, CLAM::AudioDevice::mOutputs, CLAM::AudioDevice::SampleRate(), and CLAM::AudioDevice::SetLatency().

void CLAM::RtAAudioDevice::Stop ( void ) throw (Err) [virtual]

This method must be called to end the use of this Device.

Must be implemented by any Device derived from this class

Implements CLAM::AudioDevice.

Definition at line 361 of file RtAAudioDevice.cxx.

References RtAudio::stopStream().

Referenced by ~RtAAudioDevice().

void CLAM::RtAAudioDevice::Tick ( void )

Definition at line 418 of file RtAAudioDevice.cxx.

References RtAudio::tickStream().

Referenced by Read(), and Write().

void CLAM::RtAAudioDevice::Write	(	const Audio &	audio,
		const int	channelID
	)		`[virtual]`

Writes the information given by an Audio chunk in the Devices.

Must be implemented by any Device derived from this class.

Parameters:

audio	Audio object with values that must to be passed to Devices
channelID	Channel to write

Implements CLAM::AudioDevice.

Definition at line 401 of file RtAAudioDevice.cxx.

References CLAM::Audio::GetSize(), RtAudio::startStream(), and Tick().

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