com.jme3.audio.openal

Interface ALC

All Known Implementing Classes:

AndroidALC, IosALC, LwjglALC

public interface ALC

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALC_ALL_ATTRIBUTES
static int	ALC_ALL_DEVICES_SPECIFIER
static int	ALC_ATTRIBUTES_SIZE
static int	ALC_CAPTURE_DEFAULT_DEVICE_SPECIFIER
static int	ALC_CAPTURE_DEVICE_SPECIFIER Capture extension
static int	ALC_CAPTURE_SAMPLES
static int	ALC_DEFAULT_ALL_DEVICES_SPECIFIER ALC_ENUMERATE_ALL_EXT enums
static int	ALC_DEFAULT_DEVICE_SPECIFIER The Specifier string for default device
static int	ALC_DEVICE_SPECIFIER
static int	ALC_EXTENSIONS
static int	ALC_INVALID_CONTEXT invalid context ID
static int	ALC_INVALID_DEVICE No device
static int	ALC_INVALID_ENUM bad enum
static int	ALC_INVALID_VALUE bad value
static int	ALC_MAJOR_VERSION
static int	ALC_MINOR_VERSION
static int	ALC_NO_ERROR No error
static int	ALC_OUT_OF_MEMORY Out of memory.

Method Summary

Modifier and Type	Method and Description
void	alcDevicePauseSOFT() Pauses a playback device.
void	alcDeviceResumeSOFT() Resumes playback of a paused device.
void	alcGetInteger(int param, java.nio.IntBuffer buffer, int size) Obtains integer value(s) from ALC.
java.lang.String	alcGetString(int parameter) Obtains string value(s) from ALC.
boolean	alcIsExtensionPresent(java.lang.String extension) Verifies that a given extension is available for the current context and the device it is associated with.
void	createALC() Creates an AL context.
void	destroyALC() Destroys an AL context.
boolean	isCreated() Checks of creating an AL context.

Field Detail

ALC_NO_ERROR

static final int ALC_NO_ERROR

No error

See Also:

Constant Field Values

ALC_INVALID_DEVICE

static final int ALC_INVALID_DEVICE

No device

See Also:

Constant Field Values

ALC_INVALID_CONTEXT

static final int ALC_INVALID_CONTEXT

invalid context ID

See Also:

Constant Field Values

ALC_INVALID_ENUM

static final int ALC_INVALID_ENUM

bad enum

See Also:

Constant Field Values

ALC_INVALID_VALUE

static final int ALC_INVALID_VALUE

bad value

See Also:

Constant Field Values

ALC_OUT_OF_MEMORY

static final int ALC_OUT_OF_MEMORY

Out of memory.

See Also:

Constant Field Values

ALC_DEFAULT_DEVICE_SPECIFIER

static final int ALC_DEFAULT_DEVICE_SPECIFIER

The Specifier string for default device

See Also:

Constant Field Values

ALC_DEVICE_SPECIFIER

static final int ALC_DEVICE_SPECIFIER

See Also:

Constant Field Values

ALC_EXTENSIONS

static final int ALC_EXTENSIONS

See Also:

Constant Field Values

ALC_MAJOR_VERSION

static final int ALC_MAJOR_VERSION

See Also:

Constant Field Values

ALC_MINOR_VERSION

static final int ALC_MINOR_VERSION

See Also:

Constant Field Values

ALC_ATTRIBUTES_SIZE

static final int ALC_ATTRIBUTES_SIZE

See Also:

Constant Field Values

ALC_ALL_ATTRIBUTES

static final int ALC_ALL_ATTRIBUTES

See Also:

Constant Field Values

ALC_CAPTURE_DEVICE_SPECIFIER

static final int ALC_CAPTURE_DEVICE_SPECIFIER

Capture extension

See Also:

Constant Field Values

ALC_CAPTURE_DEFAULT_DEVICE_SPECIFIER

static final int ALC_CAPTURE_DEFAULT_DEVICE_SPECIFIER

See Also:

Constant Field Values

ALC_CAPTURE_SAMPLES

static final int ALC_CAPTURE_SAMPLES

See Also:

Constant Field Values

ALC_DEFAULT_ALL_DEVICES_SPECIFIER

static final int ALC_DEFAULT_ALL_DEVICES_SPECIFIER

ALC_ENUMERATE_ALL_EXT enums

See Also:

Constant Field Values

ALC_ALL_DEVICES_SPECIFIER

static final int ALC_ALL_DEVICES_SPECIFIER

See Also:

Constant Field Values

Method Detail

createALC

void createALC()

Creates an AL context.

destroyALC

void destroyALC()

Destroys an AL context.

isCreated

boolean isCreated()

Checks of creating an AL context.

Returns:

true if an AL context is created.

alcGetString

java.lang.String alcGetString(int parameter)

Obtains string value(s) from ALC.

Parameters:

parameter - the information to query. One of: DEFAULT_DEVICE_SPECIFIER DEVICE_SPECIFIER EXTENSIONS CAPTURE_DEFAULT_DEVICE_SPECIFIER CAPTURE_DEVICE_SPECIFIER

Returns:

the parameter value

alcIsExtensionPresent

boolean alcIsExtensionPresent(java.lang.String extension)

Verifies that a given extension is available for the current context and the device it is associated with.

Invalid and unsupported string tokens return ALC_FALSE. A NULL deviceHandle is acceptable. extName is not case sensitive – the implementation will convert the name to all upper-case internally (and will express extension names in upper-case).

Parameters:

extension - the extension name.

Returns:

true if the extension is available, otherwise false

alcGetInteger

void alcGetInteger(int param,
                   java.nio.IntBuffer buffer,
                   int size)

Obtains integer value(s) from ALC.

Parameters:

param - the information to query. One of: MAJOR_VERSION MINOR_VERSION ATTRIBUTES_SIZE ALL_ATTRIBUTES CAPTURE_SAMPLES

buffer - the destination buffer.

size - the buffer size.

alcDevicePauseSOFT

void alcDevicePauseSOFT()

Pauses a playback device.

When paused, no contexts associated with the device will be processed or updated. Playing sources will not produce sound, have their offsets incremented, or process any more buffers, until the device is resumed. Pausing a device that is already paused is a legal no-op.

alcDeviceResumeSOFT

void alcDeviceResumeSOFT()

Resumes playback of a paused device.

This will restart processing on the device -- sources will resume playing sound as normal. Resuming playback on a device that is not paused is a legal no-op.

These functions are not reference counted. alcDeviceResumeSOFT only needs to be called once to resume playback, regardless of how many times DevicePauseSOFT was called.