cAudio  2.3.0
3d Audio Engine
Classes | Typedefs | Enumerations | Functions | Variables
cAudio Namespace Reference

Main namespace for the entire cAudio library. More...

Classes

class  AudioCaptureBuffer
 
class  cAudioBuffer
 
class  cAudioCapture
 
struct  cAudioList
 
class  cAudioManager
 
struct  cAudioMap
 
class  cAudioMutex
 
class  cAudioMutexBasicLock
 
struct  cAudioSet
 
class  cAudioSource
 
class  cAudioSourceBase
 
class  cAudioStaticSource
 
class  cAudioThread
 
struct  cAudioVector
 
class  cListener
 
class  cLogger
 
class  cMemoryOverride
 Overrides the memory allocations for classes derived from it and makes them use the cAudio memory system. More...
 
class  cMemorySource
 Class used to read from a memory buffer. More...
 
class  cOpenALAudioDeviceList
 
class  cOpenALDeviceContext
 
class  cRawAudioDecoderFactory
 
class  cRawDecoder
 
class  cStandardMemoryProvider
 Memory provider that wraps the standard memalloc and free. More...
 
class  cVector3
 Class for manipulating vectors in 3D space. More...
 
class  IAudioBuffer
 interface for a sample (audio buffer): completely loaded into memory, shareable across sources More...
 
class  IAudioCapture
 Interface for capturing operations in the cAudio Engine. More...
 
class  IAudioDecoder
 Interface for all Audio Decoders in cAudio. More...
 
class  IAudioDecoderFactory
 Interface for factories that create Audio Decoders for cAudio. More...
 
class  IAudioDeviceContext
 
class  IAudioDeviceList
 
class  IAudioManager
 Interface for the playback capabilities of cAudio. More...
 
class  IAudioPlugin
 Interface for all plugins in cAudio. More...
 
class  IAudioSource
 Interface for a single audio source, which allow you to manipulate sound sources (speakers) in 2D or 3D space. More...
 
class  ICaptureEventHandler
 Interface for recieving Capture Manager Events. More...
 
class  IDataSource
 Interface for data providers in cAudio. More...
 
class  IDataSourceFactory
 Interface for creating data sources for use with the engine. More...
 
class  IListener
 Interface for the listener in cAudio. This class provides abilities to move and orient where your camera or user is in the audio world. More...
 
class  ILogger
 Interface for all logging operations in cAudio. More...
 
class  ILogReceiver
 Interface for receiving log messages and relaying them to some kind of output device or stream. More...
 
class  IManagerEventHandler
 Interface for event handlers for playback manager events. More...
 
class  IMemoryProvider
 Interface for a class that allocates and frees memory used by cAudio. More...
 
class  IPluginManager
 Interface for the plugin capabilities of cAudio. More...
 
class  IRefCounted
 Applies reference counting to certain cAudio objects. More...
 
class  ISourceEventHandler
 Interface for event handlers on Audio Sources. More...
 
class  IThread
 
class  IThreadWorker
 

Typedefs

typedef std::string cAudioString
 

Enumerations

enum  AudioFormats { EAF_8BIT_MONO, EAF_8BIT_STEREO, EAF_16BIT_MONO, EAF_16BIT_STEREO }
 Enumeration of audio formats supported by the engine.
 
enum  IDeviceType { DT_PLAYBACK = 0, DT_RECORDING = 2 }
 
enum  LogLevel {
  ELL_DEBUG, ELL_INFO, ELL_WARNING, ELL_ERROR,
  ELL_CRITICAL, ELL_COUNT
}
 Enum of all supported log levels in cAudio.
 

Functions

bool checkALErrorInternal (const char *file, const char *func, int line)
 Checks for OpenAL errors and reports them.
 
ALenum convertAudioFormatEnum (AudioFormats format)
 Converts our audio format enum to OpenAL's.
 
cAudioString getExt (const cAudioString &filename)
 Grabs the current extention of a given string.
 
cAudioVector< cAudioString >::Type getFilesInDirectory (cAudioString path)
 Returns a list of files/directories in the supplied directory. Used internally for auto-installation of plugins.
 
CAUDIO_API IAudioManagercreateAudioManager (bool initializeDefault=true, const char *lFilePath="cAudioEngineLog.html")
 Creates an interface to an Audio Manager. More...
 
CAUDIO_API void destroyAudioManager (IAudioManager *manager)
 Destroys an interface to a previously created Audio Manager and frees the memory allocated for it. More...
 
CAUDIO_API IAudioCapturecreateAudioCapture (bool initializeDefault=true)
 Creates an interface to an Audio Capture Object. More...
 
CAUDIO_API void destroyAudioCapture (IAudioCapture *capture)
 Destroys an interface to a previously created Audio Capture Object and frees the memory allocated for it. More...
 
CAUDIO_API ILoggergetLogger ()
 Gets the interface to the logger. More...
 
CAUDIO_API IAudioDeviceListcreateAudioDeviceList (IDeviceType deviceType=DT_PLAYBACK)
 Creates an interface to an IAudioDeviceList object.
 
CAUDIO_API IMemoryProvidergetMemoryProvider ()
 Returns a pointer to the memory provider of cAudio. More...
 
CAUDIO_API void cAudioSleep (unsigned int ms)
 Causes the current thread to give up control for a certain duration. More...
 
const char * toUTF8 (const cAudioString &str)
 
cAudioString fromUTF8 (const char *str)
 
bool float_equals (const float a, const float b)
 Internal function that compares two floats while keeping the Epsilon in mind.
 
CAUDIO_API IPluginManagergetPluginManager ()
 Gets the interface to the plugin manager. More...
 
bool compareDataSourcePriorities (std::pair< int, cAudioString > left, std::pair< int, cAudioString > right)
 

Variables

const float Epsilon = std::numeric_limits<float>::epsilon()
 Smallest number that can be represented with a 32 bit float (may not match your compiler/os varient)
 
const char *const LogLevelStrings []
 Contains strings for each log level to make them easier to print to a stream. More...
 

Detailed Description

Main namespace for the entire cAudio library.

Function Documentation

§ cAudioSleep()

void cAudio::cAudioSleep ( unsigned int  ms)

Causes the current thread to give up control for a certain duration.

Parameters
msamount of miliseconds to sleep

Definition at line 17 of file cAudioSleep.cpp.

Here is the caller graph for this function:

§ createAudioCapture()

CAUDIO_API IAudioCapture * cAudio::createAudioCapture ( bool  initializeDefault = true)

Creates an interface to an Audio Capture Object.

Note: This is the only way to get access to the audio capture capabilities of cAudio. You must delete this interface using destroyAudioCapture() once you are done with it.

Parameters
initializeDefaultWhether to return an object initialized with the default settings. If set to false, you must make a call to initialize before audio can be captured.
Returns
A pointer to the created object, NULL if the object could not be allocated.

Definition at line 141 of file cAudio.cpp.

Here is the call graph for this function:

§ createAudioManager()

CAUDIO_API IAudioManager * cAudio::createAudioManager ( bool  initializeDefault = true,
const char *  lFilePath = "cAudioEngineLog.html" 
)

Creates an interface to an Audio Manager.

Note: This is the only way to get access to the audio playback capabilities of cAudio. You must delete this interface using destroyAudioManager() once you are done with it.

Parameters
initializeDefaultWhether to return an object initialized with the default settings. If set to false, you must make a call to initialize before you can create audio sources.
lFilePathWhere the log file is going to be placed
Returns
A pointer to the created object, NULL if the object could not be allocated.

Definition at line 77 of file cAudio.cpp.

Here is the call graph for this function:

§ destroyAudioCapture()

CAUDIO_API void cAudio::destroyAudioCapture ( IAudioCapture capture)

Destroys an interface to a previously created Audio Capture Object and frees the memory allocated for it.

Parameters
captureThe object to destroy

Definition at line 160 of file cAudio.cpp.

§ destroyAudioManager()

CAUDIO_API void cAudio::destroyAudioManager ( IAudioManager manager)

Destroys an interface to a previously created Audio Manager and frees the memory allocated for it.

Parameters
captureThe object to destroy.

Definition at line 114 of file cAudio.cpp.

Here is the call graph for this function:

§ getLogger()

CAUDIO_API ILogger * cAudio::getLogger ( )

Gets the interface to the logger.

Note: This is the only way to get access to the logging capabilities of cAudio.

Returns
A pointer to the logger interface.

Definition at line 45 of file cAudio.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

§ getMemoryProvider()

CAUDIO_API IMemoryProvider * cAudio::getMemoryProvider ( )

Returns a pointer to the memory provider of cAudio.

Used by cAudio for all allocations of memory

Returns
A pointer to the memory provider

Definition at line 10 of file cAudioMemory.cpp.

§ getPluginManager()

CAUDIO_API IPluginManager* cAudio::getPluginManager ( )

Gets the interface to the plugin manager.

Note: This is the only way to get access to the plugin capabilities of cAudio.

Returns
A pointer to the manager.

Variable Documentation

§ LogLevelStrings

const char* const cAudio::LogLevelStrings[]
Initial value:
=
{
"Debug",
"Information",
"Warning",
"Error",
"Critical",
0
}

Contains strings for each log level to make them easier to print to a stream.

Definition at line 21 of file ILogReceiver.h.