Top Description Fields Constructors Methods
org.lwjgl.openal

public final Class AL10

extends Object
Class Inheritance
Imports
org.lwjgl.*, java.nio.*

This is the core OpenAL class. This class implements AL.h version 1.0

Author
Brian Matzon
Version
$Revision$ $Id$

Field Summary

Modifier and TypeField and Description
public static final int
AL_BITS

Sound buffers: The number of bits per sample for the data contained in the buffer.

public static final int
AL_BUFFER

Indicate the buffer to provide sound samples.

public static final int
AL_BUFFERS_PROCESSED

Buffer Queue params

public static final int
AL_BUFFERS_QUEUED

Buffer Queue params

public static final int
AL_CHANNEL_MASK

Specify the channel mask.

public static final int
AL_CHANNELS

Sound buffers: The number of channels for the data contained in the buffer.

public static final int
AL_CONE_INNER_ANGLE

Directional source, inner cone angle, in degrees Range: [0-360] Default: 360

public static final int
AL_CONE_OUTER_ANGLE

Directional source, outer cone angle, in degrees.

public static final int
AL_CONE_OUTER_GAIN

Indicate the gain (volume amplification) applied.

public static final int
AL_DATA

Deprecated This token is a relict of the early OpenAL days and is no longer supported. Neither the OpenAL spec nor OpenAL Soft define it.
public static final int
AL_DIRECTION

Specify the current direction as forward vector.

public static final int
AL_DISTANCE_MODEL

Distance model.

public static final int
AL_DOPPLER_FACTOR

Doppler scale.

public static final int
AL_DOPPLER_VELOCITY

Doppler velocity.

public static final int
AL_EXTENSIONS

Context strings: Extensions

public static final int
AL_FALSE

Boolean False

public static final int
AL_FORMAT_MONO16

Sound buffers: format specifier.

public static final int
AL_FORMAT_MONO8

Sound buffers: format specifier.

public static final int
AL_FORMAT_STEREO16

Sound buffers: format specifier.

public static final int
AL_FORMAT_STEREO8

Sound buffers: format specifier.

public static final int
AL_FORMAT_VORBIS_EXT

Ogg Vorbis format specifier.

public static final int
AL_FREQUENCY

Sound buffers: frequency, in units of Hertz [Hz].

public static final int
AL_GAIN

Indicate the gain (volume amplification) applied.

public static final int
AL_INITIAL

Source state information

public static final int
AL_INVALID

Bad value

public static final int
AL_INVALID_ENUM

Illegal enum passed as an argument to an AL call.

public static final int
AL_INVALID_NAME

Illegal name passed as an argument to an AL call.

public static final int
AL_INVALID_OPERATION

A function was called at inappropriate time, or in an inappropriate way, causing an illegal state.

public static final int
AL_INVALID_VALUE

Illegal value passed as an argument to an AL call.

public static final int
AL_INVERSE_DISTANCE

Distance model

public static final int
AL_INVERSE_DISTANCE_CLAMPED

Distance model

public static final int
AL_LOOPING

Indicate whether source has to loop infinite.

public static final int
AL_MAX_DISTANCE

Specify the maximum distance.

public static final int
AL_MAX_GAIN

Indicate maximum source attenuation.

public static final int
AL_MIN_GAIN

Indicate minimum source attenuation.

public static final int
AL_NO_ERROR

Errors: No Error.

public static final int
AL_NONE

Disable value

public static final int
AL_ORIENTATION

Specify the current orientation.

public static final int
AL_OUT_OF_MEMORY

A function could not be completed, because there is not enough memory available.

public static final int
AL_PAUSED

Source state information

public static final int
AL_PENDING

Buffer state.

public static final int
AL_PITCH

Specify the pitch to be applied, either at source, or on mixer results, at listener.

public static final int
AL_PLAYING

Source state information

public static final int
AL_POSITION

Specify the current location in three dimensional space.

public static final int
AL_PROCESSED

Buffer state.

public static final int
AL_REFERENCE_DISTANCE

Specify the current orientation.

public static final int
AL_RENDERER

Context strings: Renderer

public static final int
AL_ROLLOFF_FACTOR

Indicate the rolloff factor for the source.

public static final int
AL_SIZE

Sound buffers: Size in bytes of the buffer data.

public static final int
AL_SOURCE_ABSOLUTE

Indicate source has absolute coordinates

public static final int
AL_SOURCE_RELATIVE

