org.intellimate.izou.sdk.frameworks.music.player.template

Class Player<T>

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.output.OutputPluginArgument<Object,T>

org.intellimate.izou.sdk.output.OutputPlugin<T>

org.intellimate.izou.sdk.frameworks.music.player.template.Player<T>

All Implemented Interfaces:

Runnable, EventListenerModel, Identifiable, OutputPluginModel<Object,T>, ResourceBuilderModel, MusicHelper, MusicProvider, PermanentSoundHelper, PermanentSoundUsed, ContextProvider, FireEvent, Loggable, LoggedExceptionCallback, ThreadPoolUser, ExceptionCallback

public abstract class Player<T>
extends OutputPlugin<T>
implements MusicProvider, ResourceBuilderModel, MusicHelper, EventListenerModel

use this class to actually play music.

How to use it:
Usage is pretty straightforward. Extend this class an override the abstract methods.
- To register further commands, use the getCommandHandler() method in the constructor.
- To start playing, use the PlayerController.startPlaying() methods, never call the play() method directly! Also, don't call the stopSound() method directly, use stopMusicPlayback(). All basic methods are implemented in this class,but to code special behaviour fell free to explore the other classes and interfaces.
Note: the playback automatically stops when the user left.

Version:

1.0

Author:

LeanderK

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
Player(Context context, String id, boolean runsInPlay, boolean playRequestTrackInfo, boolean providesTrackInfo, boolean playbackShuffle, boolean playbackRepeat, boolean playbackRepeatSong, boolean isUsingJava) creates a new output-plugin with a new id
Player(Context context, String id, boolean runsInPlay, Identifiable activator, boolean providesTrackInfo, boolean playbackShuffle, boolean playbackRepeat, boolean playbackRepeatSong, boolean isUsingJava) creates a new output-plugin with a new id
Player(Context context, String id, boolean runsInPlay, List<Identifiable> activators, boolean providesTrackInfo, boolean playbackShuffle, boolean playbackRepeat, boolean playbackRepeatSong, boolean isUsingJava) creates a new output-plugin with a new id

Method Summary

Modifier and Type	Method and Description
List<? extends EventModel<?>>	announceEvents() this method is called to register for what Events it wants to provide Resources.
List<? extends ResourceModel>	announceResources() This method is called to register what resources the object provides. just pass a List of Resources without Data in it.
protected CommandHandler	createCommandHandler() override this method if you want to change the command handler
void	eventFired(EventModel eventModel)
protected void	fireStartMusicRequest(EventModel eventModel) this method will be called to create and fire the StartMusicRequest
Capabilities	getCapabilities() gets the Capabilities of the Player
CommandHandler	getCommandHandler() returns the CommandHandler
Playlist	getCurrentPlaylist() gets the current Playlist
Progress	getCurrentProgress() gets the Progress
PlaybackState	getPlaybackState() gets the PlaybackState of the Player
Volume	getVolume() gets the Volume
boolean	isOutputRunning() true if playing and false if not
boolean	isPlaying() true if playing and false if not
boolean	isUsingJava() true if using java, false if not (and for example a C-library)
abstract void	mute() this method call must mute the plugin.
void	pausePlaying() signals that the playing paused
abstract void	play(EventModel eventModel) this method will be called if a request was cached which was eligible to start the music. please check the events resources for parameters (if expected).
List<ResourceModel>	provideResource(List<? extends ResourceModel> resources, Optional<EventModel> event) This method is called when an object wants to get a Resource.
void	renderFinalOutput(List<T> data, EventModel eventModel) method that uses the data from the OutputExtensions to generate a final output that will then be rendered.
void	resumePlaying() signals that the playing resumed
void	rollBackToDefault() sets every information into its default state (playlist, volume, etc...)
void	stop()
void	stopMusicPlayback() stops the playing/indicates that the playing stopped.
abstract void	stopSound() this method call must stop the sound. NEVER CALL THIS METHOD DIRECTLY, USE stopMusicPlayback().
void	trackInfoUpdate(Playlist playlist, TrackInfo info) call this method if the trackInfo object in the playlist was updated.
abstract void	unMute() this method call must un-mute the plugin.
void	updateCurrentTrackInfo(TrackInfo trackInfo) checks if the trackInfo is an update and fires the appropriate Event.
void	updatePlayInfo(Playlist playlist) fires an update event which notifies that parameters have changed
void	updatePlayInfo(Playlist playlist, Progress progress, TrackInfo trackInfo, Volume volume) fires an update event which notifies that parameters have changed
void	updatePlayInfo(Playlist playlist, Progress progress, Volume volume) updates the Info about the current song
void	updatePlayInfo(Progress progress) fires an update event which notifies that parameters have changed
void	updatePlayInfo(Volume volume) fires an update event which notifies that parameters have changed

Methods inherited from class org.intellimate.izou.sdk.output.OutputPlugin

getArgument, getArgumentType

Methods inherited from class org.intellimate.izou.sdk.output.OutputPluginArgument

