JOAL v2.6.0-rc-20250712
JOAL, OpenAL® API Binding for Java™ (public API).
com.jogamp.openal.sound3d.Device Class Reference

This class provides a handle to a specific audio device. More...

Collaboration diagram for com.jogamp.openal.sound3d.Device:

Public Member Functions

 Device (final String deviceName)
 Create a new device by open()'ing the named audio device. More...
 
String getName ()
 Returns the device name. More...
 
ALCdevice getALDevice ()
 Returns the OpenAL ALCdevice. More...
 
int getALCError ()
 Return ALC#alcGetError(ALCdevice). More...
 
boolean isValid ()
 Returns whether getALDevice() is open and valid, i.e. More...
 
boolean isDebugAvail ()
 Returns whether ALC_EXT_debug is available for this device. More...
 
boolean open ()
 Opens the device if not yet opened. More...
 
void close ()
 closes the device, freeing its resources. More...
 
String toString ()
 

Detailed Description

This class provides a handle to a specific audio device.

Author
Athomas Goldberg, Sven Gothel, et al.

Definition at line 46 of file Device.java.

Constructor & Destructor Documentation

◆ Device()

com.jogamp.openal.sound3d.Device.Device ( final String  deviceName)

Create a new device by open()'ing the named audio device.

Parameters
deviceNameThe specified device name, null for default.

Definition at line 55 of file Device.java.

Here is the call graph for this function:

Member Function Documentation

◆ close()

void com.jogamp.openal.sound3d.Device.close ( )

closes the device, freeing its resources.

Definition at line 105 of file Device.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getALCError()

int com.jogamp.openal.sound3d.Device.getALCError ( )

Return ALC#alcGetError(ALCdevice).

Definition at line 68 of file Device.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getALDevice()

ALCdevice com.jogamp.openal.sound3d.Device.getALDevice ( )

Returns the OpenAL ALCdevice.

Definition at line 65 of file Device.java.

Here is the caller graph for this function:

◆ getName()

String com.jogamp.openal.sound3d.Device.getName ( )

Returns the device name.

Definition at line 62 of file Device.java.

Here is the caller graph for this function:

◆ isDebugAvail()

boolean com.jogamp.openal.sound3d.Device.isDebugAvail ( )

Returns whether ALC_EXT_debug is available for this device.

This context may or may not be current.

See also
Context::isDebugAvail()

Definition at line 82 of file Device.java.

Here is the call graph for this function:

◆ isValid()

boolean com.jogamp.openal.sound3d.Device.isValid ( )

Returns whether getALDevice() is open and valid, i.e.

not null, e.g. not close().

Definition at line 73 of file Device.java.

Here is the caller graph for this function:

◆ open()

boolean com.jogamp.openal.sound3d.Device.open ( )

Opens the device if not yet opened.

Returns
true if already open or newly opened
See also
isValid()
#clone()

Definition at line 92 of file Device.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString()

String com.jogamp.openal.sound3d.Device.toString ( )

Definition at line 113 of file Device.java.


The documentation for this class was generated from the following file: