freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.MusicPlayer.Playlist

Description

The MusicPlayer Playlist objects manage the soundfile for the MusicPlayer.

Namespace

org.freesmartphone.MusicPlayer.Playlist

Methods

Signals

Errors

Methods

Add ( s ) → i

Description: Append a file to the playlist

Parameters

s: file

The file to be appended

Returns

i: position

The position of the new file

ChangeName ( s )

Description: Changes the playlists name

Parameters

s: new_name

Playlist's new name

GetAtPosition ( i ) → s

Description: Get the filename at the specified position

Parameters

i: position

Position in the playlist

Returns

s: result

The filename

GetFiles ( ) → as

Description: Get all files in the playlist

Returns

as: result

A list of all files in the playlist

GetMode ( ) → s

Description: Get the playlist mode

Returns

s: mode

The mode for the playlist. One of:

GetName ( ) → s

Description: Get the playlist's name

Returns

s: name

The playlist's name

Insert ( is )

Description: Insert a file at a specific position

Parameters

i: position

The position in the playlist

s: file

The file to be inserted

InsertDir ( isb )

Description: Insert a directory into a playlist

Parameters

i: position

The position in the playlist

s: file

The directory to be inserted

b: recursive

True to scan the directory recursivly

JumpTo ( i )

Description: Jump to a file in the Playlist

Parameters

i: position

Position of the file in the playlist

LoadFromUri ( s )

Description: Add entries from a URI. Local files do not need file:// prefix.

Parameters

s: file

A file with soundfiles seperated by '\n'

Remove ( i )

Description: Delete a file from the playlist

Parameters

i: position

The position of the file to be deleted

SetMode ( s )

Description: Sets the playlist's mode

Parameters

s: mode

The new playlist mode. See GetMode for possible values

Signals

Deleted ( )

FileAdded ( is )

Description: Emmitted when a file is added

Parameters

i: position

The position of the new file

s: file

The new file

FileRemoved ( i )

Description: Emmitted when a file is removed from the playlist

Parameters

i: postion

The position of the filename

ModeChanged ( s )

Description: Emmitted when the mode changed

Parameters

s: mode

The new playlist's mode. See GetMode for possible values

Name ( s )

Description: Emmitted when the name of the playlist changes

Parameters

s: name

The new playlist name. This won't change the object path on the bus

Playing ( s )

Description: Emmitted when the current song changes

Parameters

s: file

The new playing file

Errors

FileNotFound

Description: Raised, if the the file isn't found.

OutOfRange

Description: Raised, if the the given position is bigger than the playlist's length.

FiletypeNotSupported

Description: Raised, if the given filetype isn't supported.

Empty

Description: Raised, if the playlist is empty.

NoFileSelected

Description: Raised, if no file of the playlist ist selected.

OutOfFiles

Description: Raised, if the playlist is at an end.


| Specified 2008-2009 by the Freesmartphone.org team. | Join us and discuss further drafts smartphones-standards (at) linuxtogo (dot) org