ASSample Class Reference

#include <taptaudio.h>

Inheritance diagram for ASSample:

[legend]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 225 of file taptaudio.h.

Public Member Functions
	ASSample ()
	Constructor (refs start at 0).
virtual const void *	getBytes ()=0
	Get a pointer to the first byte of this sample.
virtual unsigned	getChannels ()=0
	Return the number of channels in this sample.
virtual AUDIO_FORMAT	getFormat ()=0
	Return the format of this sample.
virtual double	getSamRate ()=0
	Return the sample rate of this sample.
virtual void	mixed (unsigned long, void *=0)
	Tell this sample that frames of its data were mixed by handle.
virtual unsigned long	numBytes ()=0
	Return the number of bytes in this sample.
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 233 of file taptaudio.h.

ASSample (   )  [inline]

Constructor (refs start at 0). Definition at line 238 of file taptaudio.h.

---

Member Function Documentation

virtual const void* getBytes (   )  [pure virtual]

Get a pointer to the first byte of this sample. Implemented in PCMSample. Referenced by AudioSystemImpl::doPlay().

virtual unsigned getChannels (   )  [pure virtual]

Return the number of channels in this sample. Implemented in PCMSample. Referenced by AudioSystemImpl::doPlay(), and AudioSystemImpl::loadSample().

virtual AUDIO_FORMAT getFormat (   )  [pure virtual]

Return the format of this sample. Implemented in PCMSample. Referenced by AudioSystemImpl::loadSample().

virtual double getSamRate (   )  [pure virtual]

Return the sample rate of this sample. Implemented in PCMSample. Referenced by AudioSystemMixerT::loadSample(), and AudioSystemImpl::loadSample().

virtual void mixed (  unsigned  long, void *  = 0 )  [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 253 of file taptaudio.h.

virtual unsigned long numBytes (   )  [pure virtual]

Return the number of bytes in this sample. Implemented in PCMSample. Referenced by AudioSystemImpl::doPlay().

---

Member Data Documentation

unsigned refs

Number of non-registry references to this sample. Definition at line 236 of file taptaudio.h. Referenced by AudioSystemImpl::doPlay(), AudioSystemImpl::freeSample(), AudioSystemImpl::mixSample(), AudioSystemMixer::stopSample(), and AudioSystemImpl::stopSample().

---

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

• taptaudio.h

---