A thin wrapper around the C OpenAL API, with a few convenience methods thrown in. More...

#include <ALWrapper.h>

Static Public Member Functions
bool	genBuffers:numBuffers: (ALuint *bufferIds,[numBuffers] ALsizei numBuffers)
	Generate buffers.
ALuint	genBuffer ()
	Generate a buffer.
bool	deleteBuffers:numBuffers: (ALuint *bufferIds,[numBuffers] ALsizei numBuffers)
	Delete buffers.
bool	deleteBuffer: (ALuint bufferId)
	Delete a buffer.
bool	isBuffer: (ALuint bufferId)
	Check if the speified buffer exists.
bool	bufferData:format:data:size:frequency: (ALuint bufferId,[format] ALenum format,[data] const ALvoid *data,[size] ALsizei size,[frequency] ALsizei frequency)
	Load data into a buffer.
bool	bufferf:parameter:value: (ALuint bufferId,[parameter] ALenum parameter,[value] ALfloat value)
	Write a float paramter to a buffer.
bool	buffer3f:parameter:v1:v2:v3: (ALuint bufferId,[parameter] ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat v3)
	Write a 3 float paramter to a buffer.
bool	bufferfv:parameter:values: (ALuint bufferId,[parameter] ALenum parameter,[values] ALfloat *values)
	Write a float array paramter to a buffer.
bool	bufferi:parameter:value: (ALuint bufferId,[parameter] ALenum parameter,[value] ALint value)
	Write an integer paramter to a buffer.
bool	buffer3i:parameter:v1:v2:v3: (ALuint bufferId,[parameter] ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint v3)
	Write a 3 integer paramter to a buffer.
bool	bufferiv:parameter:values: (ALuint bufferId,[parameter] ALenum parameter,[values] ALint *values)
	Write an integer array paramter to a buffer.
ALfloat	getBufferf:parameter: (ALuint bufferId,[parameter] ALenum parameter)
	Read a float paramter from a buffer.
bool	getBuffer3f:parameter:v1:v2:v3: (ALuint bufferId,[parameter] ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat *v3)
	Read a 3 float paramter from a buffer.
bool	getBufferfv:parameter:values: (ALuint bufferId,[parameter] ALenum parameter,[values] ALfloat *values)
	Read a float array paramter from a buffer.
ALint	getBufferi:parameter: (ALuint bufferId,[parameter] ALenum parameter)
	Read an integer paramter from a buffer.
bool	getBuffer3i:parameter:v1:v2:v3: (ALuint bufferId,[parameter] ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint *v3)
	Read a 3 integer paramter from a buffer.
bool	getBufferiv:parameter:values: (ALuint bufferId,[parameter] ALenum parameter,[values] ALint *values)
	Read an integer array paramter from a buffer.
bool	genSources:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Generate sources.
ALuint	genSource ()
	Generate a source.
bool	deleteSources:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Delete sources.
bool	deleteSource: (ALuint sourceId)
	Delete a source.
bool	isSource: (ALuint sourceId)
	Check if the speified source exists.
bool	sourcePlay: (ALuint sourceId)
	Play a source.
bool	sourcePlayv:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Play a bunch of sources.
bool	sourcePause: (ALuint sourceId)
	Pause a source.
bool	sourcePausev:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Pause a bunch of sources.
bool	sourceStop: (ALuint sourceId)
	Stop a source.
bool	sourceStopv:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Stop a bunch of sources.
bool	sourceRewind: (ALuint sourceId)
	Rewind a source.
bool	sourceRewindv:numSources: (ALuint *sourceIds,[numSources] ALsizei numSources)
	Rewind a bunch of sources.
bool	sourceQueueBuffers:numBuffers:bufferIds: (ALuint sourceId,[numBuffers] ALsizei numBuffers,[bufferIds] ALuint *bufferIds)
	Queue buffers into a source for sequential playback.
bool	sourceUnqueueBuffers:numBuffers:bufferIds: (ALuint sourceId,[numBuffers] ALsizei numBuffers,[bufferIds] ALuint *bufferIds)
	Unqueue previously queued buffers.
bool	sourcef:parameter:value: (ALuint sourceId,[parameter] ALenum parameter,[value] ALfloat value)
	Write a float paramter to a source.
bool	source3f:parameter:v1:v2:v3: (ALuint sourceId,[parameter] ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat v3)
	Write a 3 float paramter to a source.
bool	sourcefv:parameter:values: (ALuint sourceId,[parameter] ALenum parameter,[values] ALfloat *values)
	Write a float array paramter to a source.
