de.gurkenlabs.litiengine.sound

Interface ISoundEngine

All Known Implementing Classes:

SoundEngine

public interface ISoundEngine

This interface provides all methods to playback sounds and music in your game. It allows to define the 2D coordinates of the sound or even pass in the source entity of the sound which will adjust the position accoring to the position of the entity. The LILI Engine Sound Engine supports .wav, .mp3 and .ogg by default. If you need other file extensions, you have to write an own SPI implementation and inject it in your project.

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 distance) Sets the maximum distance from the listener at which a sound source can still be heard.
void	stopMusic() Stops the playback of the current background music.

Method Detail

getMaxDistance

float getMaxDistance()

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

Returns:

The maximum distance at which a sound can be heard.

playMusic

ISoundPlayback playMusic(Sound sound)

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.

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

ISoundPlayback playMusic(Sound sound,
                         boolean loop)

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.

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

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.

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

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.

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

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.

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

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.

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

ISoundPlayback playSound(Sound sound)

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

Parameters:

sound - The sound to play.

Returns:

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

playSound

ISoundPlayback playSound(Sound sound,
                         boolean loop)

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

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

void setMaxDistance(float distance)

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.

Parameters:

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

stopMusic

void stopMusic()

Stops the playback of the current background music.

setListenerLocationCallback

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. If not explicitly set, the SoundEngine uses the camera focus (center of the screen) as listener location.

Parameters:

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