ALCaptureDevice Class Reference

UNIMPLEMENTED FOR IOS An OpenAL device for capturing sound data. More...

#import <ALCaptureDevice.h>

Inheritance diagram for ALCaptureDevice:

Instance Methods
(id)	- initWithDeviceSpecifier:frequency:format:bufferSize:
	Open the specified device. More...
(bool)	- startCapture
	Start capturing samples. More...
(bool)	- stopCapture
	Stop capturing samples. More...
(bool)	- moveSamples:toBuffer:
	Move captured samples to the specified buffer. More...
(bool)	- isExtensionPresent:
	Check if the specified extension is present. More...
(void *)	- getProcAddress:
	Get the address of the specified procedure (C function address). More...

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

Properties
int	captureSamples
	The number of capture samples available. 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...

Detailed Description

UNIMPLEMENTED FOR IOS An OpenAL device for capturing sound data.

Note: This functionality is NOT implemented in iOS OpenAL!
This class is a placeholder in case such functionality is added in a future iOS SDK.

Method Documentation

+ (id) deviceWithDeviceSpecifier:		(NSString*)	deviceSpecifier
frequency:		(ALCuint)	frequency
format:		(ALCenum)	format
bufferSize:		(ALCsizei)	bufferSize

Open the specified device.

Parameters

deviceSpecifier	The name of the device to open (nil = default device).
frequency	The frequency to capture at.
format	The audio format to capture as.
bufferSize	The size of buffer that the device must allocate for audio capture.

Returns

A new capture 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
frequency:		(ALCuint)	frequency
format:		(ALCenum)	format
bufferSize:		(ALCsizei)	bufferSize

Open the specified device.

Parameters

deviceSpecifier	The name of the device to open (nil = default device).
frequency	The frequency to capture at.
format	The audio format to capture as.
bufferSize	The size of buffer that the device must allocate for audio capture.

Returns

The initialized capture device.

- (bool) isExtensionPresent:

(NSString*)

name

Check if the specified extension is present.

Parameters

name	The name of the extension to check.

Returns

TRUE if the extension is present.

- (bool) moveSamples:		(ALCsizei)	numSamples
toBuffer:		(ALCvoid*)	buffer

Move captured samples to the specified buffer.

This method will fail if less than the specified number of samples have been captured.

Parameters

numSamples	The number of samples to move.
buffer	the buffer to move the samples into.

Returns

TRUE if the operation was successful.

- (bool) startCapture

Start capturing samples.

Returns

TRUE if the operation was successful.

- (bool) stopCapture

Stop capturing samples.

Returns

TRUE if the operation was successful.

Property Documentation

- (int) captureSamples

readnonatomicassign

The number of capture samples available.

- (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:

• ALCaptureDevice.h
• ALCaptureDevice.m