|
ObjectAL
|
A thin wrapper around the C OpenAL API, with a few convenience methods thrown in. More...
#import <ALWrapper.h>
Class Methods | |
| (bool) | + genBuffers:numBuffers: |
| Generate buffers. More... | |
| (ALuint) | + genBuffer |
| Generate a buffer. More... | |
| (bool) | + deleteBuffers:numBuffers: |
| Delete buffers. More... | |
| (bool) | + deleteBuffer: |
| Delete a buffer. More... | |
| (bool) | + isBuffer: |
| Check if the speified buffer exists. More... | |
| (bool) | + bufferData:format:data:size:frequency: |
| Load data into a buffer. More... | |
| (bool) | + bufferf:parameter:value: |
| Write a float paramter to a buffer. More... | |
| (bool) | + buffer3f:parameter:v1:v2:v3: |
| Write a 3 float paramter to a buffer. More... | |
| (bool) | + bufferfv:parameter:values: |
| Write a float array paramter to a buffer. More... | |
| (bool) | + bufferi:parameter:value: |
| Write an integer paramter to a buffer. More... | |
| (bool) | + buffer3i:parameter:v1:v2:v3: |
| Write a 3 integer paramter to a buffer. More... | |
| (bool) | + bufferiv:parameter:values: |
| Write an integer array paramter to a buffer. More... | |
| (ALfloat) | + getBufferf:parameter: |
| Read a float paramter from a buffer. More... | |
| (bool) | + getBuffer3f:parameter:v1:v2:v3: |
| Read a 3 float paramter from a buffer. More... | |
| (bool) | + getBufferfv:parameter:values: |
| Read a float array paramter from a buffer. More... | |
| (ALint) | + getBufferi:parameter: |
| Read an integer paramter from a buffer. More... | |
| (bool) | + getBuffer3i:parameter:v1:v2:v3: |
| Read a 3 integer paramter from a buffer. More... | |
| (bool) | + getBufferiv:parameter:values: |
| Read an integer array paramter from a buffer. More... | |
| (bool) | + genSources:numSources: |
| Generate sources. More... | |
| (ALuint) | + genSource |
| Generate a source. More... | |
| (bool) | + deleteSources:numSources: |
| Delete sources. More... | |
| (bool) | + deleteSource: |
| Delete a source. More... | |
| (bool) | + isSource: |
| Check if the speified source exists. More... | |
| (bool) | + sourcePlay: |
| Play a source. More... | |
| (bool) | + sourcePlayv:numSources: |
| Play a bunch of sources. More... | |
| (bool) | + sourcePause: |
| Pause a source. More... | |
| (bool) | + sourcePausev:numSources: |
| Pause a bunch of sources. More... | |
| (bool) | + sourceStop: |
| Stop a source. More... | |
| (bool) | + sourceStopv:numSources: |
| Stop a bunch of sources. More... | |
| (bool) | + sourceRewind: |
| Rewind a source. More... | |
| (bool) | + sourceRewindv:numSources: |
| Rewind a bunch of sources. More... | |
| (bool) | + sourceQueueBuffers:numBuffers:bufferIds: |
| Queue buffers into a source for sequential playback. More... | |
| (bool) | + sourceUnqueueBuffers:numBuffers:bufferIds: |
| Unqueue previously queued buffers. More... | |
| (bool) | + sourcef:parameter:value: |
| Write a float paramter to a source. More... | |
| (bool) | + source3f:parameter:v1:v2:v3: |
| Write a 3 float paramter to a source. More... | |
| (bool) | + sourcefv:parameter:values: |
| Write a float array paramter to a source. More... | |
| (bool) | + sourcei:parameter:value: |
| Write an integer paramter to a source. More... | |
| (bool) | + source3i:parameter:v1:v2:v3: |
| Write a 3 integer paramter to a source. More... | |
| (bool) | + sourceiv:parameter:values: |
| Write an integer array paramter to a source. More... | |
| (ALfloat) | + getSourcef:parameter: |
| Read a float paramter from a source. More... | |
| (bool) | + getSource3f:parameter:v1:v2:v3: |
| Read a 3 float paramter from a source. More... | |
| (bool) | + getSourcefv:parameter:values: |
| Read a float array paramter from a source. More... | |
| (ALint) | + getSourcei:parameter: |
| Read an integer paramter from a source. More... | |
| (bool) | + getSource3i:parameter:v1:v2:v3: |
| Read a 3 integer paramter from a source. More... | |
| (bool) | + getSourceiv:parameter:values: |
| Read an integer array paramter from a source. More... | |
| (bool) | + listenerf:value: |
| Write a float paramter to the current listener. More... | |
| (bool) | + listener3f:v1:v2:v3: |
| Write a 3 float paramter to the current listener. More... | |
| (bool) | + listenerfv:values: |
| Write a float array paramter to the current listener. More... | |
| (bool) | + listeneri:value: |
| Write an integer paramter to the current listener. More... | |
| (bool) | + listener3i:v1:v2:v3: |
| Write a 3 integer paramter to the current listener. More... | |
| (bool) | + listeneriv:values: |
| Write an integer array paramter to the current listener. More... | |
| (ALfloat) | + getListenerf: |
| Read a float paramter from the current listener. More... | |
| (bool) | + getListener3f:v1:v2:v3: |
| Read a 3 float paramter from the current listener. More... | |
| (bool) | + getListenerfv:values: |
| Read a float array paramter from the current listener. More... | |
| (ALint) | + getListeneri: |
| Read an integer paramter from the current listener. More... | |
| (bool) | + getListener3i:v1:v2:v3: |
| Read a 3 integer paramter from the current listener. More... | |
| (bool) | + getListeneriv:values: |
| Read an integer array paramter from the current listener. More... | |
| (bool) | + enable: |
| Enable a capability. More... | |
| (bool) | + disable: |
| Disable a capability. More... | |
| (bool) | + isEnabled: |
| Check if a capability is enabled. More... | |
| (bool) | + getBoolean: |
| Get a boolean parameter. More... | |
| (ALdouble) | + getDouble: |
| Get a double parameter. More... | |
| (ALfloat) | + getFloat: |
| Get a float parameter. More... | |
| (ALint) | + getInteger: |
| Get an integer parameter. More... | |
| (NSString *) | + getString: |
| Get a string parameter. More... | |
| (NSArray *) | + getNullSeparatedStringList: |
| Get a string list parameter. More... | |
| (NSArray *) | + getSpaceSeparatedStringList: |
| Get a string list parameter. More... | |
| (bool) | + getBooleanv:values: |
| Get a boolean array parameter. More... | |
| (bool) | + getDoublev:values: |
| Get a double array parameter. More... | |
| (bool) | + getFloatv:values: |
| Get a float array parameter. More... | |
| (bool) | + getIntegerv:values: |
| Get an integer array parameter. More... | |
| (bool) | + distanceModel: |
| Set the distance model. More... | |
| (bool) | + dopplerFactor: |
| Set the doppler factor. More... | |
| (bool) | + speedOfSound: |
| Set the speed of sound. More... | |
| (bool) | + isExtensionPresent: |
| Check if an extension is present. More... | |
| (void *) | + getProcAddress: |
| Get the address of a procedure. More... | |
| (ALenum) | + getEnumValue: |
| Get the enum value from its name. More... | |
| (ALCdevice *) | + openDevice: |
| Open a device. More... | |
| (bool) | + closeDevice: |
| Close a device. More... | |
| (ALCcontext *) | + createContext:attributes: |
| Create an OpenAL context. More... | |
| (bool) | + makeContextCurrent: |
| Make the specified context the current context. More... | |
| (bool) | + makeContextCurrent:deviceReference: |
| Make the specified context the current context, passing in a device reference for more informative logging info. More... | |
| (void) | + processContext: |
| Process a context. More... | |
| (void) | + suspendContext: |
| Suspend a context. More... | |
| (void) | + destroyContext: |
| Destroy a context. More... | |
| (ALCcontext *) | + getCurrentContext |
| Get the current context. More... | |
| (ALCdevice *) | + getContextsDevice: |
| Get the device a context was created from. More... | |
| (ALCdevice *) | + getContextsDevice:deviceReference: |
| Get the device a context was created from, passing in a device reference for more informative logging info. More... | |
| (bool) | + isExtensionPresent:name: |
| Check if an extension is present on a device. More... | |
| (void *) | + getProcAddress:name: |
| Get the address of a procedure for a device. More... | |
| (ALenum) | + getEnumValue:name: |
| Get the enum value from its name. More... | |
| (NSString *) | + getString:attribute: |
| Get a string attribute. More... | |
| (NSArray *) | + getNullSeparatedStringList:attribute: |
| Get a string list attribute. More... | |
| (NSArray *) | + getSpaceSeparatedStringList:attribute: |
| Get a string list attribute. More... | |
| (ALint) | + getInteger:attribute: |
| Get an integer attribute. More... | |
| (bool) | + getIntegerv:attribute:size:data: |
| Get an integer array attribute. More... | |
| (ALCdevice *) | + openCaptureDevice:frequency:format:bufferSize: |
| UNSUPPORTED ON IOS Open an audio capture device. More... | |
| (bool) | + closeCaptureDevice: |
| Close a capture device. More... | |
| (bool) | + startCapture: |
| Start capturing audio data. More... | |
| (bool) | + stopCapture: |
| Stop capturing audio data. More... | |
| (bool) | + captureSamples:buffer:numSamples: |
| Get captured samples from a device. More... | |
| (ALdouble) | + getMixerOutputDataRate |
| Get the iOS device's mixer outut data rate. More... | |
| (bool) | + setMixerOutputDataRate: |
| Set the iOS device's mixer output data rate. More... | |
| (bool) | + bufferDataStatic:format:data:size:frequency: |
| Load data into a buffer. More... | |
| (bool) | + asaGetListenerb: |
| Read a boolean ASA property from a listener. More... | |
| (ALint) | + asaGetListeneri: |
| Read an integer ASA property from a listener. More... | |
| (ALfloat) | + asaGetListenerf: |
| Read a floating point ASA property from a listener. More... | |
| (bool) | + asaListenerb:value: |
| Write a boolean ASA value to a listener. More... | |
| (bool) | + asaListeneri:value: |
| Write an integer ASA value to a listener. More... | |
| (bool) | + asaListenerf:value: |
| Write a floating point ASA value to a listener. More... | |
| (bool) | + asaGetSourceb:property: |
| Read a boolean ASA property from a source. More... | |
| (ALint) | + asaGetSourcei:property: |
| Read an integer ASA property from a source. More... | |
| (ALfloat) | + asaGetSourcef:property: |
| Read a floating point ASA property from a source. More... | |
| (bool) | + asaSourceb:property:value: |
| Write a boolean ASA value to a source. More... | |
| (bool) | + asaSourcei:property:value: |
| Write an integer ASA value to a source. More... | |
| (bool) | + asaSourcef:property:value: |
| Write a floating point ASA value to a source. More... | |
| (bool) | + setRenderingQuality: |
| Set the rendering quality. More... | |
| (ALint) | + getRenderingQuality |
| Get the rendering quality. More... | |
| (bool) | + addNotification:onSource:callback:userData: |
| Add a notification callback to a source. More... | |
| (bool) | + removeNotification:onSource:callback:userData: |
| Remove a notification callback from a source. More... | |
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.
| + (bool) addNotification: | (ALuint) | notificationID | |
| onSource: | (ALuint) | source | |
| callback: | (alSourceNotificationProc) | callback | |
| userData: | (void*) | userData | |
Add a notification callback to a source.
The following notification types are recognized: AL_SOURCE_STATE - Sent when a source's state changes. AL_BUFFERS_PROCESSED - Sent when all buffers have been processed. AL_QUEUE_HAS_LOOPED - Sent when a looping source has looped to it's start point.
| notificationID | The kind of notification to be informed of (see above). |
| source | The source ID. |
| callback | The function to call for notification. |
| userData | a pointer that will be passed to the callback. |
| + (bool) asaGetListenerb: | (ALuint) | property |
Read a boolean ASA property from a listener.
| property | The property to read. |
| + (ALfloat) asaGetListenerf: | (ALuint) | property |
Read a floating point ASA property from a listener.
| property | The property to read. |
| + (ALint) asaGetListeneri: | (ALuint) | property |
Read an integer ASA property from a listener.
| property | The property to read. |
| + (bool) asaGetSourceb: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
Read a boolean ASA property from a source.
| sourceId | The source's ID. |
| property | The property to read. |
| + (ALfloat) asaGetSourcef: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
Read a floating point ASA property from a source.
| sourceId | The source's ID. |
| property | The property to read. |
| + (ALint) asaGetSourcei: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
Read an integer ASA property from a source.
| sourceId | The source's ID. |
| property | The property to read. |
| + (bool) asaListenerb: | (ALuint) | property | |
| value: | (bool) | value | |
Write a boolean ASA value to a listener.
| property | The property to write to. |
| value | The value to write. |
| + (bool) asaListenerf: | (ALuint) | property | |
| value: | (ALfloat) | value | |
Write a floating point ASA value to a listener.
| property | The property to write to. |
| value | The value to write. |
| + (bool) asaListeneri: | (ALuint) | property | |
| value: | (ALint) | value | |
Write an integer ASA value to a listener.
| property | The property to write to. |
| value | The value to write. |
| + (bool) asaSourceb: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
| value: | (bool) | value | |
Write a boolean ASA value to a source.
| sourceId | The source's ID. |
| property | The property to write to. |
| value | The value to write. |
| + (bool) asaSourcef: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
| value: | (ALfloat) | value | |
Write a floating point ASA value to a source.
| sourceId | The source's ID. |
| property | The property to write to. |
| value | The value to write. |
| + (bool) asaSourcei: | (ALuint) | sourceId | |
| property: | (ALuint) | property | |
| value: | (ALint) | value | |
Write an integer ASA value to a source.
| sourceId | The source's ID. |
| property | The property to write to. |
| value | The value to write. |
| + (bool) buffer3f: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALfloat) | v1 | |
| v2: | (ALfloat) | v2 | |
| v3: | (ALfloat) | v3 | |
Write a 3 float paramter to a buffer.
| 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. |
| + (bool) buffer3i: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALint) | v1 | |
| v2: | (ALint) | v2 | |
| v3: | (ALint) | v3 | |
Write a 3 integer paramter to a buffer.
| 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. |
| + (bool) bufferData: | (ALuint) | bufferId | |
| format: | (ALenum) | format | |
| data: | (const ALvoid*) | data | |
| size: | (ALsizei) | size | |
| frequency: | (ALsizei) | frequency | |
Load data into a buffer.
| 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) bufferDataStatic: | (ALuint) | bufferId | |
| format: | (ALenum) | format | |
| data: | (const ALvoid*) | data | |
| size: | (ALsizei) | size | |
| frequency: | (ALsizei) | frequency | |
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.
| 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) bufferf: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| value: | (ALfloat) | value | |
Write a float paramter to a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) bufferfv: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Write a float array paramter to a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) bufferi: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| value: | (ALint) | value | |
Write an integer paramter to a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) bufferiv: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Write an integer array paramter to a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) captureSamples: | (ALCdevice*) | device | |
| buffer: | (ALCvoid*) | buffer | |
| numSamples: | (ALCsizei) | numSamples | |
Get captured samples from a device.
| device | the device to fetch samples from. |
| buffer | the buffer to copy the samples into. |
| numSamples | the number of samples to fetch. |
| + (bool) closeCaptureDevice: | (ALCdevice*) | device |
Close a capture device.
| device | The device to close. |
| + (bool) closeDevice: | (ALCdevice*) | device |
Close a device.
| device | The device to close. |
| + (ALCcontext *) createContext: | (ALCdevice*) | device | |
| attributes: | (ALCint*) | attributes | |
Create an OpenAL context.
| device | The device to open the context on. |
| attributes | The attributes to use when creating the context. |
| + (bool) deleteBuffer: | (ALuint) | bufferId |
Delete a buffer.
| bufferId | The ID of the buffer to delete. |
| + (bool) deleteBuffers: | (ALuint*) | bufferIds | |
| numBuffers: | (ALsizei) | numBuffers | |
Delete buffers.
| bufferIds | Pointer to an array containing the buffer IDs. |
| numBuffers | the number of buffers to delete. |
| + (bool) deleteSource: | (ALuint) | sourceId |
Delete a source.
| sourceId | The ID of the source to delete. |
| + (bool) deleteSources: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Delete sources.
| sourceIds | Pointer to an array containing the source IDs. |
| numSources | the number of sources to delete. |
| + (void) destroyContext: | (ALCcontext*) | context |
Destroy a context.
| context | The contect to destroy. |
| + (bool) disable: | (ALenum) | capability |
Disable a capability.
| capability | The capability to disable. |
| + (bool) distanceModel: | (ALenum) | value |
Set the distance model.
| value | The value to set. |
| + (bool) dopplerFactor: | (ALfloat) | value |
Set the doppler factor.
| value | The value to set. |
| + (bool) enable: | (ALenum) | capability |
Enable a capability.
| capability | The capability to enable. |
| + (ALuint) genBuffer |
Generate a buffer.
| + (bool) genBuffers: | (ALuint*) | bufferIds | |
| numBuffers: | (ALsizei) | numBuffers | |
Generate buffers.
| bufferIds | Pointer to an array that will receive the buffer IDs. |
| numBuffers | the number of buffers to generate. |
| + (ALuint) genSource |
Generate a source.
| + (bool) genSources: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Generate sources.
| sourceIds | Pointer to an array that will receive the source IDs. |
| numSources | the number of sources to generate. |
| + (bool) getBoolean: | (ALenum) | parameter |
Get a boolean parameter.
| parameter | The parameter to fetch. |
| + (bool) getBooleanv: | (ALenum) | parameter | |
| values: | (ALboolean*) | values | |
Get a boolean array parameter.
| parameter | The parameter to fetch. |
| values | An array to hold the result. |
| + (bool) getBuffer3f: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALfloat*) | v1 | |
| v2: | (ALfloat*) | v2 | |
| v3: | (ALfloat*) | v3 | |
Read a 3 float paramter from a buffer.
| 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. |
| + (bool) getBuffer3i: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALint*) | v1 | |
| v2: | (ALint*) | v2 | |
| v3: | (ALint*) | v3 | |
Read a 3 integer paramter from a buffer.
| 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. |
| + (ALfloat) getBufferf: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
Read a float paramter from a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to read. |
| + (bool) getBufferfv: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Read a float array paramter from a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (ALint) getBufferi: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
Read an integer paramter from a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to read. |
| + (bool) getBufferiv: | (ALuint) | bufferId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Read an integer array paramter from a buffer.
| bufferId | The buffer's ID. |
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (ALCdevice *) getContextsDevice: | (ALCcontext*) | context |
Get the device a context was created from.
| context | The context. |
| + (ALCdevice *) getContextsDevice: | (ALCcontext*) | context | |
| deviceReference: | (ALCdevice*) | deviceReference | |
Get the device a context was created from, passing in a device reference for more informative logging info.
| context | The context. |
| deviceReference | The device reference to use when logging an error. |
| + (ALCcontext *) getCurrentContext |
Get the current context.
| + (ALdouble) getDouble: | (ALenum) | parameter |
Get a double parameter.
| parameter | The parameter to fetch. |
| + (bool) getDoublev: | (ALenum) | parameter | |
| values: | (ALdouble*) | values | |
Get a double array parameter.
| parameter | The parameter to fetch. |
| values | An array to hold the result. |
| + (ALenum) getEnumValue: | (NSString*) | enumName |
Get the enum value from its name.
| enumName | the name of the enum value. |
| + (ALenum) getEnumValue: | (ALCdevice*) | device | |
| name: | (NSString*) | enumName | |
Get the enum value from its name.
| device | The device to check on. |
| enumName | the name of the enum value. |
| + (ALfloat) getFloat: | (ALenum) | parameter |
Get a float parameter.
| parameter | The parameter to fetch. |
| + (bool) getFloatv: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Get a float array parameter.
| parameter | The parameter to fetch. |
| values | An array to hold the result. |
| + (ALint) getInteger: | (ALenum) | parameter |
Get an integer parameter.
| parameter | The parameter to fetch. |
| + (ALint) getInteger: | (ALCdevice*) | device | |
| attribute: | (ALenum) | attribute | |
Get an integer attribute.
| device | The device to read the attribute from. |
| attribute | The attribute to fetch. |
| + (bool) getIntegerv: | (ALCdevice*) | device | |
| attribute: | (ALenum) | attribute | |
| size: | (ALsizei) | size | |
| data: | (ALCint*) | data | |
Get an integer array attribute.
| 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. |
| + (bool) getIntegerv: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Get an integer array parameter.
| parameter | The parameter to fetch. |
| values | An array to hold the result. |
| + (bool) getListener3f: | (ALenum) | parameter | |
| v1: | (ALfloat*) | v1 | |
| v2: | (ALfloat*) | v2 | |
| v3: | (ALfloat*) | v3 | |
Read a 3 float paramter from the current listener.
| parameter | The parameter to read. |
| v1 | The first value to read. |
| v2 | The second value to read. |
| v3 | The third value to read. |
| + (bool) getListener3i: | (ALenum) | parameter | |
| v1: | (ALint*) | v1 | |
| v2: | (ALint*) | v2 | |
| v3: | (ALint*) | v3 | |
Read a 3 integer paramter from the current listener.
| parameter | The parameter to read. |
| v1 | The first value to read. |
| v2 | The second value to read. |
| v3 | The third value to read. |
| + (ALfloat) getListenerf: | (ALenum) | parameter |
Read a float paramter from the current listener.
| parameter | The parameter to read. |
| + (bool) getListenerfv: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Read a float array paramter from the current listener.
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (ALint) getListeneri: | (ALenum) | parameter |
Read an integer paramter from the current listener.
| parameter | The parameter to read. |
| + (bool) getListeneriv: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Read an integer array paramter from the current listener.
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (ALdouble) getMixerOutputDataRate |
Get the iOS device's mixer outut data rate.
| + (NSArray *) getNullSeparatedStringList: | (ALenum) | parameter |
Get a string list parameter.
Use this method for OpenAL parameters that return a null separated list.
| parameter | The parameter to fetch. |
| + (NSArray *) getNullSeparatedStringList: | (ALCdevice*) | device | |
| attribute: | (ALenum) | attribute | |
Get a string list attribute.
Use this method for OpenAL attributes that return a null separated list.
| device | The device to read the attribute from. |
| attribute | The attribute to fetch. |
| + (void *) getProcAddress: | (NSString*) | functionName |
Get the address of a procedure.
| functionName | The name of the procedure to fetch. |
| + (void *) getProcAddress: | (ALCdevice*) | device | |
| name: | (NSString*) | functionName | |
Get the address of a procedure for a device.
| device | The device to check on. |
| functionName | The name of the procedure to check for. |
| + (ALint) getRenderingQuality |
Get the rendering quality.
| + (bool) getSource3f: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALfloat*) | v1 | |
| v2: | (ALfloat*) | v2 | |
| v3: | (ALfloat*) | v3 | |
Read a 3 float paramter from a source.
| 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. |
| + (bool) getSource3i: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALint*) | v1 | |
| v2: | (ALint*) | v2 | |
| v3: | (ALint*) | v3 | |
Read a 3 integer paramter from a source.
| 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. |
| + (ALfloat) getSourcef: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
Read a float paramter from a source.
| sourceId | The source's ID. |
| parameter | The parameter to read. |
| + (bool) getSourcefv: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Read a float array paramter from a source.
| sourceId | The source's ID. |
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (ALint) getSourcei: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
Read an integer paramter from a source.
| sourceId | The source's ID. |
| parameter | The parameter to read. |
| + (bool) getSourceiv: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Read an integer array paramter from a source.
| sourceId | The source's ID. |
| parameter | The parameter to read. |
| values | An array to store the values. |
| + (NSArray *) getSpaceSeparatedStringList: | (ALenum) | parameter |
Get a string list parameter.
Use this method for OpenAL parameters that return a space separated list.
| parameter | The parameter to fetch. |
| + (NSArray *) getSpaceSeparatedStringList: | (ALCdevice*) | device | |
| attribute: | (ALenum) | attribute | |
Get a string list attribute.
Use this method for OpenAL attributes that return a space separated list.
| device | The device to read the attribute from. |
| attribute | The attribute to fetch. |
| + (NSString *) getString: | (ALenum) | parameter |
Get a string parameter.
| parameter | The parameter to fetch. |
| + (NSString *) getString: | (ALCdevice*) | device | |
| attribute: | (ALenum) | attribute | |
Get a string attribute.
| device | The device to read the attribute from. |
| attribute | The attribute to fetch. |
| + (bool) isBuffer: | (ALuint) | bufferId |
Check if the speified buffer exists.
| bufferId | The ID of the buffer to query. |
| + (bool) isEnabled: | (ALenum) | capability |
Check if a capability is enabled.
| capability | The capability to check. |
| + (bool) isExtensionPresent: | (NSString*) | extensionName |
Check if an extension is present.
| extensionName | The name of the extension to check. |
| + (bool) isExtensionPresent: | (ALCdevice*) | device | |
| name: | (NSString*) | extensionName | |
Check if an extension is present on a device.
| device | The device to check for an extension on. |
| extensionName | The name of the extension to check for. |
| + (bool) isSource: | (ALuint) | sourceId |
Check if the speified source exists.
| sourceId | The ID of the source to query. |
| + (bool) listener3f: | (ALenum) | parameter | |
| v1: | (ALfloat) | v1 | |
| v2: | (ALfloat) | v2 | |
| v3: | (ALfloat) | v3 | |
Write a 3 float paramter to the current listener.
| parameter | the parameter to write to. |
| v1 | The first value to write. |
| v2 | The second value to write. |
| v3 | The third value to write. |
| + (bool) listener3i: | (ALenum) | parameter | |
| v1: | (ALint) | v1 | |
| v2: | (ALint) | v2 | |
| v3: | (ALint) | v3 | |
Write a 3 integer paramter to the current listener.
| parameter | The parameter to write to. |
| v1 | The first value to write. |
| v2 | The second value to write. |
| v3 | The third value to write. |
| + (bool) listenerf: | (ALenum) | parameter | |
| value: | (ALfloat) | value | |
Write a float paramter to the current listener.
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) listenerfv: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Write a float array paramter to the current listener.
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) listeneri: | (ALenum) | parameter | |
| value: | (ALint) | value | |
Write an integer paramter to the current listener.
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) listeneriv: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Write an integer array paramter to the current listener.
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) makeContextCurrent: | (ALCcontext*) | context |
Make the specified context the current context.
| context | the context to make current. |
| + (bool) makeContextCurrent: | (ALCcontext*) | context | |
| deviceReference: | (ALCdevice*) | deviceReference | |
Make the specified context the current context, passing in a device reference for more informative logging info.
| context | The context to make current. |
| deviceReference | The device reference to use when logging an error. |
| + (ALCdevice *) openCaptureDevice: | (NSString*) | deviceName | |
| frequency: | (ALCuint) | frequency | |
| format: | (ALCenum) | format | |
| bufferSize: | (ALCsizei) | bufferSize | |
UNSUPPORTED ON IOS Open an audio capture device.
| 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. |
| + (ALCdevice *) openDevice: | (NSString*) | deviceName |
Open a device.
| deviceName | The name of the device to open (nil = open the default device). |
| + (void) processContext: | (ALCcontext*) | context |
Process a context.
| context | The contect to process. |
| + (bool) removeNotification: | (ALuint) | notificationID | |
| onSource: | (ALuint) | source | |
| callback: | (alSourceNotificationProc) | callback | |
| userData: | (void*) | userData | |
Remove a notification callback from a source.
| notificationID | The kind of notification (see addNotification). |
| source | The source ID. |
| callback | The function to be unregistered. |
| userData | not actually needed but part of the API. |
| + (bool) setMixerOutputDataRate: | (ALdouble) | frequency |
Set the iOS device's mixer output data rate.
| frequency | The output data rate (frequency). |
| + (bool) setRenderingQuality: | (ALint) | quality |
Set the rendering quality.
The value may be one of:
ALC_MAC_OSX_SPATIAL_RENDERING_QUALITY_HIGH ALC_MAC_OSX_SPATIAL_RENDERING_QUALITY_LOW ALC_IPHONE_SPATIAL_RENDERING_QUALITY_HEADPHONES (iOS only)
| quality | The quality. |
| + (bool) source3f: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALfloat) | v1 | |
| v2: | (ALfloat) | v2 | |
| v3: | (ALfloat) | v3 | |
Write a 3 float paramter to a source.
| 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. |
| + (bool) source3i: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| v1: | (ALint) | v1 | |
| v2: | (ALint) | v2 | |
| v3: | (ALint) | v3 | |
Write a 3 integer paramter to a source.
| 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. |
| + (bool) sourcef: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| value: | (ALfloat) | value | |
Write a float paramter to a source.
| sourceId | The source's ID. |
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) sourcefv: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALfloat*) | values | |
Write a float array paramter to a source.
| sourceId | The source's ID. |
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) sourcei: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| value: | (ALint) | value | |
Write an integer paramter to a source.
| sourceId | The source's ID. |
| parameter | The parameter to write to. |
| value | The value to write. |
| + (bool) sourceiv: | (ALuint) | sourceId | |
| parameter: | (ALenum) | parameter | |
| values: | (ALint*) | values | |
Write an integer array paramter to a source.
| sourceId | The source's ID. |
| parameter | The parameter to write to. |
| values | The values to write. |
| + (bool) sourcePause: | (ALuint) | sourceId |
Pause a source.
| sourceId | The ID of the source to pause. |
| + (bool) sourcePausev: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Pause a bunch of sources.
| sourceIds | The sources to pause. |
| numSources | The number of sources in sourceIds. |
| + (bool) sourcePlay: | (ALuint) | sourceId |
Play a source.
| sourceId | The ID of the source to play. |
| + (bool) sourcePlayv: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Play a bunch of sources.
| sourceIds | The sources to play. |
| numSources | The number of sources in sourceIds. |
| + (bool) sourceQueueBuffers: | (ALuint) | sourceId | |
| numBuffers: | (ALsizei) | numBuffers | |
| bufferIds: | (ALuint*) | bufferIds | |
Queue buffers into a source for sequential playback.
| sourceId | The source to use for playback. |
| numBuffers | The number of buffers to queue. |
| bufferIds | The IDs of the buffers to queue. |
| + (bool) sourceRewind: | (ALuint) | sourceId |
Rewind a source.
| sourceId | The ID of the source to rewind. |
| + (bool) sourceRewindv: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Rewind a bunch of sources.
| sourceIds | The sources to rewind. |
| numSources | The number of sources in sourceIds. |
| + (bool) sourceStop: | (ALuint) | sourceId |
Stop a source.
| sourceId | The ID of the source to stop. |
| + (bool) sourceStopv: | (ALuint*) | sourceIds | |
| numSources: | (ALsizei) | numSources | |
Stop a bunch of sources.
| sourceIds | The sources to stop. |
| numSources | The number of sources in sourceIds. |
| + (bool) sourceUnqueueBuffers: | (ALuint) | sourceId | |
| numBuffers: | (ALsizei) | numBuffers | |
| bufferIds: | (ALuint*) | bufferIds | |
Unqueue previously queued buffers.
| sourceId | The source the buffers were previously queued in. |
| numBuffers | The number of buffers to unqueue. |
| bufferIds | The IDs of the buffers to unqueue. |
| + (bool) speedOfSound: | (ALfloat) | value |
Set the speed of sound.
| value | The value to set. |
| + (bool) startCapture: | (ALCdevice*) | device |
Start capturing audio data.
| device | The device to capture on. |
| + (bool) stopCapture: | (ALCdevice*) | device |
Stop capturing audio data.
| device | The device capturing audio data. |
| + (void) suspendContext: | (ALCcontext*) | context |
Suspend a context.
| context | The contect to suspend. |
1.8.3.1