Indicate Source has listener relative coordinates

public static final int
AL_SOURCE_STATE

Source state information

public static final int
AL_SOURCE_TYPE

Indicate the type of SOURCE.

public static final int
AL_STOPPED

Source state information

public static final int
AL_TRUE

Boolean True

public static final int
AL_UNUSED

Buffer state.

public static final int
AL_VELOCITY

Specify the current velocity in three dimensional space.

public static final int
AL_VENDOR

Context strings: Vendor

public static final int
AL_VERSION

Context strings: Version

Constructor Summary

AccessConstructor and Description
private
AL10()

Method Summary

Modifier and TypeMethod and Description
public static void
alBufferData(int
Buffer to fill
buffer, int
format sound data is in
format, ByteBuffer
location of data
data, int
frequency of data
freq)

A special case of Buffer state is the actual sound sample data stored in asociation with the Buffer.

public static void
alBufferData(int
Buffer to fill
buffer, int
format sound data is in
format, IntBuffer
location of data
data, int
frequency of data
freq)

A special case of Buffer state is the actual sound sample data stored in asociation with the Buffer.

public static void
alBufferData(int
Buffer to fill
buffer, int
format sound data is in
format, ShortBuffer
location of data
data, int
frequency of data
freq)

A special case of Buffer state is the actual sound sample data stored in asociation with the Buffer.

public static void
alDeleteBuffers(IntBuffer
Buffer to delete from
buffers)

The application requests deletion of a number of Buffers by calling DeleteBuffers.

public static void
alDeleteBuffers(int buffer)

Overloads alDeleteBuffers.

public static void
alDeleteSources(IntBuffer
Source array to delete from
sources)

The application requests deletion of a number of Sources by DeleteSources.

public static void
alDeleteSources(int source)

Overloads alDeleteSources.

public static void
alDisable(int
name of a capability to disable
capability)

The application can temporarily disable certain AL capabilities on a per Context basis.

public static void
alDistanceModel(int
distance model to be set
value)

Samples usually use the entire dynamic range of the chosen format/encoding, independent of their real world intensity.

public static void
alDopplerFactor(float
Doppler scale value to set
value)

The Doppler Effect depends on the velocities of Source and Listener relative to the medium, and the propagation speed of sound in that medium.

public static void
alDopplerVelocity(float
Doppler velocity value to set
value)

The Doppler Effect depends on the velocities of Source and Listener relative to the medium, and the propagation speed of sound in that medium.

public static void
alEnable(int
name of a capability to enable
capability)

The application can temporarily disable certain AL capabilities on a per Context basis.

public static void
alGenBuffers(IntBuffer
holding buffers
buffers)

The application requests a number of Buffers using GenBuffers.

public static int
alGenBuffers()

Overloads alGenBuffers.

public static void
alGenSources(IntBuffer
array holding sources
sources)

The application requests a number of Sources using GenSources.

public static int
alGenSources()

Overloads alGenSources.

public static boolean

Returns:

boolean state described by pname will be returned.
alGetBoolean(int pname)

Like OpenGL, AL uses a simplified interface for querying global state.

public static float

Returns:

float
alGetBufferf(int
buffer to get property from
buffer, int
name of property to retrieve
pname)

Buffer state is maintained inside the AL implementation and can be queried in full.

public static int
alGetBufferi(int
buffer to get property from
buffer, int
name of property to retrieve
pname)

Buffer state is maintained inside the AL implementation and can be queried in full.

public static double

Returns:

double state described by pname will be returned.
alGetDouble(int pname)

Like OpenGL, AL uses a simplified interface for querying global state.

public static void
alGetDouble(int
state to be queried
pname, DoubleBuffer
Buffer to place the doubles in
data)

Like OpenGL, AL uses a simplified interface for querying global state.

public static int

Returns:

Actual int for the described enumeration name
alGetEnumValue(String
String describing an OpenAL enum
ename)

To obtain enumeration values for extensions, the application has to use GetEnumValue of an extension token.

public static int

Returns:

current error state
alGetError()

The AL detects only a subset of those conditions that could be considered errors.

public static float

Returns:

float state described by pname will be returned.
alGetFloat(int pname)

Like OpenGL, AL uses a simplified interface for querying global state.

public static void
alGetFloat(int
state to be queried
pname, FloatBuffer
Buffer to place the floats in
data)

Like OpenGL, AL uses a simplified interface for querying global state.

