Top Description Fields Constructors Methods
com.jogamp.openal

public Class ALFactory

extends Object
Class Inheritance
Imports
jogamp.openal.ALCImpl, .ALExtImpl, .ALImpl, .Debug, com.jogamp.common.os.Platform, com.jogamp.common.util.PropertyAccess

This class provides factory methods for generating AL and ALC objects.

Select preferred OpenAL native library type via system properties, i.e. System-OpenAL or bundled Soft-OpenAL.
If the preferred choice fails, implementation falls back to the other.

   -Djoal.openal.lib=auto     Prefer System-OpenAL over bundled Soft-OpenAL for OSX. Prefer bundled Soft-OpenAL over System-OpenAL for all others. This is the default.
   -Djoal.openal.lib=system   Prefer System-OpenAL over bundled Soft-OpenAL for all.
   -Djoal.openal.lib=soft     Prefer bundled Soft-OpenAL over System-OpenAL for all.
  
Note: You may use the 'jnlp.' prefix, allowing using above property names w/ Applets and WebStart, e.g. 'jnlp.joal.openal.lib=system'.

Author
Athomas Goldberg, Kenneth Russell, et.al.

Field Summary

Modifier and TypeField and Description
private static AL
private static ALC
private static ALExt
public static final boolean
private static boolean
public static final boolean
PREFER_SYSTEM_OPENAL

If true, prefer System-OpenAL, otherwise bundled Soft-OpenAL (default).

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static AL

Returns:

the AL object
getAL
()

Get the default AL object.

public static ALC

Returns:

the ALC object
getALC
()

Get the default ALC object.

public static ALExt

Returns:

the ALExt object
getALExt
()

Get the default ALExt object.

public static boolean
getPreferSystemOpenAL()

If the system property joal.SystemOpenAL is set

private static synchronized void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

alback to summary
private static AL al
alcback to summary
private static ALC alc
alextback to summary
private static ALExt alext
DEBUGback to summary
public static final boolean DEBUG
initializedback to summary
private static boolean initialized
PREFER_SYSTEM_OPENALback to summary
public static final boolean PREFER_SYSTEM_OPENAL

If true, prefer System-OpenAL, otherwise bundled Soft-OpenAL (default).

Constructor Detail

ALFactoryback to summary
private ALFactory()

Method Detail

getALback to summary
public static AL getAL() throws ALException

Get the default AL object. This object is used to access most of the OpenAL functionality.

Returns:AL

the AL object

getALCback to summary
public static ALC getALC() throws ALException

Get the default ALC object. This object is used to access most of the OpenAL context functionality.

Returns:ALC

the ALC object

getALExtback to summary
public static ALExt getALExt() throws ALException

Get the default ALExt object. This object is used to access most of the OpenAL extension functionality.

Returns:ALExt

the ALExt object

getPreferSystemOpenALback to summary
public static boolean getPreferSystemOpenAL() throws ALException

If the system property joal.SystemOpenAL is set

initializeback to summary
private static synchronized void initialize() throws ALException