addToEventList, blockingQueueHandling, getEventBlockingQueue, getOutputExtensionList, getReceivingType, getTimeoutLimit, handleFutures, isDone, isRunning, outputExtensionAdded, outputExtensionRemoved, run, terminate

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.sdk.frameworks.music.player.MusicHelper

playerError, playerError, startedSound, startedSound, updatePlayInfo, updateStateInfo

Methods inherited from interface org.intellimate.izou.sdk.frameworks.permanentSoundOutput.output.PermanentSoundHelper

endedSound

Methods inherited from interface org.intellimate.izou.sdk.util.FireEvent

fire, fire, fire, fire, fire

Methods inherited from interface org.intellimate.izou.sdk.util.ContextProvider

debug, debug, error, error, getContext

Methods inherited from interface org.intellimate.izou.identification.Identifiable

getID, isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.ThreadPoolUser

submit, submit, submit, submitRun, timeOut, timeOut

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

Player

public Player(Context context,
              String id,
              boolean runsInPlay,
              List<Identifiable> activators,
              boolean providesTrackInfo,
              boolean playbackShuffle,
              boolean playbackRepeat,
              boolean playbackRepeatSong,
              boolean isUsingJava)

creates a new output-plugin with a new id

Parameters:

context - context

id - the id of the new output-plugin. The ID of the InformationProvider is also based on this id (id + ".InformationProvider")

runsInPlay - whether the termination of the play method should be treated as the termination the music (STOP not PAUSE)

activators - the activators which are able to start the Player if the Player is not able to start from request from other addons

providesTrackInfo - whether the Player provides TrackInfo

playbackShuffle - whether the player is able to provide the info that the playback is shuffling

playbackRepeat - whether the player is able to provide the info that the playback is repeating

playbackRepeatSong - whether the player is able to provide the info that the playback is repeating the song

isUsingJava - true if using java, false if not (and for example a C-library)

Player

public Player(Context context,
              String id,
              boolean runsInPlay,
              Identifiable activator,
              boolean providesTrackInfo,
              boolean playbackShuffle,
              boolean playbackRepeat,
              boolean playbackRepeatSong,
              boolean isUsingJava)

creates a new output-plugin with a new id

Parameters:

context - context

id - the id of the new output-plugin. The ID of the InformationProvider is also based on this id (id + ".InformationProvider")

runsInPlay - whether the termination of the play method should be treated as the termination the music (STOP not PAUSE)

activator - the activator which is able to start the Player if the Player is not able to start from request from other addons

providesTrackInfo - whether the Player provides TrackInfo

playbackShuffle - whether the player is able to provide the info that the playback is shuffling

playbackRepeat - whether the player is able to provide the info that the playback is repeating

playbackRepeatSong - whether the player is able to provide the info that the playback is repeating the song

isUsingJava - true if using java, false if not (and for example a C-library)

Player

public Player(Context context,
              String id,
              boolean runsInPlay,
              boolean playRequestTrackInfo,
              boolean providesTrackInfo,
              boolean playbackShuffle,
              boolean playbackRepeat,
              boolean playbackRepeatSong,
              boolean isUsingJava)

creates a new output-plugin with a new id

Parameters:

context - context

id - the id of the new output-plugin

runsInPlay - whether the termination of the play method should be treated as the termination of playing the music

playRequestTrackInfo - whether the player is able to process PlayRequests with TrackInfo

providesTrackInfo - whether the Player provides TrackInfo

playbackShuffle - whether the player is able to provide the info that the playback is shuffling

playbackRepeat - whether the player is able to provide the info that the playback is repeating

playbackRepeatSong - whether the player is able to provide the info that the playback is repeating the song

isUsingJava - true if using java, false if not (and for example a C-library)

Method Detail

getCommandHandler

public CommandHandler getCommandHandler()

returns the CommandHandler

Returns:

the CommandHandler

isOutputRunning

public boolean isOutputRunning()

true if playing and false if not

Specified by:

isOutputRunning in interface MusicProvider

Specified by:

isOutputRunning in interface PermanentSoundUsed

Returns:

tre if playing

isPlaying

public boolean isPlaying()

true if playing and false if not

Specified by:

isPlaying in interface MusicProvider

Returns:

tre if playing

isUsingJava

public boolean isUsingJava()

true if using java, false if not (and for example a C-library)

Specified by:

isUsingJava in interface MusicProvider

Specified by:

isUsingJava in interface PermanentSoundUsed

Returns:

true if using java

stopMusicPlayback

public void stopMusicPlayback()

stops the playing/indicates that the playing stopped.

this method has no effect if runsInPlay is enabled in the constructor.

getCurrentPlaylist

public Playlist getCurrentPlaylist()

gets the current Playlist

Specified by:

getCurrentPlaylist in interface MusicProvider

Returns:

the current Playlist

updatePlayInfo

public void updatePlayInfo(Playlist playlist)

fires an update event which notifies that parameters have changed

Specified by:

updatePlayInfo in interface MusicHelper

Parameters:

playlist - the optional playlist

updateCurrentTrackInfo

public void updateCurrentTrackInfo(TrackInfo trackInfo)

checks if the trackInfo is an update and fires the appropriate Event. This method should not be called without an active playlist, or an NullPointerException will be thrown. this method:
- fires nothing if the trackInfo equals the current trackInfo.
- fires an trackInfoUpdate if the trackInfo contains information not found in the current.

trackInfoUpdate

public void trackInfoUpdate(Playlist playlist,
                            TrackInfo info)

call this method if the trackInfo object in the playlist was updated. Only the trackinfo object will be sent via Event

Parameters:

playlist - the playlist

info - the new trackInfo object

getVolume

public Volume getVolume()

gets the Volume

Specified by:

getVolume in interface MusicProvider

Returns:

the volume

updatePlayInfo

public void updatePlayInfo(Volume volume)

fires an update event which notifies that parameters have changed

Specified by:

updatePlayInfo in interface MusicHelper

Parameters:

volume - the optional volume

getCurrentProgress

public Progress getCurrentProgress()

gets the Progress

Specified by:

getCurrentProgress in interface MusicProvider

Returns:

the Progress

updatePlayInfo

public void updatePlayInfo(Progress progress)

fires an update event which notifies that parameters have changed

Specified by:

updatePlayInfo in interface MusicHelper

Parameters:

progress - the optional progress

getPlaybackState

public PlaybackState getPlaybackState()

gets the PlaybackState of the Player

Specified by:

getPlaybackState in interface MusicProvider

Returns:

the PlaybackState

pausePlaying

public void pausePlaying()

signals that the playing paused

resumePlaying

public void resumePlaying()

signals that the playing resumed

updatePlayInfo

public void updatePlayInfo(Playlist playlist,
                           Progress progress,
                           Volume volume)

updates the Info about the current song

Parameters:

playlist - the playlist, or null

progress - the progress, or null

volume - the volume, or null

updatePlayInfo

public void updatePlayInfo(Playlist playlist,
                           Progress progress,
                           TrackInfo trackInfo,
                           Volume volume)

fires an update event which notifies that parameters have changed

Specified by:

updatePlayInfo in interface MusicHelper

Parameters:

playlist - the optional playlist

progress - the optional progress

trackInfo - the optional trackInfo

volume - the optional volume

getCapabilities

public Capabilities getCapabilities()

gets the Capabilities of the Player

Specified by:

getCapabilities in interface MusicProvider

Returns:

and instance of Capabilities

announceResources

public List<? extends ResourceModel> announceResources()

This method is called to register what resources the object provides.
just pass a List of Resources without Data in it.

Specified by:

announceResources in interface ResourceBuilderModel

Returns:

a List containing the resources the object provides

announceEvents

public List<? extends EventModel<?>> announceEvents()

this method is called to register for what Events it wants to provide Resources.

The Event has to be in the following format: It should contain only one Descriptor and and one Resource with the ID "description", which contains an description of the Event.

Specified by:

announceEvents in interface ResourceBuilderModel

Returns:

a List containing ID's for the Events

provideResource

public List<ResourceModel> provideResource(List<? extends ResourceModel> resources,
                                           Optional<EventModel> event)

This method is called when an object wants to get a Resource.

Don't use the Resources provided as arguments, they are just the requests. There is a timeout after 1 second.

Specified by:

provideResource in interface ResourceBuilderModel

Parameters:

resources - a list of resources without data

event - if an event caused the action, it gets passed. It can also be null.

Returns:

a list of resources with data

renderFinalOutput

public void renderFinalOutput(List<T> data,
                              EventModel eventModel)

method that uses the data from the OutputExtensions to generate a final output that will then be rendered.

Specified by:

renderFinalOutput in class OutputPlugin<T>

Parameters:

data - the data generated

eventModel - the Event which caused the whole thing

createCommandHandler

protected CommandHandler createCommandHandler()

override this method if you want to change the command handler

Returns:

the command handler

fireStartMusicRequest

protected void fireStartMusicRequest(EventModel eventModel)

this method will be called to create and fire the StartMusicRequest

Parameters:

eventModel - the cause

stop

public void stop()

Specified by:

stop in interface OutputPluginModel<Object,T>

Overrides:

stop in class OutputPluginArgument<Object,T>

eventFired

public void eventFired(EventModel eventModel)

Specified by:

eventFired in interface EventListenerModel

rollBackToDefault

public void rollBackToDefault()

sets every information into its default state (playlist, volume, etc...)

mute

public abstract void mute()

this method call must mute the plugin.

unMute

public abstract void unMute()

this method call must un-mute the plugin.

stopSound

public abstract void stopSound()

this method call must stop the sound.
NEVER CALL THIS METHOD DIRECTLY, USE stopMusicPlayback().

play

public abstract void play(EventModel eventModel)

this method will be called if a request was cached which was eligible to start the music.
please check the events resources for parameters (if expected).

Parameters:

eventModel - the cause