bool	sourcei:parameter:value: (ALuint sourceId,[parameter] ALenum parameter,[value] ALint value)
	Write an integer paramter to a source.
bool	source3i:parameter:v1:v2:v3: (ALuint sourceId,[parameter] ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint v3)
	Write a 3 integer paramter to a source.
bool	sourceiv:parameter:values: (ALuint sourceId,[parameter] ALenum parameter,[values] ALint *values)
	Write an integer array paramter to a source.
ALfloat	getSourcef:parameter: (ALuint sourceId,[parameter] ALenum parameter)
	Read a float paramter from a source.
bool	getSource3f:parameter:v1:v2:v3: (ALuint sourceId,[parameter] ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat *v3)
	Read a 3 float paramter from a source.
bool	getSourcefv:parameter:values: (ALuint sourceId,[parameter] ALenum parameter,[values] ALfloat *values)
	Read a float array paramter from a source.
ALint	getSourcei:parameter: (ALuint sourceId,[parameter] ALenum parameter)
	Read an integer paramter from a source.
bool	getSource3i:parameter:v1:v2:v3: (ALuint sourceId,[parameter] ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint *v3)
	Read a 3 integer paramter from a source.
bool	getSourceiv:parameter:values: (ALuint sourceId,[parameter] ALenum parameter,[values] ALint *values)
	Read an integer array paramter from a source.
bool	listenerf:value: (ALenum parameter,[value] ALfloat value)
	Write a float paramter to the current listener.
bool	listener3f:v1:v2:v3: (ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat v3)
	Write a 3 float paramter to the current listener.
bool	listenerfv:values: (ALenum parameter,[values] ALfloat *values)
	Write a float array paramter to the current listener.
bool	listeneri:value: (ALenum parameter,[value] ALint value)
	Write an integer paramter to the current listener.
bool	listener3i:v1:v2:v3: (ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint v3)
	Write a 3 integer paramter to the current listener.
bool	listeneriv:values: (ALenum parameter,[values] ALint *values)
	Write an integer array paramter to the current listener.
ALfloat	getListenerf: (ALenum parameter)
	Read a float paramter from the current listener.
bool	getListener3f:v1:v2:v3: (ALenum parameter,[v1] ALfloat v1,[v2] ALfloat v2,[v3] ALfloat *v3)
	Read a 3 float paramter from the current listener.
bool	getListenerfv:values: (ALenum parameter,[values] ALfloat *values)
	Read a float array paramter from the current listener.
ALint	getListeneri: (ALenum parameter)
	Read an integer paramter from the current listener.
bool	getListener3i:v1:v2:v3: (ALenum parameter,[v1] ALint v1,[v2] ALint v2,[v3] ALint *v3)
	Read a 3 integer paramter from the current listener.
bool	getListeneriv:values: (ALenum parameter,[values] ALint *values)
	Read an integer array paramter from the current listener.
bool	enable: (ALenum capability)
	Enable a capability.
bool	disable: (ALenum capability)
	Disable a capability.
bool	isEnabled: (ALenum capability)
	Check if a capability is enabled.
bool	getBoolean: (ALenum parameter)
	Get a boolean parameter.
ALdouble	getDouble: (ALenum parameter)
	Get a double parameter.
ALfloat	getFloat: (ALenum parameter)
	Get a float parameter.
ALint	getInteger: (ALenum parameter)
	Get an integer parameter.
NSString *	getString: (ALenum parameter)
	Get a string parameter.
NSArray *	getNullSeparatedStringList: (ALenum parameter)
	Get a string list parameter.
NSArray *	getSpaceSeparatedStringList: (ALenum parameter)
	Get a string list parameter.
bool	getBooleanv:values: (ALenum parameter,[values] ALboolean *values)
	Get a boolean array parameter.
bool	getDoublev:values: (ALenum parameter,[values] ALdouble *values)
	Get a double array parameter.
bool	getFloatv:values: (ALenum parameter,[values] ALfloat *values)
	Get a float array parameter.
bool	getIntegerv:values: (ALenum parameter,[values] ALint *values)
	Get an integer array parameter.
bool	distanceModel: (ALenum value)
	Set the distance model.
bool	dopplerFactor: (ALfloat value)
	Set the doppler factor.
bool	speedOfSound: (ALfloat value)
	Set the speed of sound.
bool	isExtensionPresent: (NSString *extensionName)
	Check if an extension is present.