public static int

Returns:

int state described by pname will be returned.
alGetInteger(int pname)

Like OpenGL, AL uses a simplified interface for querying global state.

public static void
alGetInteger(int
state to be queried
pname, IntBuffer
Buffer to place the integers in
data)

Like OpenGL, AL uses a simplified interface for querying global state.

public static void
alGetListener(int
name of the attribute to be retrieved
pname, FloatBuffer
Buffer to write floats to
floatdata)

Listener state is maintained inside the AL implementation and can be queried in full.

public static float

Returns:

float
alGetListenerf(int
name of the attribute to be retrieved
pname)

Listener state is maintained inside the AL implementation and can be queried in full.

public static int

Returns:

int
alGetListeneri(int
name of the attribute to be retrieved
pname)

Listener state is maintained inside the AL implementation and can be queried in full.

public static void
alGetSource(int
Source to get property from
source, int
property to get
pname, FloatBuffer
Buffer to write floats to
floatdata)

Source state is maintained inside the AL implementation, and the current attributes can be queried.

public static float

Returns:

float
alGetSourcef(int
source to get property from
source, int
name of property
pname)

Source state is maintained inside the AL implementation, and the current attributes can be queried.

public static int

Returns:

int
alGetSourcei(int
source to get property from
source, int
name of property
pname)

Source state is maintained inside the AL implementation, and the current attributes can be queried.

public static String

Returns:

OpenAL String property
alGetString(int
The property to be returned
pname)

The application can retrieve state information global to the current AL Context.

public static boolean

Returns:

true if supplied buffer is valid, false if not
alIsBuffer(int
buffer to be tested for validity
buffer)

The application can verify whether a buffer Name is valid using the IsBuffer query.

public static boolean

Returns:

true if named feature is enabled
alIsEnabled(int
name of a capability to check
capability)

The application can also query whether a given capability is currently enabled or not.

public static boolean

Returns:

true if extension is available, false if not
alIsExtensionPresent(String
String describing the desired extension
fname)

To verify that a given extension is available for the current context and the device it is associated with, use this method.

public static boolean

Returns:

true if id is valid, false if not
alIsSource(int
id of source to be testes for validity
id)

The application can verify whether a source name is valid using the IsSource query.

public static void
alListener(int
name of the attribute to be set
pname, FloatBuffer
FloatBuffer containing value to set the attribute to
value)

Listener attributes are changed using the Listener group of commands.

public static void
alListener3f(int
name of the attribute to be set
pname, float
value value 1
v1, float
value value 2
v2, float
float value 3
v3)

Listener attributes are changed using the Listener group of commands.

public static void
alListenerf(int
name of the attribute to be set
pname, float
floating point value to set the attribute to
value)

Listener attributes are changed using the Listener group of commands.

public static void
alListeneri(int
name of the attribute to be set
pname, int
value to set the attribute to
value)

Listener attributes are changed using the Listener group of commands.

public static void
alSource(int
Source to set property on
source, int
property to set
pname, FloatBuffer
FloatBuffer containing value of property
value)

Specifies the position and other properties as taken into account during sound processing.

public static void
alSource3f(int
Source to set property on
source, int
property to set
pname, float
value 1 of property
v1, float
value 2 of property
v2, float
value 3 of property
v3)

Specifies the position and other properties as taken into account during sound processing.

public static void
alSourcef(int
Source to det property on
source, int
property to set
pname, float
value of property
value)

Specifies the position and other properties as taken into account during sound processing.

public static void
alSourcei(int
Source to det property on
source, int
property to set
pname, int
value of property
value)

Specifies the position and other properties as taken into account during sound processing.

public static void
alSourcePause(IntBuffer
array of sources to pause
sources)

Pause() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourcePause(int
Source to pause
source)

Pause() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourcePlay(IntBuffer
array of sources to play
sources)

Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus the data found in the Buffer will be fed into the processing, starting at the beginning.

public static void
alSourcePlay(int
Source to play
source)

Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus the data found in the Buffer will be fed into the processing, starting at the beginning.

public static void
alSourceQueueBuffers(int
source to queue buffers onto
source, IntBuffer
buffers to be queued
buffers)

The application can queue up one or multiple buffer names using SourceQueueBuffers.

public static void
alSourceQueueBuffers(int source, int buffer)

Overloads alSourceQueueBuffers.

public static void
alSourceRewind(IntBuffer
array of sources to rewind
sources)

