org.jsfml.audio

Class Listener

java.lang.Object

org.jsfml.audio.Listener

public final class Listener
extends Object

Represents the point in the scene from where all the sounds are heard and provides funcionality to modify it.

Modifying the position and orientation ("view direction") of the listener changes the way sounds are heard to accomplish 3D sound. Sounds will be panned and attenuated according to their position relative to the listener and the listener's orientation..

Method Summary

Methods

Modifier and Type	Method and Description
static Vector3f	getDirection() Gets the listener's current orientation or "view direction" in the scene.
static float	getGlobalVolume() Gets the global sound volume.
static Vector3f	getPosition() Gets the listener's current position in the scene.
static void	setDirection(float x, float y, float z) Sets the orientation or "view direction" of the listener in the scene.
static void	setDirection(Vector3f v) Sets the orientation or "view direction" of the listener in the scene.
static void	setGlobalVolume(float volume) Sets the global sound volume.
static void	setPosition(float x, float y, float z) Sets the position of the listener in the scene.
static void	setPosition(Vector3f v) Sets the position of the listener in the scene.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setGlobalVolume

public static void setGlobalVolume(float volume)

Sets the global sound volume.

The default global volume is 100 (maximum).

Parameters:

volume - the global sound volume, ranging between 0 (silence) and 100 (full volume).

getGlobalVolume

public static float getGlobalVolume()

Gets the global sound volume.

Returns:

the global sound volume, ranging between 0 (silence) and 100 (full volume).

setPosition

public static void setPosition(float x,
               float y,
               float z)

Sets the position of the listener in the scene.

Initially, the listener is located at the origin (0, 0, 0).

Parameters:

x - the X coordinate of the listener's new position.

y - the Y coordinate of the listener's new position.

z - the Z coordinate of the listener's new position.

See Also:

SoundSource.setPosition(org.jsfml.system.Vector3f)

setPosition

public static void setPosition(Vector3f v)

Sets the position of the listener in the scene.

Initially, the listener is located at the origin (0, 0, 0).

Parameters:

v - the listener's new position.

See Also:

SoundSource.setPosition(org.jsfml.system.Vector3f)

getPosition

public static Vector3f getPosition()

Gets the listener's current position in the scene.

Returns:

the listener's current position in the scene.

setDirection

public static void setDirection(float x,
                float y,
                float z)

Sets the orientation or "view direction" of the listener in the scene.

The vector passed does not need to be normalized. Initially, the listener's orientation is along the Z axis, looking "into" the screen (0, 0, -1).

Parameters:

x - the X component of the listener's new orientation.

y - the Y component of the listener's new orientation.

z - the Z component of the listener's new orientation.

See Also:

SoundSource.setPosition(org.jsfml.system.Vector3f)

setDirection

public static void setDirection(Vector3f v)

Sets the orientation or "view direction" of the listener in the scene.

The vector passed does not need to be normalized. Initially, the listener's orientation is along the Z axis, looking "into" the screen (0, 0, -1).

Parameters:

v - the listener's new orientation.

See Also:

SoundSource.setPosition(org.jsfml.system.Vector3f)

getDirection

public static Vector3f getDirection()

Gets the listener's current orientation or "view direction" in the scene.

Returns:

the listener's current orientation in the scene.