void *	getProcAddress: (NSString *functionName)
	Get the address of a procedure.
ALenum	getEnumValue: (NSString *enumName)
	Get the enum value from its name.
ALCdevice *	openDevice: (NSString *deviceName)
	Open a device.
bool	closeDevice: (ALCdevice *device)
	Close a device.
ALCcontext *	createContext:attributes: (ALCdevice device,[attributes] ALCint attributes)
	Create an OpenAL context.
bool	makeContextCurrent: (ALCcontext *context)
	Make the specified context the current context.
bool	makeContextCurrent:deviceReference: (ALCcontext context,[deviceReference] ALCdevice deviceReference)
	Make the specified context the current context, passing in a device reference for more informative logging info.
void	processContext: (ALCcontext *context)
	Process a context.
void	suspendContext: (ALCcontext *context)
	Suspend a context.
void	destroyContext: (ALCcontext *context)
	Destroy a context.
ALCcontext *	getCurrentContext ()
	Get the current context.
ALCdevice *	getContextsDevice: (ALCcontext *context)
	Get the device a context was created from.
ALCdevice *	getContextsDevice:deviceReference: (ALCcontext context,[deviceReference] ALCdevice deviceReference)
	Get the device a context was created from, passing in a device reference for more informative logging info.
bool	isExtensionPresent:name: (ALCdevice device,[name] NSString extensionName)
	Check if an extension is present on a device.
void *	getProcAddress:name: (ALCdevice device,[name] NSString functionName)
	Get the address of a procedure for a device.
ALenum	getEnumValue:name: (ALCdevice device,[name] NSString enumName)
	Get the enum value from its name.
NSString *	getString:attribute: (ALCdevice *device,[attribute] ALenum attribute)
	Get a string attribute.
NSArray *	getNullSeparatedStringList:attribute: (ALCdevice *device,[attribute] ALenum attribute)
	Get a string list attribute.
NSArray *	getSpaceSeparatedStringList:attribute: (ALCdevice *device,[attribute] ALenum attribute)
	Get a string list attribute.
ALint	getInteger:attribute: (ALCdevice *device,[attribute] ALenum attribute)
	Get an integer attribute.
bool	getIntegerv:attribute:size:data: (ALCdevice device,[attribute] ALenum attribute,[size] ALsizei size,[data] ALCint data)
	Get an integer array attribute.
ALCdevice *	openCaptureDevice:frequency:format:bufferSize: (NSString *deviceName,[frequency] ALCuint frequency,[format] ALCenum format,[bufferSize] ALCsizei bufferSize)
	UNSUPPORTED ON IOS Open an audio capture device.
bool	closeCaptureDevice: (ALCdevice *device)
	Close a capture device.
bool	startCapture: (ALCdevice *device)
	Start capturing audio data.
bool	stopCapture: (ALCdevice *device)
	Stop capturing audio data.
bool	captureSamples:buffer:numSamples: (ALCdevice device,[buffer] ALCvoid buffer,[numSamples] ALCsizei numSamples)
	Get captured samples from a device.
ALdouble	getMixerOutputDataRate ()
	Get the iOS device's mixer outut data rate.
void	setMixerOutputDataRate: (ALdouble frequency)
	Set the iOS device's mixer output data rate.
bool	bufferDataStatic:format:data:size:frequency: (ALuint bufferId,[format] ALenum format,[data] const ALvoid *data,[size] ALsizei size,[frequency] ALsizei frequency)
	Load data into a buffer.

Detailed Description

A thin wrapper around the C OpenAL API, with a few convenience methods thrown in.

Wherever possible, methods return the requested data rather than requiring a pointer to be passed in. Besides collecting the API calls into a single global object, all calls are combined with an error check. Any OpenAL errors that occur will be logged if error logging is enabled.

Member Function Documentation

bool ALWrapper::buffer3f:parameter:v1:v2:v3:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[v1] ALfloat	v1,
		[v2] ALfloat	v2,
		[v3] ALfloat	v3
	)		`[static, virtual]`

Write a 3 float paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	the parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::buffer3i:parameter:v1:v2:v3:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[v1] ALint	v1,
		[v2] ALint	v2,
		[v3] ALint	v3
	)		`[static, virtual]`

Write a 3 integer paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::bufferData:format:data:size:frequency:	(	ALuint	bufferId,
		[format] ALenum	format,
		[data] const ALvoid*	data,
		[size] ALsizei	size,
		[frequency] ALsizei	frequency
	)		`[static, virtual]`

Load data into a buffer.

Parameters:

bufferId	The ID of the buffer to load data into.
format	The format of the data being loaded (typically AL_FORMAT_MONO16 or AL_FORMAT_STEREO16).
data	The audio data.
size	The size of the data in bytes.
frequency	The sample frequency of the data.

bool ALWrapper::bufferDataStatic:format:data:size:frequency:	(	ALuint	bufferId,
		[format] ALenum	format,
		[data] const ALvoid*	data,
		[size] ALsizei	size,
		[frequency] ALsizei	frequency
	)		`[static, virtual]`

Load data into a buffer.

Unlike "bufferData", with this method the buffer will use the passed in data buffer direcly rather than allocating its own memory and copying from the data buffer.

Parameters:

bufferId	The ID of the buffer to load data into.
format	The format of the data being loaded (typically AL_FORMAT_MONO16 or AL_FORMAT_STEREO16).
data	The audio data.
size	The size of the data in bytes.
frequency	The sample frequency of the data.

bool ALWrapper::bufferf:parameter:value:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[value] ALfloat	value
	)		`[static, virtual]`

Write a float paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::bufferfv:parameter:values:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Write a float array paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::bufferi:parameter:value:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[value] ALint	value
	)		`[static, virtual]`

Write an integer paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::bufferiv:parameter:values:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Write an integer array paramter to a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::captureSamples:buffer:numSamples:	(	ALCdevice*	device,
		[buffer] ALCvoid*	buffer,
		[numSamples] ALCsizei	numSamples
	)		`[static, virtual]`

Get captured samples from a device.

Parameters:

device	the device to fetch samples from.
buffer	the buffer to copy the samples into.
numSamples	the number of samples to fetch.

bool ALWrapper::closeCaptureDevice: ( ALCdevice* device ) [static, virtual]

Close a capture device.

Parameters:

device The device to close.

Returns:: TRUE if the operation was successful.

bool ALWrapper::closeDevice: ( ALCdevice* device ) [static, virtual]

Close a device.

Parameters:

device The device to close.

Returns:: TRUE if the operation was successful.

ALCcontext * ALWrapper::createContext:attributes:	(	ALCdevice*	device,
		[attributes] ALCint*	attributes
	)		`[static, virtual]`

Create an OpenAL context.

Parameters:

device	The device to open the context on.
attributes	The attributes to use when creating the context.

Returns:: The new context.

bool ALWrapper::deleteBuffer: ( ALuint bufferId ) [static, virtual]

Delete a buffer.

Parameters:

bufferId The ID of the buffer to delete.

Returns:: TRUE if the operation was successful.

bool ALWrapper::deleteBuffers:numBuffers:	(	ALuint*	bufferIds,
		[numBuffers] ALsizei	numBuffers
	)		`[static, virtual]`

Delete buffers.

Parameters:

bufferIds	Pointer to an array containing the buffer IDs.
numBuffers	the number of buffers to delete.

Returns:: TRUE if the operation was successful.

bool ALWrapper::deleteSource: ( ALuint sourceId ) [static, virtual]

Delete a source.

Parameters:

sourceId The ID of the source to delete.

Returns:: TRUE if the operation was successful.

bool ALWrapper::deleteSources:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Delete sources.

Parameters:

sourceIds	Pointer to an array containing the source IDs.
numSources	the number of sources to delete.

Returns:: TRUE if the operation was successful.

void ALWrapper::destroyContext: ( ALCcontext* context ) [static, virtual]

Destroy a context.

Parameters:

context The contect to destroy.

Returns:: TRUE if the operation was successful.

bool ALWrapper::disable: ( ALenum capability ) [static, virtual]

Disable a capability.

Parameters:

capability The capability to disable.

Returns:: TRUE if the operation was successful.

bool ALWrapper::distanceModel: ( ALenum value ) [static, virtual]

Set the distance model.

Parameters:

value The value to set.

Returns:: TRUE if the operation was successful.

bool ALWrapper::dopplerFactor: ( ALfloat value ) [static, virtual]

Set the doppler factor.

Parameters:

value The value to set.

Returns:: TRUE if the operation was successful.

bool ALWrapper::enable: ( ALenum capability ) [static, virtual]

Enable a capability.

Parameters:

capability The capability to enable.

Returns:: TRUE if the operation was successful.

ALuint ALWrapper::genBuffer ( ) [static, virtual]

Generate a buffer.

Returns:: the buffer's ID.

bool ALWrapper::genBuffers:numBuffers:	(	ALuint*	bufferIds,
		[numBuffers] ALsizei	numBuffers
	)		`[static, virtual]`

Generate buffers.

Parameters:

bufferIds	Pointer to an array that will receive the buffer IDs.
numBuffers	the number of buffers to generate.

Returns:: TRUE if the operation was successful.

ALuint ALWrapper::genSource ( ) [static, virtual]

Generate a source.

Returns:: the source's ID.

bool ALWrapper::genSources:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Generate sources.

Parameters:

sourceIds	Pointer to an array that will receive the source IDs.
numSources	the number of sources to generate.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getBoolean: ( ALenum parameter ) [static, virtual]

Get a boolean parameter.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value.

bool ALWrapper::getBooleanv:values:	(	ALenum	parameter,
		[values] ALboolean*	values
	)		`[static, virtual]`

Get a boolean array parameter.

Parameters:

parameter	The parameter to fetch.
values	An array to hold the result.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getBuffer3f:parameter:v1:v2:v3:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[v1] ALfloat*	v1,
		[v2] ALfloat*	v2,
		[v3] ALfloat*	v3
	)		`[static, virtual]`

Read a 3 float paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getBuffer3i:parameter:v1:v2:v3:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[v1] ALint*	v1,
		[v2] ALint*	v2,
		[v3] ALint*	v3
	)		`[static, virtual]`

Read a 3 integer paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

ALfloat ALWrapper::getBufferf:parameter:	(	ALuint	bufferId,
		[parameter] ALenum	parameter
	)		`[static, virtual]`

Read a float paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getBufferfv:parameter:values:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Read a float array paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

ALint ALWrapper::getBufferi:parameter:	(	ALuint	bufferId,
		[parameter] ALenum	parameter
	)		`[static, virtual]`