Rewind() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourceRewind(int
Source to rewind
source)

Rewind() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourceStop(IntBuffer
array of sources to stop
sources)

Stop() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourceStop(int
Source to stop
source)

Stop() applied to an AL_INITIAL Source is a legal NOP.

public static void
alSourceUnqueueBuffers(int
source to unqueue buffers from
source, IntBuffer
IntBuffer containing list of names that were unqueued
buffers)

Once a queue entry for a buffer has been appended to a queue and is pending processing, it should not be changed.

public static int
alSourceUnqueueBuffers(int source)

Overloads alSourceUnqueueBuffers.

pack-priv static native void
initNativeStubs()

pack-priv static native void
nalBufferData(int buffer, int format, long data, int data_size, int freq)

pack-priv static native void
nalDeleteBuffers(int buffers_n, long buffers)

pack-priv static native void
nalDeleteBuffers2(int n, int buffer)

pack-priv static native void
nalDeleteSources(int sources_n, long sources)

pack-priv static native void
nalDeleteSources2(int n, int source)

pack-priv static native void
nalDisable(int capability)

pack-priv static native void
nalDistanceModel(int value)

pack-priv static native void
nalDopplerFactor(float value)

pack-priv static native void
nalDopplerVelocity(float value)

pack-priv static native void
nalEnable(int capability)

pack-priv static native void
nalGenBuffers(int buffers_n, long buffers)

pack-priv static native int
nalGenBuffers2(int n)

pack-priv static native void
nalGenSources(int sources_n, long sources)

pack-priv static native int
nalGenSources2(int n)

pack-priv static native boolean
nalGetBoolean(int pname)

pack-priv static native float
nalGetBufferf(int buffer, int pname)

pack-priv static native int
nalGetBufferi(int buffer, int pname)

pack-priv static native double
nalGetDouble(int pname)

pack-priv static native void
nalGetDoublev(int pname, long data)

pack-priv static native int
nalGetEnumValue(String ename)

pack-priv static native int
nalGetError()

pack-priv static native float
nalGetFloat(int pname)

pack-priv static native void
nalGetFloatv(int pname, long data)

pack-priv static native int
nalGetInteger(int pname)

pack-priv static native void
nalGetIntegerv(int pname, long data)

pack-priv static native float
nalGetListenerf(int pname)

pack-priv static native void
nalGetListenerfv(int pname, long floatdata)

pack-priv static native int
nalGetListeneri(int pname)

pack-priv static native float
nalGetSourcef(int source, int pname)

pack-priv static native void
nalGetSourcefv(int source, int pname, long floatdata)

pack-priv static native int
nalGetSourcei(int source, int pname)

pack-priv static native String
nalGetString(int pname)

pack-priv static native boolean
nalIsBuffer(int buffer)

pack-priv static native boolean
nalIsEnabled(int capability)

pack-priv static native boolean
nalIsExtensionPresent(String fname)

pack-priv static native boolean
nalIsSource(int id)

pack-priv static native void
nalListener3f(int pname, float v1, float v2, float v3)

pack-priv static native void
nalListenerf(int pname, float value)

pack-priv static native void
nalListenerfv(int pname, long value)

pack-priv static native void
nalListeneri(int pname, int value)

pack-priv static native void
nalSource3f(int source, int pname, float v1, float v2, float v3)

pack-priv static native void
nalSourcef(int source, int pname, float value)

pack-priv static native void
nalSourcefv(int source, int pname, long value)

pack-priv static native void
nalSourcei(int source, int pname, int value)

pack-priv static native void
nalSourcePause(int source)

pack-priv static native void
nalSourcePausev(int sources_n, long sources)

pack-priv static native void
nalSourcePlay(int source)

pack-priv static native void
nalSourcePlayv(int sources_n, long sources)

pack-priv static native void
nalSourceQueueBuffers(int source, int buffers_n, long buffers)

pack-priv static native void
nalSourceQueueBuffers2(int source, int n, int buffer)

pack-priv static native void
nalSourceRewind(int source)

pack-priv static native void
nalSourceRewindv(int sources_n, long sources)

pack-priv static native void
nalSourceStop(int source)

pack-priv static native void
nalSourceStopv(int sources_n, long sources)

pack-priv static native void
nalSourceUnqueueBuffers(int source, int buffers_n, long buffers)

pack-priv static native int
nalSourceUnqueueBuffers2(int source, int n)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait