org.achtern.AchternEngine.core.audio.openal.trigger

Class KeyboardAudioTrigger

java.lang.Object

org.achtern.AchternEngine.core.audio.openal.trigger.KeyboardAudioTrigger

All Implemented Interfaces:

AudioTrigger, KeyListener

public class KeyboardAudioTrigger
extends Object
implements AudioTrigger, KeyListener

This will play, pause and stop AudioSources based on keyboard presses. This trigger will keep the AudioSource stopped until the play key has been pressed.
Default keys:
- PLAY: L
- PAUSE: K
- STOP: J

Field Summary

Fields

Modifier and Type	Field and Description
protected AudioSourceState	next
protected Key	pauseKey
protected Key	playKey
protected Key	stopKey

Constructor Summary

Constructors

Constructor and Description
KeyboardAudioTrigger(KeyMap keyMap) Construct a new KeyboardAudioTrigger with the default keys (J, K, L).
KeyboardAudioTrigger(KeyMap keyMap, Key playKey, Key pauseKey, Key stopKey) Construct a new KeyboardAudioTrigger with custom keys.

Method Summary

Modifier and Type	Method and Description
protected AudioSourceState	getNext()
protected Key	getPauseKey()
protected Key	getPlayKey()
protected Key	getStopKey()
AudioSourceState	next(AudioSource as) This tells the AudioEngine the desired state for any given AudioSource.
void	onAction(KeyEvent event) This method just sets the internal state, which is returned by next(AudioSource)
protected void	setNext(AudioSourceState next)

Methods inherited from class java.lang.Object

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

Field Detail

playKey

protected Key playKey

pauseKey

protected Key pauseKey

stopKey

protected Key stopKey

next

protected AudioSourceState next

Constructor Detail

KeyboardAudioTrigger

public KeyboardAudioTrigger(KeyMap keyMap,
                            Key playKey,
                            Key pauseKey,
                            Key stopKey)

Construct a new KeyboardAudioTrigger with custom keys. The KeyMap is used in the constructor only for registering.

Parameters:

keyMap - this trigger will register itself on this keymap

playKey - key to indicate a play

pauseKey - key to indicate a pause

stopKey - key to indicate a stop

KeyboardAudioTrigger

public KeyboardAudioTrigger(KeyMap keyMap)

Construct a new KeyboardAudioTrigger with the default keys (J, K, L). The KeyMap is used in the constructor only for registering.

Parameters:

keyMap - this trigger will register itself on this keymap

Method Detail

next

public AudioSourceState next(AudioSource as)

This tells the AudioEngine the desired state for any given AudioSource.

Specified by:

next in interface AudioTrigger

Parameters:

as - AudioSource to test

Returns:

desired state

onAction

public void onAction(KeyEvent event)

This method just sets the internal state, which is returned by next(AudioSource)

Specified by:

onAction in interface KeyListener

Parameters:

event - The KeyEvent

getPlayKey

@Generated(value="lombok")
protected Key getPlayKey()

getPauseKey

@Generated(value="lombok")
protected Key getPauseKey()

getStopKey

@Generated(value="lombok")
protected Key getStopKey()

getNext

@Generated(value="lombok")
protected AudioSourceState getNext()

setNext

@Generated(value="lombok")
protected void setNext(AudioSourceState next)