A Player for local music playing in background. More...

Inheritance diagram for de.yaacc.player.LocalBackgoundMusicPlayer:

Collaboration diagram for de.yaacc.player.LocalBackgoundMusicPlayer:

Public Member Functions
	LocalBackgoundMusicPlayer (UpnpClient upnpClient, String name, String shortName)

	LocalBackgoundMusicPlayer (UpnpClient upnpClient)

void	onDestroy ()
	Kill the player.

PendingIntent	getNotificationIntent ()
	Returns the intent which is to be started by pushing the notification entry.

String	getDuration ()
	Returns the duration of the current track.

long	getCurrentPosition ()
	returns the current position of the current item in millis

String	getElapsedTime ()
	returns the elapsed time of the current item

URI	getAlbumArt ()

void	onServiceConnected (ComponentName className, IBinder binder)

void	onServiceDisconnected (ComponentName className)

boolean	isMusicServiceBound ()
	True if the player is initialized.

int	getIconResourceId ()

void	seekTo (long millisecondsFromStart)

void	onCompletion ()

Public Member Functions inherited from de.yaacc.player.AbstractPlayer
	AbstractPlayer (UpnpClient upnpClient)

Context	getContext ()

Bitmap	getIcon ()

void	setIcon (Bitmap icon)

UpnpClient	getUpnpClient ()

void	startService ()

void	next ()
	play the next item

void	previous ()
	play the previous item

void	pause ()
	Pause the current item.

void	play ()
	start playing the current item

void	stop ()
	stops playing.

void	clear ()
	Drops all Items.

boolean	isPlaying ()

void	setPlaying (boolean isPlaying)

int	getCurrentIndex ()

void	setCurrentIndex (int currentIndex)

List< PlayableItem >	getItems ()

void	setItems (PlayableItem... playableItems)
	Set a List of Items.

void	addItems (List< PlayableItem > playableItems)
	adds additional item to the end of the playlist

String	getPositionString ()
	returns the current item position in the playlist

int	getCurrentItemIndex ()

String	getCurrentItemTitle ()
	returns the title of the current item

String	getNextItemTitle ()
	returns the title of the next current item

long	getRemainingTime ()

void	startTimer (final long duration)
	Start a timer for the next item change.

String	getName ()
	Get the player name.

void	setName (String name)
	Set the name of the player.

boolean	isProcessingCommand ()

void	setProcessingCommand (boolean isProcessingCommand)

void	exit ()
	Exit the player.

int	getId ()
	Returns the id of the Player.

void	addPropertyChangeListener (PropertyChangeListener listener)
	add a property change listener

void	removePropertyChangeListener (PropertyChangeListener listener)
	remove a property change listener

boolean	getMute ()

void	setMute (boolean mute)

int	getVolume ()

void	setVolume (int volume)

String	getDeviceId ()

String	getShortName ()
	Get the player short name.

void	setShortName (String name)
	Set the short name of the player.

boolean	hasActionGetVolume ()

boolean	hasActionGetMute ()

void	fastForward (int i)
	fast forward seconds

void	fastRewind (int i)
	fast rewind seconds

Protected Member Functions
void	doPause ()

void	doResume ()

void	stopItem (PlayableItem playableItem)

Object	loadItem (PlayableItem playableItem)

void	startItem (PlayableItem playableItem, Object loadedItem)

int	getNotificationId ()
	Returns the notification id of the player.

boolean	isShufflePlay ()
	read the setting for music player shuffle play.

void	doPostLoadItem (PlayableItem playableItem)

Protected Member Functions inherited from de.yaacc.player.AbstractPlayer
void	cancelTimer ()

Object	loadItem (int toLoadIndex)

void	loadItem (int previousIndex, int nextIndex)

long	getSilenceDuration ()
	returns the duration between two items

void	updateTimer ()

long	parseTimeStringToMillis (String timeString)

void	firePropertyChange (String property, Object oldValue, Object newValue)

void	executeCommand (TimerTask command, Date executionTime)

Additional Inherited Members
Static Public Attributes inherited from de.yaacc.player.AbstractPlayer
static final String	PLAYER_ID = "PlayerId"

static final String	PROPERTY_ITEM = "item"

Detailed Description

A Player for local music playing in background.

Author: Tobias Schoene (openbit)

Constructor & Destructor Documentation

◆ LocalBackgoundMusicPlayer()

de.yaacc.player.LocalBackgoundMusicPlayer.LocalBackgoundMusicPlayer	(	UpnpClient	upnpClient,
		String	name,
		String	shortName
	)

Parameters

name	playerName

Here is the call graph for this function:

Member Function Documentation

◆ doPause()

