|
JOAL v2.6.0-rc-20250706
JOAL, OpenAL® API Binding for Java (public API).
|
This class represents the human listener in the Sound3D environment. More...
Public Member Functions | |
| Listener () | |
| void | setGain (final float gain) |
| Sets the Gain, or volume of the audio in the environment relative to the listener. More... | |
| float | getGain () |
| Gets the value of the gain, or volume of the audio in the environment relative to the listener. More... | |
| void | setPosition (final float x, final float y, final float z) |
| Sets the position in (x-y-z coordinates) of the Listener in the Sound3D environment. More... | |
| void | setPosition (final Vec3f position) |
| Sets the position in (x-y-z coordinates) of the Listener in the Sound3D environment. More... | |
| Vec3f | getPosition () |
| Gets the position in (x-y-z coordinates) of the Listener in the Sound3D environment. More... | |
| void | setVelocity (final Vec3f velocity) |
| Sets the velocity in (x-y-z coordinates) of the Listener in the Sound3D environment. More... | |
| Vec3f | getVelocity () |
| Gets the velocity in (x-y-z coordinates) of the Listener in the Sound3D environment. More... | |
| void | setOrientation (final float[] orientation) |
| Sets the orientation of the Listener in the Sound3D environment. More... | |
| float[] | getOrientation () |
| Gets the orientation of the Listener in the Sound3D environment. More... | |
This class represents the human listener in the Sound3D environment.
It provides methods for controlling the position, orientation as well as other properties associated with the listener.
Definition at line 46 of file Listener.java.
| com.jogamp.openal.sound3d.Listener.Listener | ( | ) |
Definition at line 47 of file Listener.java.
| float com.jogamp.openal.sound3d.Listener.getGain | ( | ) |
Gets the value of the gain, or volume of the audio in the environment relative to the listener.
Definition at line 66 of file Listener.java.
| float[] com.jogamp.openal.sound3d.Listener.getOrientation | ( | ) |
Gets the orientation of the Listener in the Sound3D environment.
Orientation is expressed as at and up vectors.
at vector, the second 3 elements contain the up vector. Definition at line 160 of file Listener.java.
| Vec3f com.jogamp.openal.sound3d.Listener.getPosition | ( | ) |
Gets the position in (x-y-z coordinates) of the Listener in the Sound3D environment.
Definition at line 106 of file Listener.java.
| Vec3f com.jogamp.openal.sound3d.Listener.getVelocity | ( | ) |
Gets the velocity in (x-y-z coordinates) of the Listener in the Sound3D environment.
Used in determining doppler shift.
Definition at line 133 of file Listener.java.
| void com.jogamp.openal.sound3d.Listener.setGain | ( | final float | gain | ) |
Sets the Gain, or volume of the audio in the environment relative to the listener.
| gain | the gain, or volume |
Definition at line 56 of file Listener.java.
| void com.jogamp.openal.sound3d.Listener.setOrientation | ( | final float[] | orientation | ) |
Sets the orientation of the Listener in the Sound3D environment.
Orientation is expressed as at and up vectors.
| orientation | The first 3 elements of the array should contain the at vector, the second 3 elements should contain the up vector. |
Definition at line 149 of file Listener.java.
| void com.jogamp.openal.sound3d.Listener.setPosition | ( | final float | x, |
| final float | y, | ||
| final float | z | ||
| ) |
Sets the position in (x-y-z coordinates) of the Listener in the Sound3D environment.
| x | The position of the listener along the X-axis in the Sound3D environment |
| y | The position of the listener along the Y-axis in the Sound3D environment |
| z | The position of the listener along the Z-axis in the Sound3D environment |
Definition at line 84 of file Listener.java.
| void com.jogamp.openal.sound3d.Listener.setPosition | ( | final Vec3f | position | ) |
Sets the position in (x-y-z coordinates) of the Listener in the Sound3D environment.
Definition at line 95 of file Listener.java.
| void com.jogamp.openal.sound3d.Listener.setVelocity | ( | final Vec3f | velocity | ) |
Sets the velocity in (x-y-z coordinates) of the Listener in the Sound3D environment.
Used in determining doppler shift.
Definition at line 122 of file Listener.java.