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

Class InformationProvider

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

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

All Implemented Interfaces:

Identifiable, ResourceBuilderModel, ResourcesProviderBase, MusicHelper, MusicProvider, MusicResourceGenerator, PermanentSoundHelper, PermanentSoundResources, PermanentSoundUsed, ContextProvider, FireEvent, Loggable, LoggedExceptionCallback, ExceptionCallback

public class InformationProvider
extends AddOnModule
implements MusicResourceGenerator

this class is responsible for communication information on request. Essentially it is responsible for answering the the resource-requests. The code for answering lies in the Interface (it is implemented this way to allow better composition if you don't want to use the templates)

Version:

1.0

Author:

LeanderK

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.frameworks.music.player.MusicResourceGenerator

PROVIDE_RESOURCE_ERROR, PROVIDE_RESOURCE_ERROR_GENERATING, PROVIDE_RESOURCE_ERROR_NOT_CAPABLE

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

FQCN

Constructor Summary

Constructors

Constructor and Description
InformationProvider(Context context, String ID, MusicProvider musicProvider, CommandHandler commandHandler) initializes the Module

Method Summary

Modifier and Type	Method and Description
List<? extends ResourceModel>	announceResources()
Optional<? extends ResourceModel>	generateResource(ResourceModel resourceModel, Optional<EventModel> event) generates the resources
Capabilities	getCapabilities() gets the Capabilities of the Player
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)

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.MusicResourceGenerator

createCapabilitiesResource, createNowPlayingResource, createPlaybackStateResource, createPlayerResource, createProgressResource, createTrackInfoResource, createVolumeResource

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

createUsingSoundResource, provideResource

Methods inherited from interface org.intellimate.izou.sdk.frameworks.common.resources.ResourcesProviderBase

announceEvents, resourcesInit

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

playerError, playerError, startedSound, startedSound, updatePlayInfo, updatePlayInfo, updatePlayInfo, updatePlayInfo, 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.sdk.util.Loggable

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

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

exceptionThrown

Constructor Detail

InformationProvider

public InformationProvider(Context context,
                           String ID,
                           MusicProvider musicProvider,
                           CommandHandler commandHandler)

initializes the Module

Parameters:

context - the current Context

musicProvider - the musicProvider to get the data from

ID - the ID

commandHandler - the commandHandler

Method Detail

announceResources

public List<? extends ResourceModel> announceResources()

Specified by:

announceResources in interface ResourceBuilderModel

Specified by:

announceResources in interface ResourcesProviderBase

Specified by:

announceResources in interface MusicResourceGenerator

Specified by:

announceResources in interface PermanentSoundResources

generateResource

public Optional<? extends ResourceModel> generateResource(ResourceModel resourceModel,
                                                          Optional<EventModel> event)

generates the resources

Specified by:

generateResource in interface ResourcesProviderBase

Specified by:

generateResource in interface MusicResourceGenerator

Specified by:

generateResource in interface PermanentSoundResources

Parameters:

resourceModel - the resourceModel

event - the Event

Returns:

a Stream containing the resourceModel(s)

getCurrentPlaylist

public Playlist getCurrentPlaylist()

gets the current Playlist

Specified by:

getCurrentPlaylist in interface MusicProvider

Returns:

the current Playlist

getVolume

public Volume getVolume()

gets the Volume

Specified by:

getVolume in interface MusicProvider

Returns:

the volume

getCurrentProgress

public Progress getCurrentProgress()

gets the Progress

Specified by:

getCurrentProgress in interface MusicProvider

Returns:

the Progress

getCapabilities

public Capabilities getCapabilities()

gets the Capabilities of the Player

Specified by:

getCapabilities in interface MusicProvider

Returns:

and instance of Capabilities

getPlaybackState

public PlaybackState getPlaybackState()

gets the PlaybackState of the Player

Specified by:

getPlaybackState in interface MusicProvider

Returns:

the PlaybackState

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