ASSample Class Reference

#include <taptaudio.h>

List of all members.


Detailed Description

This is an AudioSystem Sample.

Nothing to do with ample amounts of donkeys. We can maybe move this to the cpp file...

Examples:

loopmix.cpp, mixing.cpp, record.cpp, record_basic.cpp, and volumes.cpp.

Definition at line 347 of file taptaudio.h.

Public Member Functions

 ASSample ()
 Constructor (refs start at 0).
virtual const void * getBytes () const =0
 Get a pointer to the first byte of this sample.
virtual unsigned getChannels () const =0
 Return the number of channels in this sample.
virtual AUDIO_FORMAT getFormat () const =0
 Return the format of this sample.
virtual double getSamRate () const =0
 Return the sample rate of this sample.
virtual void mixed (unsigned long, void *=0, int=-1)
 Tell this sample that frames of its data were mixed by handle.
virtual unsigned long numBytes () const =0
 Return the number of bytes in this sample.
virtual unsigned long numFrames () const =0
 Return the number of frames in this sample.
virtual bool resample (double newrate, bool highquality=false)=0
 Reample to newrate.

Public Attributes

unsigned refs
 Number of non-registry references to this sample.

Protected Member Functions

virtual ~ASSample ()
 Virtual Destructor -- does nothing, but private -- must be deleted by the audio system; NOT YOU!

Friends

class AudioSystemImpl


Constructor & Destructor Documentation

virtual ~ASSample  )  [inline, protected, virtual]
 

Virtual Destructor -- does nothing, but private -- must be deleted by the audio system; NOT YOU!

Definition at line 355 of file taptaudio.h.

ASSample  )  [inline]
 

Constructor (refs start at 0).

Definition at line 360 of file taptaudio.h.


Member Function Documentation

virtual const void* getBytes  )  const [pure virtual]
 

Get a pointer to the first byte of this sample.

virtual unsigned getChannels  )  const [pure virtual]
 

Return the number of channels in this sample.

virtual AUDIO_FORMAT getFormat  )  const [pure virtual]
 

Return the format of this sample.

virtual double getSamRate  )  const [pure virtual]
 

Return the sample rate of this sample.

virtual void mixed unsigned  long,
void *  = 0,
int  = -1
[inline, virtual]
 

Tell this sample that frames of its data were mixed by handle.

This function may by called at the interrupt level so cannot allocate memory.

Definition at line 380 of file taptaudio.h.

virtual unsigned long numBytes  )  const [pure virtual]
 

Return the number of bytes in this sample.

virtual unsigned long numFrames  )  const [pure virtual]
 

Return the number of frames in this sample.

virtual bool resample double  newrate,
bool  highquality = false
[pure virtual]
 

Reample to newrate.


Member Data Documentation

unsigned refs
 

Number of non-registry references to this sample.

Definition at line 358 of file taptaudio.h.


The documentation for this class was generated from the following file:
Generated on Thu Mar 16 11:30:43 2006 for TaptAudio by  doxygen 1.4.6