be.yildiz.module.sound

Class SoundEngine

java.lang.Object

be.yildiz.module.sound.SoundEngine

All Implemented Interfaces:

SoundBuilder, AutoCloseable

Direct Known Subclasses:

DummyAudioEngine

public abstract class SoundEngine
extends Object
implements AutoCloseable, SoundBuilder

SoundEngine behavior.

Author:

Grégory Van den Borre

Field Summary

Fields

Modifier and Type	Field and Description
protected be.yildiz.common.gameobject.Movable	listener User listening to the audio, used for audio 3D positioning.

Constructor Summary

Constructors

Constructor and Description
SoundEngine()

Method Summary

Modifier and Type	Method and Description
abstract void	addResourcePath(String path) Add a path to load resources.
void	close()
protected abstract void	closeImpl()
abstract Playlist	createPlaylist(String name) Build a play list of music to be played.
void	setListener(be.yildiz.common.gameobject.Movable user) Set a user to be considered as the audio listener.
void	testAudio() Test the audio positioning by playing sound with different positions.
abstract void	update() Update the current audio state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface be.yildiz.module.sound.SoundBuilder

createSound

Field Detail

listener

protected be.yildiz.common.gameobject.Movable listener

User listening to the audio, used for audio 3D positioning.

Constructor Detail

SoundEngine

public SoundEngine()

Method Detail

setListener

public final void setListener(be.yildiz.common.gameobject.Movable user)

Set a user to be considered as the audio listener.

Parameters:

user - User listener.

update

public abstract void update()

Update the current audio state.

testAudio

public final void testAudio()

Test the audio positioning by playing sound with different positions.

createPlaylist

public abstract Playlist createPlaylist(String name)

Build a play list of music to be played.

Parameters:

name - Play list name.

Returns:

The built play list.

addResourcePath

public abstract void addResourcePath(String path)

Add a path to load resources.

Parameters:

path - Path to use.

close

public final void close()

Specified by:

close in interface AutoCloseable

closeImpl

protected abstract void closeImpl()