CLAM::RtAAudioDevice Class Reference

#include <RtAAudioDevice.hxx>

Inheritance diagram for CLAM::RtAAudioDevice:

CLAM::AudioDevice CLAM::AudioDevice

List of all members.


Detailed Description

Definition at line 29 of file RtAAudioDevice.hxx.


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.
 RtAAudioDevice (const std::string &str, int devID)
 ~RtAAudioDevice ()
void Start () throw ( ErrRtAudio )
 This method must be called to begin the use of this Device.
void Stop () throw ( ErrRtAudio )
 This method must be called to end the use of this Device.
void Read (Audio &samples, const int channelID)
 Reads the information given by this Device and passes data to an Audio chunk.
void Write (const Audio &samples, const int channelID)
 Writes the information given by an Audio chunk in the Devices.
virtual void GetInfo (AudioDevice::TInfo &)
 Getter for the Info of Device Object attached to this AudioDevices instantiation.

Protected Member Functions

void SetupMonoOutputStream () throw ( ErrRtAudio )
void SetupStereoOutputStream () throw ( ErrRtAudio )
void SetupMultiOutputStream () throw ( ErrRtAudio )
void SetupMonoInputStream () throw ( ErrRtAudio )
void SetupStereoInputStream () throw ( ErrRtAudio )
void SetupMultiInputStream () throw ( ErrRtAudio )
void SetupStereoFullDuplexStream () throw ( ErrRtAudio )

Classes

class  Buffer

Constructor & Destructor Documentation

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

Definition at line 255 of file RtAudio/RtAAudioDevice.cxx.

CLAM::RtAAudioDevice::~RtAAudioDevice (  ) 

Definition at line 372 of file RtAudio/RtAAudioDevice.cxx.

References Stop().

CLAM::RtAAudioDevice::RtAAudioDevice ( const std::string &  str,
int  devID 
)

CLAM::RtAAudioDevice::~RtAAudioDevice (  ) 


Member Function Documentation

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 RtAudio/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 RtAudio/RtAAudioDevice.cxx.

References RtAudio::stopStream().

Referenced by ~RtAAudioDevice().

void CLAM::RtAAudioDevice::Tick ( void   ) 

Definition at line 418 of file RtAudio/RtAAudioDevice.cxx.

References RtAudio::tickStream().

Referenced by Read(), and Write().

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 RtAudio/RtAAudioDevice.cxx.

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

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 RtAudio/RtAAudioDevice.cxx.

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

void CLAM::RtAAudioDevice::Start (  )  throw ( ErrRtAudio ) [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.

void CLAM::RtAAudioDevice::Stop (  )  throw ( ErrRtAudio ) [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.

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.

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.

void CLAM::RtAAudioDevice::GetInfo ( AudioDevice::TInfo info  )  [virtual]

Getter for the Info of Device Object attached to this AudioDevices instantiation.

Parameters:
info TInfo object that method will modify with the values of Tinfo internal object

Reimplemented from CLAM::AudioDevice.

Definition at line 263 of file Windows/RtAAudioDevice.cxx.

References CLAM::AudioDevice::GetInfo().

void CLAM::RtAAudioDevice::SetupMonoOutputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupStereoOutputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupMultiOutputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupMonoInputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupStereoInputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupMultiInputStream (  )  throw ( ErrRtAudio ) [protected]

void CLAM::RtAAudioDevice::SetupStereoFullDuplexStream (  )  throw ( ErrRtAudio ) [protected]


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

Generated on Tue Aug 12 22:33:50 2008 for CLAM by  doxygen 1.5.5