csl::FileIO Class Reference

#include <FileIO.h>

Inheritance diagram for csl::FileIO:

List of all members.

Public Member Functions
	FileIO (char *path)
	the path name determines the file type, e.g., xx.aiff, zz.snd, or yy.wav
	~FileIO ()
void	open () throw (CException)
void	start (float seconds=0) throw (CException)
void	stop () throw (CException)
void	close () throw (CException)
void	test () throw (CException)
Buffer &	getInput () throw (CException)
	test the IO's graph
Buffer &	getInput (unsigned numFrames, unsigned numChannels) throw (CException)
	Get the current input from the sound card.
Public Attributes
bool	mIsPlaying
	whether or not it's playing
bool	mIsThreadRunning
	is the background thread running?
unsigned	mDuration
	the file's buffer rate;
Protected Member Functions
void	writeNextBuffer ()
Static Protected Member Functions
static void *	threadFunction (void *)
Protected Attributes
char *	mPath
	Get the current input from the sound card.
SoundFile	mFile
Thread *	mThread
Buffer	mInBuffer
Buffer	mOutBuffer

---

Constructor & Destructor Documentation

FileIO::FileIO (  char *  path  )

the path name determines the file type, e.g., xx.aiff, zz.snd, or yy.wav

FileIO::~FileIO (   )

---

Member Function Documentation

void FileIO::open (   )  throw (CException)

void FileIO::start (  float  seconds = 0  )  throw (CException)

seconds is optional. If not passed, starts a background thread, playing and writing. otherwise run for x seconds (so it doesn't return until done).

void FileIO::stop (   )  throw (CException)

void FileIO::close (   )  throw (CException)

void csl::FileIO::test (   )  throw (CException) [inline]

Buffer& csl::FileIO::getInput (   )  throw (CException) [inline]

test the IO's graph

Buffer& csl::FileIO::getInput (  unsigned  numFrames, unsigned  numChannels )  throw (CException) [inline]

Get the current input from the sound card.

void * FileIO::threadFunction (  void *   )  [static, protected]

void FileIO::writeNextBuffer (   )  [protected]

---

Member Data Documentation

bool csl::FileIO::mIsPlaying

whether or not it's playing

bool csl::FileIO::mIsThreadRunning

is the background thread running?

unsigned csl::FileIO::mDuration

the file's buffer rate;

char* csl::FileIO::mPath [protected]

Get the current input from the sound card.

SoundFile csl::FileIO::mFile [protected]

Thread* csl::FileIO::mThread [protected]

Buffer csl::FileIO::mInBuffer [protected]

Buffer csl::FileIO::mOutBuffer [protected]

---

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

• CSL/IO/FileIO.h
• CSL/IO/FileIO.cpp

---