freesmartphone.org Framework DBus Interface Specification

org.freesmartphone.MusicPlayer

Description

The MusicPlayer object manages playlists and playing soundfiles.

Namespace

org.freesmartphone.MusicPlayer

Methods

Signals

Errors

Methods

DeletePlaylist ( o )

Description: Delete an excisting playlist

Parameters

o: list

The playlist which should be deleted

GetCurrentPlaylist ( ) → o

Description: Get the current playlist

Returns

o: list

The current playlist

GetInfoForFile ( s ) → a{sv}

Description: Get ID3 tags for a file

Parameters

s: file

An absolute path to the file

Returns

a{sv}: info

The fileinfo

GetPlaying ( ) → s

Description: Filename of the currently played song

Returns

s: file

Absolute path for the current song

GetPlayingInfo ( ) → a{sv}

Description: Fileinfo for the current file

Returns

a{sv}: info

Fileinfo of the file

GetPlaylists ( ) → as

Description: Get all available playlists

Returns

as: playlists

Object paths to available playlists

GetVolume ( ) → i

Description: Get the current volume

Returns

i: volume

The current volume in percent. Possible values: 0-1000

Jump ( i )

Description: Jump to an absolute position in the file

Parameters

i: position

Absolute position to new positition in seconds

NewPlaylist ( s ) → o

Description: Create a new playlist

Parameters

s: name

The name of the new playlist

Returns

o: path

The object path to the new playlist

Next ( )

Description: Jump to next song

Pause ( )

Description: Pause playing

Play ( )

Description: Play current song

PopPause ( )

Description: Return to state before first PushPause call

Previous ( )

Description: Jump to previous song

PushPause ( )

Description: Force to pause the player if playing. Use PopPause to undo.

SeekBackward ( i )

Description: Jump backward relative to current position

Parameters

i: step

Step in seconds for seeking

SeekForward ( i )

Description: Jump forward relative to current position

Parameters

i: step

Step in seconds for seeking

SetCurrentPlaylist ( o )

Description: Set the current playlis

Parameters

o: list

SetPlaying ( s )

Description: Set the current playing file

Parameters

s: file

Absolute path to the file

SetVolume ( i )

Description: Set the current volume

Parameters

i: volume

The current volume in percent. Allowed values: 0-1000

Stop ( )

Description: Stop playing

Signals

PlayingChanged ( s )

Description: Emmitted when the current song changes

Parameters

s: file

The new playing file

PlaylistAdded ( o )

Description: Emmitted when a client adds a playlist

Parameters

o: path

Object path for the new playlist

PlaylistRemoved ( o )

Description: Emmitted when a client deletes a playlist

Parameters

o: path

Object path of the deleted list

Progress ( i )

Description: Emmitted when the file position change

Parameters

i: progress

The new progress

State ( s )

Description: Emmitted when the current song changes

Parameters

s: state

The new state of the player. Possible values:

Error ( ss )

Description: Emmitted when an error occurs without user interaction

Parameters

s: the_error

The type of the error.

s: info

Additional information for the error

Errors

NoFileSelected

Description: Raised, if no file is selected.

NoPlaylistSelected

Description: Raised, if no playlist is selected.

UnknownPlaylist

Description: Raised, if the requested playlist is unknown.

PlaylistOutOfFiles

Description: Raised, if the Playlist is out of files, either on the beginning or the end.

FileNotFound

Description: Raised, if a file isn't available.

FiletypeNotSupported

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

ProtocolNotSupported

Description: Raised, if the protocol isn't supported.


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