ALDevice Class Reference

A device is a logical mapping to an audio device through the OpenAL implementation. More...

#import <ALDevice.h>

Inheritance diagram for ALDevice:

Instance Methods
(id)	- initWithDeviceSpecifier:
	Initialize with the specified device. More...
(bool)	- isExtensionPresent:
	Check if the specified extension is present. More...
(void *)	- getProcAddress:
	Get the address of the specified procedure (C function address). More...
(void)	- clearBuffers
	Clear all buffers being used by sources of contexts opened on this device. More...
Instance Methods inherited from <OALSuspendManager>
(void)	- addSuspendListener:
	Add a listener that will receive manual suspend and interrupt events. More...
(void)	- removeSuspendListener:
	Remove a registered listener. More...

Class Methods
(id)	+ deviceWithDeviceSpecifier:
	Open the specified device. More...

Protected Attributes
NSMutableArray *	contexts
	All contexts opened from this device. More...
OALSuspendHandler *	suspendHandler
	Handles suspending and interrupting for this object. More...

Properties
NSArray *	contexts
	All contexts created on this device (ALContext*). More...
ALCdevice *	device
	The OpenAL device pointer. More...
NSArray *	extensions
	List of strings describing all extensions available on this device (NSString*). More...
int	majorVersion
	The specification revision for this implementation (major version). More...
int	minorVersion
	The specification revision for this implementation (minor version). More...
Properties inherited from <OALSuspendManager>
bool	suspended
	If YES, this object is suspended. More...
Properties inherited from <OALSuspendListener>
bool	manuallySuspended
	Set to YES to manually suspend. More...
bool	interrupted
	If YES, this object is interrupted. More...

Detailed Description

A device is a logical mapping to an audio device through the OpenAL implementation.

Method Documentation

- (void) clearBuffers

Clear all buffers being used by sources of contexts opened on this device.

+ (id) deviceWithDeviceSpecifier:

(NSString*)

deviceSpecifier

Open the specified device.

Parameters

deviceSpecifier

The device to open (nil = default device).

Returns

A new device.

- (void *) getProcAddress:

(NSString*)

functionName

Get the address of the specified procedure (C function address).

Parameters

functionName

the name of the procedure to get.

Returns

the procedure's address, or NULL if it wasn't found.

- (id) initWithDeviceSpecifier:

(NSString*)

deviceSpecifier

Initialize with the specified device.

Parameters

deviceSpecifier

The device to open (nil = default device).

Returns

the initialized device.

- (bool) isExtensionPresent:

(NSString*)

name

Check if the specified extension is present.

Parameters

name	The extension to check.

Returns

TRUE if the extension is present.

Member Data Documentation

- (NSMutableArray*) contexts

protected

All contexts opened from this device.

- (OALSuspendHandler*) suspendHandler

protected

Handles suspending and interrupting for this object.

Property Documentation

- (NSArray*) contexts

readnonatomicretain

All contexts created on this device (ALContext*).

- (ALCdevice *) device

readnonatomicassign

The OpenAL device pointer.

- (NSArray *) extensions

readnonatomicretain

List of strings describing all extensions available on this device (NSString*).

- (int) majorVersion

readnonatomicassign

The specification revision for this implementation (major version).

- (int) minorVersion

readnonatomicassign

The specification revision for this implementation (minor version).

---

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

• ALDevice.h
• ALDevice.m