ALDevice Class Reference

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

#include <ALDevice.h>

Inheritance diagram for ALDevice:

Collaboration diagram for ALDevice:

List of all members.

Public Member Functions
id	initWithDeviceSpecifier: (NSString *deviceSpecifier)
	Initialize with the specified device.
bool	isExtensionPresent: (NSString *name)
	Check if the specified extension is present.
void *	getProcAddress: (NSString *functionName)
	Get the address of the specified procedure (C function address).
void	clearBuffers ()
	Clear all buffers being used by sources of contexts opened on this device.
void	notifyContextInitializing: (ALContext *context)
	(INTERNAL USE) Used by ALContext to announce initialization.
void	notifyContextDeallocating: (ALContext *context)
	(INTERNAL USE) Used by ALContext to announce deallocation.
Static Public Member Functions
id	deviceWithDeviceSpecifier: (NSString *deviceSpecifier)
	Open the specified device.
Protected Attributes
NSMutableArray *	contexts
	All contexts opened from this device.
OALSuspendHandler *	suspendHandler
	Handles suspending and interrupting for this object.
Properties
NSArray *	contexts
	All contexts created on this device (ALContext*).
ALCdevice *	device
	The OpenAL device pointer.
NSArray *	extensions
	List of strings describing all extensions available on this device (NSString*).
int	majorVersion
	The specification revision for this implementation (major version).
int	minorVersion
	The specification revision for this implementation (minor version).

---

Detailed Description

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

---

Member Function Documentation

void ALDevice::clearBuffers

(

)

[virtual]

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

id ALDevice::deviceWithDeviceSpecifier:

(

NSString*

deviceSpecifier

)

[static, virtual]

Open the specified device.

Parameters:

deviceSpecifier

The device to open (nil = default device).

Returns:

A new device.

void * ALDevice::getProcAddress:

(

NSString*

functionName

)

[virtual]

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 ALDevice::initWithDeviceSpecifier:

(

NSString*

deviceSpecifier

)

[virtual]

Initialize with the specified device.

Parameters:

deviceSpecifier

The device to open (nil = default device).

Returns:

the initialized device.

bool ALDevice::isExtensionPresent:

(

NSString*

name

)

[virtual]

Check if the specified extension is present.

Parameters:

name	The extension to check.

Returns:

TRUE if the extension is present.

void ALDevice::notifyContextDeallocating:

(

ALContext*

context

)

[virtual]

(INTERNAL USE) Used by ALContext to announce deallocation.

Parameters:

context

The context that is deallocating.

void ALDevice::notifyContextInitializing:

(

ALContext*

context

)

[virtual]

(INTERNAL USE) Used by ALContext to announce initialization.

Parameters:

context

The context that is initializing.

---

Member Data Documentation

NSMutableArray* ALDevice::contexts [protected]

All contexts opened from this device.

OALSuspendHandler* ALDevice::suspendHandler [protected]

Handles suspending and interrupting for this object.

---

Property Documentation

NSArray* ALDevice::contexts [read, assign]

All contexts created on this device (ALContext*).

ALCdevice * ALDevice::device [read, assign]

The OpenAL device pointer.

NSArray * ALDevice::extensions [read, assign]

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

int ALDevice::majorVersion [read, assign]

The specification revision for this implementation (major version).

int ALDevice::minorVersion [read, assign]

The specification revision for this implementation (minor version).

---

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

• ALDevice.h
• ALDevice.m