com.soundhelix.component.player

Interface Player

All Superinterfaces:

Component, RandomSeedable, XMLConfigurable

All Known Implementing Classes:

AbstractPlayer, MidiPlayer

public interface Player
extends Component

Represents an interface for playing Arrangements. A player's task is to play the arrangement in real-time. All methods except for play() are callable and should have an immediate or delayed effect while play() is running in another thread.

Author:

Thomas Schuerger (thomas@schuerger.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	abortPlay() Aborts play().
int	getCurrentTick() Returns the current tick of the player.
int	getMilliBPM() Gets the playback speed in milli-BPM.
void	play(SongContext songContext) Plays the arrangement from the song context.
void	setMilliBPM(int milliBPM) Sets the playback speed in milli-BPM.
boolean	skipToTick(int tick) Skips to the specified tick.

Methods inherited from interface com.soundhelix.component.XMLConfigurable

configure

Methods inherited from interface com.soundhelix.component.RandomSeedable

getRandomSeed, setRandomSeed

Method Detail

play

void play(SongContext songContext)

Plays the arrangement from the song context. The method will return as soon as playing has finished. This method will block until the song is finished or playback has been aborted successfully via abortPlay(). Only one thread can run play() at a time.

Parameters:

songContext - the song context

Throws:

IllegalStateException - if play() is called while play() is running in another thread

getMilliBPM

int getMilliBPM()

Gets the playback speed in milli-BPM.

Returns:

the speed in milli-BPM

setMilliBPM

void setMilliBPM(int milliBPM)

Sets the playback speed in milli-BPM. Setting the BPM speed should be possible while the player is playing an arrangement.

Parameters:

milliBPM - the speed in milli-BPM

skipToTick

boolean skipToTick(int tick)

Skips to the specified tick. If this was done or triggered successfully, true is returned, otherwise false is returned. The player may not support skipping at all or may not support skipping backwards. In this case, the player must ignore the skip request and must return false. This method should return immediately, even if skipping takes a while to complete. Skipping to a different tick while in the midst of skipping to a different tick may or may not be supported by the player.

Parameters:

tick - the tick to skip to

Returns:

true if skipping was successful

getCurrentTick

int getCurrentTick()

Returns the current tick of the player. If the player is not yet playing, if it is in the warm-up phase or in the cool-down phase or playing has finished, -1 will be returned.

Returns:

the current tick (or -1)

abortPlay

void abortPlay()

Aborts play(). When this message returns, the playback should already have stopped and all resources should have been released. If the player isn't playing, nothing is done.