Read an integer paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getBufferiv:parameter:values:	(	ALuint	bufferId,
		[parameter] ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Read an integer array paramter from a buffer.

Parameters:

bufferId	The buffer's ID.
parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

ALCdevice * ALWrapper::getContextsDevice: ( ALCcontext* context ) [static, virtual]

Get the device a context was created from.

Parameters:

context The context.

Returns:: The context's device.

ALCdevice * ALWrapper::getContextsDevice:deviceReference:	(	ALCcontext*	context,
		[deviceReference] ALCdevice*	deviceReference
	)		`[static, virtual]`

Get the device a context was created from, passing in a device reference for more informative logging info.

Parameters:

context	The context.
deviceReference	The device reference to use when logging an error.

Returns:: The context's device.

ALCcontext * ALWrapper::getCurrentContext ( ) [static, virtual]

Get the current context.

Returns:: the current context.

ALdouble ALWrapper::getDouble: ( ALenum parameter ) [static, virtual]

Get a double parameter.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value.

bool ALWrapper::getDoublev:values:	(	ALenum	parameter,
		[values] ALdouble*	values
	)		`[static, virtual]`

Get a double array parameter.

Parameters:

parameter	The parameter to fetch.
values	An array to hold the result.

Returns:: TRUE if the operation was successful.

ALenum ALWrapper::getEnumValue: ( NSString* enumName ) [static, virtual]

Get the enum value from its name.

Parameters:

enumName the name of the enum value.

Returns:: The enum value.

ALenum ALWrapper::getEnumValue:name:	(	ALCdevice*	device,
		[name] NSString*	enumName
	)		`[static, virtual]`

Get the enum value from its name.

Parameters:

device	The device to check on.
enumName	the name of the enum value.

Returns:: The enum value.

ALfloat ALWrapper::getFloat: ( ALenum parameter ) [static, virtual]

Get a float parameter.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value.

bool ALWrapper::getFloatv:values:	(	ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Get a float array parameter.

Parameters:

parameter	The parameter to fetch.
values	An array to hold the result.

Returns:: TRUE if the operation was successful.

ALint ALWrapper::getInteger: ( ALenum parameter ) [static, virtual]

Get an integer parameter.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value.

ALint ALWrapper::getInteger:attribute:	(	ALCdevice*	device,
		[attribute] ALenum	attribute
	)		`[static, virtual]`

Get an integer attribute.

Parameters:

device	The device to read the attribute from.
attribute	The attribute to fetch.

Returns:: The parameter's current value.

bool ALWrapper::getIntegerv:attribute:size:data:	(	ALCdevice*	device,
		[attribute] ALenum	attribute,
		[size] ALsizei	size,
		[data] ALCint*	data
	)		`[static, virtual]`

Get an integer array attribute.

Parameters:

device	The device to read the attribute from.
attribute	The attribute to read.
size	the size of the receiving array.
data	An array to store the values.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getIntegerv:values:	(	ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Get an integer array parameter.

Parameters:

parameter	The parameter to fetch.
values	An array to hold the result.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getListener3f:v1:v2:v3:	(	ALenum	parameter,
		[v1] ALfloat*	v1,
		[v2] ALfloat*	v2,
		[v3] ALfloat*	v3
	)		`[static, virtual]`

Read a 3 float paramter from the current listener.

Parameters:

parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getListener3i:v1:v2:v3:	(	ALenum	parameter,
		[v1] ALint*	v1,
		[v2] ALint*	v2,
		[v3] ALint*	v3
	)		`[static, virtual]`

Read a 3 integer paramter from the current listener.

Parameters:

parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

ALfloat ALWrapper::getListenerf: ( ALenum parameter ) [static, virtual]

Read a float paramter from the current listener.

Parameters:

parameter The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getListenerfv:values:	(	ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Read a float array paramter from the current listener.

Parameters:

parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

ALint ALWrapper::getListeneri: ( ALenum parameter ) [static, virtual]

Read an integer paramter from the current listener.

Parameters:

parameter The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getListeneriv:values:	(	ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Read an integer array paramter from the current listener.

Parameters:

parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

ALdouble ALWrapper::getMixerOutputDataRate ( ) [static, virtual]

Get the iOS device's mixer outut data rate.

Returns:: The mixer output data rate.

NSArray * ALWrapper::getNullSeparatedStringList: ( ALenum parameter ) [static, virtual]

Get a string list parameter.

Use this method for OpenAL parameters that return a null separated list.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value (as an array of NSString*).

NSArray * ALWrapper::getNullSeparatedStringList:attribute:	(	ALCdevice*	device,
		[attribute] ALenum	attribute
	)		`[static, virtual]`

Get a string list attribute.

Use this method for OpenAL attributes that return a null separated list.

Parameters:

device	The device to read the attribute from.
attribute	The attribute to fetch.

Returns:: The parameter's current value (as an array of NSString*).

void * ALWrapper::getProcAddress: ( NSString* functionName ) [static, virtual]

Get the address of a procedure.

Parameters:

functionName The name of the procedure to fetch.

Returns:: A pointer to the procedure, or NULL if it wasn't found.

void * ALWrapper::getProcAddress:name:	(	ALCdevice*	device,
		[name] NSString*	functionName
	)		`[static, virtual]`

Get the address of a procedure for a device.

Parameters:

device	The device to check on.
functionName	The name of the procedure to check for.

Returns:: The procedure's address, or NULL if not found.

bool ALWrapper::getSource3f:parameter:v1:v2:v3:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[v1] ALfloat*	v1,
		[v2] ALfloat*	v2,
		[v3] ALfloat*	v3
	)		`[static, virtual]`

Read a 3 float paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

bool ALWrapper::getSource3i:parameter:v1:v2:v3:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[v1] ALint*	v1,
		[v2] ALint*	v2,
		[v3] ALint*	v3
	)		`[static, virtual]`

Read a 3 integer paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.
v1	The first value to read.
v2	The second value to read.
v3	The third value to read.

Returns:: TRUE if the operation was successful.

ALfloat ALWrapper::getSourcef:parameter:	(	ALuint	sourceId,
		[parameter] ALenum	parameter
	)		`[static, virtual]`

Read a float paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getSourcefv:parameter:values:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Read a float array paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

ALint ALWrapper::getSourcei:parameter:	(	ALuint	sourceId,
		[parameter] ALenum	parameter
	)		`[static, virtual]`

Read an integer paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.

Returns:: The parameter's value.

bool ALWrapper::getSourceiv:parameter:values:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Read an integer array paramter from a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to read.
values	An array to store the values.

Returns:: TRUE if the operation was successful.

NSArray * ALWrapper::getSpaceSeparatedStringList: ( ALenum parameter ) [static, virtual]

Get a string list parameter.

Use this method for OpenAL parameters that return a space separated list.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value (as an array of NSString*).

NSArray * ALWrapper::getSpaceSeparatedStringList:attribute:	(	ALCdevice*	device,
		[attribute] ALenum	attribute
	)		`[static, virtual]`

Get a string list attribute.

Use this method for OpenAL attributes that return a space separated list.

Parameters:

device	The device to read the attribute from.
attribute	The attribute to fetch.

Returns:: The parameter's current value (as an array of NSString*).

NSString * ALWrapper::getString: ( ALenum parameter ) [static, virtual]

Get a string parameter.

Parameters:

parameter The parameter to fetch.

Returns:: The parameter's current value.

NSString * ALWrapper::getString:attribute:	(	ALCdevice*	device,
		[attribute] ALenum	attribute
	)		`[static, virtual]`

Get a string attribute.

Parameters:

device	The device to read the attribute from.
attribute	The attribute to fetch.

Returns:: The parameter's current value.

bool ALWrapper::isBuffer: ( ALuint bufferId ) [static, virtual]

Check if the speified buffer exists.

Parameters:

bufferId The ID of the buffer to query.

Returns:: TRUE if the buffer exists.

bool ALWrapper::isEnabled: ( ALenum capability ) [static, virtual]

Check if a capability is enabled.

Parameters:

capability The capability to check.

Returns:: TRUE if the capability is enabled.

bool ALWrapper::isExtensionPresent: ( NSString* extensionName ) [static, virtual]

Check if an extension is present.

Parameters:

extensionName The name of the extension to check.

Returns:: TRUE if the extension is present.

bool ALWrapper::isExtensionPresent:name:	(	ALCdevice*	device,
		[name] NSString*	extensionName
	)		`[static, virtual]`

Check if an extension is present on a device.

Parameters:

device	The device to check for an extension on.
extensionName	The name of the extension to check for.

Returns:: TRUE if the extension is present.

bool ALWrapper::isSource: ( ALuint sourceId ) [static, virtual]

Check if the speified source exists.

Parameters:

sourceId The ID of the source to query.

Returns:: TRUE if the buffer exists.

bool ALWrapper::listener3f:v1:v2:v3:	(	ALenum	parameter,
		[v1] ALfloat	v1,
		[v2] ALfloat	v2,
		[v3] ALfloat	v3
	)		`[static, virtual]`

Write a 3 float paramter to the current listener.

Parameters:

parameter	the parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::listener3i:v1:v2:v3:	(	ALenum	parameter,
		[v1] ALint	v1,
		[v2] ALint	v2,
		[v3] ALint	v3
	)		`[static, virtual]`

Write a 3 integer paramter to the current listener.

Parameters:

parameter	The parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::listenerf:value:	(	ALenum	parameter,
		[value] ALfloat	value
	)		`[static, virtual]`

Write a float paramter to the current listener.

Parameters:

parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::listenerfv:values:	(	ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Write a float array paramter to the current listener.

Parameters:

parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::listeneri:value:	(	ALenum	parameter,
		[value] ALint	value
	)		`[static, virtual]`

Write an integer paramter to the current listener.

Parameters:

parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::listeneriv:values:	(	ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Write an integer array paramter to the current listener.

Parameters:

parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::makeContextCurrent: ( ALCcontext* context ) [static, virtual]

Make the specified context the current context.

Parameters:

context the context to make current.

Returns:: TRUE if the operation was successful.

bool ALWrapper::makeContextCurrent:deviceReference:	(	ALCcontext*	context,
		[deviceReference] ALCdevice*	deviceReference
	)		`[static, virtual]`

Make the specified context the current context, passing in a device reference for more informative logging info.

Parameters:

context	The context to make current.
deviceReference	The device reference to use when logging an error.

Returns:: TRUE if the operation was successful.

ALCdevice * ALWrapper::openCaptureDevice:frequency:format:bufferSize:	(	NSString*	deviceName,
		[frequency] ALCuint	frequency,
		[format] ALCenum	format,
		[bufferSize] ALCsizei	bufferSize
	)		`[static, virtual]`

*UNSUPPORTED ON IOS* Open an audio capture device.

Parameters:

deviceName	The name of the device to open (nil = open the default device).
frequency	The sampling frequency to use.
format	The format to capture the data as.
bufferSize	The size of capture buffer to use.

Returns:: The opened device, or nil if an error occurred.

ALCdevice * ALWrapper::openDevice: ( NSString* deviceName ) [static, virtual]

Open a device.

Parameters:

deviceName The name of the device to open (nil = open the default device).

Returns:: The opened device, or nil on failure.

void ALWrapper::processContext: ( ALCcontext* context ) [static, virtual]

Process a context.

Parameters:

context The contect to process.

Returns:: TRUE if the operation was successful.

void ALWrapper::setMixerOutputDataRate: ( ALdouble frequency ) [static, virtual]

Set the iOS device's mixer output data rate.

Parameters:

frequency The output data rate (frequency).

bool ALWrapper::source3f:parameter:v1:v2:v3:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[v1] ALfloat	v1,
		[v2] ALfloat	v2,
		[v3] ALfloat	v3
	)		`[static, virtual]`

Write a 3 float paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	the parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::source3i:parameter:v1:v2:v3:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[v1] ALint	v1,
		[v2] ALint	v2,
		[v3] ALint	v3
	)		`[static, virtual]`

Write a 3 integer paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to write to.
v1	The first value to write.
v2	The second value to write.
v3	The third value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::sourcef:parameter:value:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[value] ALfloat	value
	)		`[static, virtual]`

Write a float paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::sourcefv:parameter:values:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[values] ALfloat*	values
	)		`[static, virtual]`

Write a float array paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::sourcei:parameter:value:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[value] ALint	value
	)		`[static, virtual]`

Write an integer paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to write to.
value	The value to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::sourceiv:parameter:values:	(	ALuint	sourceId,
		[parameter] ALenum	parameter,
		[values] ALint*	values
	)		`[static, virtual]`

Write an integer array paramter to a source.

Parameters:

sourceId	The source's ID.
parameter	The parameter to write to.
values	The values to write.

Returns:: TRUE if the operation was successful.

bool ALWrapper::sourcePause: ( ALuint sourceId ) [static, virtual]

Pause a source.

Parameters:

sourceId The ID of the source to pause.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourcePausev:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Pause a bunch of sources.

Parameters:

sourceIds	The sources to pause.
numSources	The number of sources in sourceIds.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourcePlay: ( ALuint sourceId ) [static, virtual]

Play a source.

Parameters:

sourceId The ID of the source to play.

Returns:: TRUE if the buffer exists.

bool ALWrapper::sourcePlayv:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Play a bunch of sources.

Parameters:

sourceIds	The sources to play.
numSources	The number of sources in sourceIds.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceQueueBuffers:numBuffers:bufferIds:	(	ALuint	sourceId,
		[numBuffers] ALsizei	numBuffers,
		[bufferIds] ALuint*	bufferIds
	)		`[static, virtual]`

Queue buffers into a source for sequential playback.

