de.gurkenlabs.litiengine.sound

Class SoundEngine

java.lang.Object

de.gurkenlabs.litiengine.sound.SoundEngine

All Implemented Interfaces:

ILaunchable, IUpdateable, ISoundEngine

public final class SoundEngine
extends java.lang.Object
implements ISoundEngine, IUpdateable, ILaunchable

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_DISTANCE

Constructor Summary

Constructors

Constructor and Description
SoundEngine()

Method Summary

Modifier and Type	Method and Description
float	getMaxDistance() Gets the maximum distance from the listener at which a sound source can still be heard.
ISoundPlayback	playMusic(Sound sound) Loops the specified sound file as background music.
ISoundPlayback	playMusic(Sound sound, boolean loop) Plays the specified sound file as background music.
ISoundPlayback	playSound(IEntity entity, Sound sound) Plays the specified sound and updates its volume and pan by the current entity location in relation to the listener location.
ISoundPlayback	playSound(IEntity entity, Sound sound, boolean loop) Plays the specified sound and updates its volume and pan by the current entity location in relation to the listener location.
ISoundPlayback	playSound(java.awt.geom.Point2D location, Sound sound) Plays the specified sound at the specified location and updates the volume and pan in relation to the listener location.
ISoundPlayback	playSound(java.awt.geom.Point2D location, Sound sound, boolean loop) Plays the specified sound at the specified location and updates the volume and pan in relation to the listener location.
ISoundPlayback	playSound(Sound sound) Plays the specified sound with the volume configured in the SOUND config with a center pan.
ISoundPlayback	playSound(Sound sound, boolean loop) Plays the specified sound with the volume configured in the SOUND config with a center pan.
void	setListenerLocationCallback(java.util.function.Function<java.awt.geom.Point2D,java.awt.geom.Point2D> listenerLocationCallback) This method allows to set the callback that is used by the SoundEngine to determine where the listener location is.
void	setMaxDistance(float radius) Sets the maximum distance from the listener at which a sound source can still be heard.
void	start()
void	stopMusic() Stops the playback of the current background music.
void	terminate()
void	update() This method is called by the game loop on all objects that need to update their attributes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_DISTANCE

public static final int DEFAULT_MAX_DISTANCE

See Also:

Constant Field Values

Constructor Detail

SoundEngine

public SoundEngine()

Method Detail

getMaxDistance

public float getMaxDistance()

Description copied from interface: ISoundEngine

Gets the maximum distance from the listener at which a sound source can still be heard.

Specified by:

getMaxDistance in interface ISoundEngine

Returns:

The maximum distance at which a sound can be heard.

playMusic

public ISoundPlayback playMusic(Sound sound)

Description copied from interface: ISoundEngine

Loops the specified sound file as background music. If another music was specified beforehand, its play-back will get interrupted and the new one will be played.

Specified by:

playMusic in interface ISoundEngine

Parameters:

sound - The sound from which to play the background music.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playMusic

public ISoundPlayback playMusic(Sound sound,
                                boolean loop)

Description copied from interface: ISoundEngine

Plays the specified sound file as background music. If another music was specified beforehand, its play-back will get interrupted and the new one will be played.

Specified by:

playMusic in interface ISoundEngine

Parameters:

sound - The sound from which to play the background music.

loop - Determines whether this playback should be looped or not.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(IEntity entity,
                                Sound sound)

Description copied from interface: ISoundEngine

Plays the specified sound and updates its volume and pan by the current entity location in relation to the listener location.

Specified by:

playSound in interface ISoundEngine

Parameters:

entity - The entity at which location the sound should be played.

sound - The sound to play.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(IEntity entity,
                                Sound sound,
                                boolean loop)

Description copied from interface: ISoundEngine

Plays the specified sound and updates its volume and pan by the current entity location in relation to the listener location.

Specified by:

playSound in interface ISoundEngine

Parameters:

entity - The entity at which location the sound should be played.

sound - The sound to play.

loop - Determines whether this playback should be looped or not.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(java.awt.geom.Point2D location,
                                Sound sound)

Description copied from interface: ISoundEngine

Plays the specified sound at the specified location and updates the volume and pan in relation to the listener location.

Specified by:

playSound in interface ISoundEngine

Parameters:

location - The location at which to play the sound.

sound - The sound to play.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(java.awt.geom.Point2D location,
                                Sound sound,
                                boolean loop)

Description copied from interface: ISoundEngine

Plays the specified sound at the specified location and updates the volume and pan in relation to the listener location.

Specified by:

playSound in interface ISoundEngine

Parameters:

location - The location at which to play the sound.

sound - The sound to play.

loop - Determines whether this playback should be looped or not.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(Sound sound)

Description copied from interface: ISoundEngine

Plays the specified sound with the volume configured in the SOUND config with a center pan.

Specified by:

playSound in interface ISoundEngine

Parameters:

sound - The sound to play.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

playSound

public ISoundPlayback playSound(Sound sound,
                                boolean loop)

Description copied from interface: ISoundEngine

Plays the specified sound with the volume configured in the SOUND config with a center pan.

Specified by:

playSound in interface ISoundEngine

Parameters:

sound - The sound to play.

loop - Determines whether this playback should be looped or not.

Returns:

A ISoundPlayback instance that allows to further process and control the played sound.

setMaxDistance

public void setMaxDistance(float radius)

Description copied from interface: ISoundEngine

Sets the maximum distance from the listener at which a sound source can still be heard. If the distance between the sound source and the listener is greater than the specified value, the volume is set to 0.

Specified by:

setMaxDistance in interface ISoundEngine

Parameters:

radius - The maximum distance at which sounds can still be heard.

start

public void start()

Specified by:

start in interface ILaunchable

stopMusic

public void stopMusic()

Description copied from interface: ISoundEngine

Stops the playback of the current background music.

Specified by:

stopMusic in interface ISoundEngine

terminate

public void terminate()

Specified by:

terminate in interface ILaunchable

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that need to update their attributes. It is called on every tick, means, it is called Game.GameLoop.TICKS_PER_SECOND times per second.

Specified by:

update in interface IUpdateable

setListenerLocationCallback

public void setListenerLocationCallback(java.util.function.Function<java.awt.geom.Point2D,java.awt.geom.Point2D> listenerLocationCallback)

Description copied from interface: ISoundEngine

This method allows to set the callback that is used by the SoundEngine to determine where the listener location is. If not explicitly set, the SoundEngine uses the camera focus (center of the screen) as listener location.

Specified by:

setListenerLocationCallback in interface ISoundEngine

Parameters:

listenerLocationCallback - The callback that determines the location of the sound listener.