void de.yaacc.player.LocalBackgoundMusicPlayer.doPause ( )

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ doPostLoadItem()

void de.yaacc.player.LocalBackgoundMusicPlayer.doPostLoadItem ( PlayableItem playableItem )

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ doResume()

void de.yaacc.player.LocalBackgoundMusicPlayer.doResume ( )

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ getAlbumArt()

URI de.yaacc.player.LocalBackgoundMusicPlayer.getAlbumArt ( )

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ getCurrentPosition()

long de.yaacc.player.LocalBackgoundMusicPlayer.getCurrentPosition ( )

returns the current position of the current item in millis

Returns: the position

Reimplemented from de.yaacc.player.AbstractPlayer.

Referenced by de.yaacc.player.LocalBackgoundMusicPlayer.getElapsedTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDuration()

String de.yaacc.player.LocalBackgoundMusicPlayer.getDuration ( )

Returns the duration of the current track.

Returns: the duration

Reimplemented from de.yaacc.player.AbstractPlayer.

Referenced by de.yaacc.player.LocalBackgoundMusicPlayer.getDuration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getElapsedTime()

String de.yaacc.player.LocalBackgoundMusicPlayer.getElapsedTime ( )

returns the elapsed time of the current item

Returns: the elapsed time

Reimplemented from de.yaacc.player.AbstractPlayer.

Here is the call graph for this function:

◆ getIconResourceId()

int de.yaacc.player.LocalBackgoundMusicPlayer.getIconResourceId ( )

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ getNotificationId()

int de.yaacc.player.LocalBackgoundMusicPlayer.getNotificationId ( )

protected

Returns the notification id of the player.

Returns: the notification id

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ getNotificationIntent()

PendingIntent de.yaacc.player.LocalBackgoundMusicPlayer.getNotificationIntent ( )

Returns the intent which is to be started by pushing the notification entry.

Returns: the peneding intent

Reimplemented from de.yaacc.player.AbstractPlayer.

Here is the call graph for this function:

◆ isMusicServiceBound()

boolean de.yaacc.player.LocalBackgoundMusicPlayer.isMusicServiceBound ( )

True if the player is initialized.

Returns: true or false

Referenced by de.yaacc.player.LocalBackgoundMusicPlayer.getCurrentPosition(), de.yaacc.player.LocalBackgoundMusicPlayer.getDuration(), and de.yaacc.player.LocalBackgoundMusicPlayer.getElapsedTime().

Here is the caller graph for this function:

◆ isShufflePlay()

boolean de.yaacc.player.LocalBackgoundMusicPlayer.isShufflePlay ( )

protected

read the setting for music player shuffle play.

Returns: true, if shuffle play is enabled

Reimplemented from de.yaacc.player.AbstractPlayer.

Here is the call graph for this function:

◆ loadItem()

Object de.yaacc.player.LocalBackgoundMusicPlayer.loadItem ( PlayableItem playableItem )

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ onDestroy()

void de.yaacc.player.LocalBackgoundMusicPlayer.onDestroy ( )

Kill the player.

Reimplemented from de.yaacc.player.AbstractPlayer.

Here is the call graph for this function:

◆ onServiceConnected()

void de.yaacc.player.LocalBackgoundMusicPlayer.onServiceConnected	(	ComponentName	className,
		IBinder	binder
	)

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ onServiceDisconnected()

void de.yaacc.player.LocalBackgoundMusicPlayer.onServiceDisconnected ( ComponentName className )

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ seekTo()

void de.yaacc.player.LocalBackgoundMusicPlayer.seekTo ( long millisecondsFromStart )

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ startItem()

void de.yaacc.player.LocalBackgoundMusicPlayer.startItem	(	PlayableItem	playableItem,
		Object	loadedItem
	)

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

◆ stopItem()

void de.yaacc.player.LocalBackgoundMusicPlayer.stopItem ( PlayableItem playableItem )

protected

Reimplemented from de.yaacc.player.AbstractPlayer.

The documentation for this class was generated from the following file:

/github/workspace/yaacc/src/main/java/de/yaacc/player/LocalBackgoundMusicPlayer.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LocalBackgoundMusicPlayer()

Member Function Documentation

◆ doPause()

◆ doPostLoadItem()

◆ doResume()

◆ getAlbumArt()

◆ getCurrentPosition()

◆ getDuration()

◆ getElapsedTime()

◆ getIconResourceId()

◆ getNotificationId()

◆ getNotificationIntent()

◆ isMusicServiceBound()

◆ isShufflePlay()

◆ loadItem()

◆ onDestroy()

◆ onServiceConnected()

◆ onServiceDisconnected()

◆ seekTo()

◆ startItem()

◆ stopItem()