Inherits from NSObject
Declared in ALCaptureDevice.h

Overview

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.

Tasks

Properties

captureSamples

The number of capture samples available.

@property (nonatomic, readonly) int captureSamples

Declared In

ALCaptureDevice.h

device

The OpenAL device pointer.

@property (nonatomic, readonly) ALCdevice *device

Declared In

ALCaptureDevice.h

extensions

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

@property (nonatomic, readonly) NSArray *extensions

Declared In

ALCaptureDevice.h

majorVersion

The specification revision for this implementation (major version).

@property (nonatomic, readonly) int majorVersion

Declared In

ALCaptureDevice.h

minorVersion

The specification revision for this implementation (minor version).

@property (nonatomic, readonly) int minorVersion

Declared In

ALCaptureDevice.h

Class Methods

deviceWithDeviceSpecifier:frequency:format:bufferSize:

Open the specified device.

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

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.

Return Value

A new capture device.

Declared In

ALCaptureDevice.h

Instance Methods

getProcAddress:

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

- (void *)getProcAddress:(NSString *)functionName

Parameters

functionName

The name of the procedure to get.

Return Value

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

Declared In

ALCaptureDevice.h

initWithDeviceSpecifier:frequency:format:bufferSize:

Open the specified device.

- (id)initWithDeviceSpecifier:(NSString *)deviceSpecifier frequency:(ALCuint)frequency format:(ALCenum)format bufferSize:(ALCsizei)bufferSize

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.

Return Value

The initialized capture device.

Declared In

ALCaptureDevice.h

isExtensionPresent:

Check if the specified extension is present.

- (bool)isExtensionPresent:(NSString *)name

Parameters

name

The name of the extension to check.

Return Value

TRUE if the extension is present.

Declared In

ALCaptureDevice.h

moveSamples:toBuffer:

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

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

Parameters

numSamples

The number of samples to move.

buffer

the buffer to move the samples into.

Return Value

TRUE if the operation was successful.

Declared In

ALCaptureDevice.h

startCapture

Start capturing samples.

- (bool)startCapture

Return Value

TRUE if the operation was successful.

Declared In

ALCaptureDevice.h

stopCapture

Stop capturing samples.

- (bool)stopCapture

Return Value

TRUE if the operation was successful.

Declared In

ALCaptureDevice.h