portaudio::System Class Reference
#include <System.hxx>
Collaboration diagram for portaudio::System:
[legend]List of all members.
Detailed Description
System singleton which represents the PortAudio system.
The System is used to initialize/terminate PortAudio and provide a single acccess point to the PortAudio System (instance()). It can be used to iterate through all HostApi 's in the System as well as all devices in the System. It also provides some utility functionality of PortAudio.
Terminating the System will also abort and close the open streams. The Stream objects will need to be deallocated by the client though (it's usually a good idea to have them cleaned up automatically).
Constructor & Destructor Documentation
portaudio::System::System |
( |
|
) |
[private] |
|
portaudio::System::~System |
( |
|
) |
[private] |
|
Member Function Documentation
int portaudio::System::version |
( |
|
) |
[static] |
|
const char * portaudio::System::versionText |
( |
|
) |
[static] |
|
void portaudio::System::initialize |
( |
|
) |
[static] |
|
void portaudio::System::terminate |
( |
|
) |
[static] |
|
System & portaudio::System::instance |
( |
|
) |
[static] |
|
bool portaudio::System::exists |
( |
|
) |
[static] |
|
HostApi & portaudio::System::defaultHostApi |
( |
|
) |
|
|
HostApi & portaudio::System::hostApiByTypeId |
( |
PaHostApiTypeId |
type |
) |
|
|
HostApi & portaudio::System::hostApiByIndex |
( |
PaHostApiIndex |
index |
) |
|
|
int portaudio::System::hostApiCount |
( |
|
) |
|
|
Device & portaudio::System::defaultInputDevice |
( |
|
) |
|
|
|
Returns the System's default input Device, or the null Device if none was available. |
Device & portaudio::System::defaultOutputDevice |
( |
|
) |
|
|
|
Returns the System's default output Device, or the null Device if none was available. |
Device & portaudio::System::deviceByIndex |
( |
PaDeviceIndex |
index |
) |
|
|
|
Returns the Device for the given index. Will throw a paInternalError equivalent PaException if the given index is out of range. |
int portaudio::System::deviceCount |
( |
|
) |
|
|
Device & portaudio::System::nullDevice |
( |
|
) |
[static] |
|
void portaudio::System::sleep |
( |
long |
msec |
) |
|
|
int portaudio::System::sizeOfSample |
( |
PaSampleFormat |
format |
) |
|
|
Member Data Documentation
The documentation for this class was generated from the following files:
Generated on Fri Apr 2 20:22:53 2004 for PortAudioCpp by
1.3.6