Parameters:

sourceId	The source to use for playback.
numBuffers	The number of buffers to queue.
bufferIds	The IDs of the buffers to queue.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceRewind: ( ALuint sourceId ) [static, virtual]

Rewind a source.

Parameters:

sourceId The ID of the source to rewind.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceRewindv:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Rewind a bunch of sources.

Parameters:

sourceIds	The sources to rewind.
numSources	The number of sources in sourceIds.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceStop: ( ALuint sourceId ) [static, virtual]

Stop a source.

Parameters:

sourceId The ID of the source to stop.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceStopv:numSources:	(	ALuint*	sourceIds,
		[numSources] ALsizei	numSources
	)		`[static, virtual]`

Stop a bunch of sources.

Parameters:

sourceIds	The sources to stop.
numSources	The number of sources in sourceIds.

Returns:: TRUE if the operation is successful.

bool ALWrapper::sourceUnqueueBuffers:numBuffers:bufferIds:	(	ALuint	sourceId,
		[numBuffers] ALsizei	numBuffers,
		[bufferIds] ALuint*	bufferIds
	)		`[static, virtual]`

Unqueue previously queued buffers.

Parameters:

sourceId	The source the buffers were previously queued in.
numBuffers	The number of buffers to unqueue.
bufferIds	The IDs of the buffers to unqueue.

Returns:: TRUE if the operation is successful.

bool ALWrapper::speedOfSound: ( ALfloat value ) [static, virtual]

Set the speed of sound.

Parameters:

value The value to set.

Returns:: TRUE if the operation was successful.

bool ALWrapper::startCapture: ( ALCdevice* device ) [static, virtual]

Start capturing audio data.

Parameters:

device The device to capture on.

Returns:: TRUE if the operation was successful.

bool ALWrapper::stopCapture: ( ALCdevice* device ) [static, virtual]

Stop capturing audio data.

Parameters:

device The device capturing audio data.

Returns:: TRUE if the operation was successful.

void ALWrapper::suspendContext: ( ALCcontext* context ) [static, virtual]

Suspend a context.

Parameters:

context The contect to suspend.

Returns:: TRUE if the operation was successful.

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

ALWrapper.h
ALWrapper.m

Static Public Member Functions

Detailed Description

Member Function Documentation