doc/dbus-api.txt

   1 Panucci D-Bus interface
   2
   3 name: org.panucci.panucciInterface
   4 path: /panucciInterface
   5
   6 play( )
   7     Starts playing the current file.
   8
   9 pause( )
  10     Pauses the current file.
  11
  12 stop( )
  13     Stops the current file and sets the current file to the first file in
  14     the playlist.
  15
  16 next( loop ) *
  17     Skips to the next track in the playlist.
  18
  19     loop - If True, this will cause the playlist to loop to back to the
  20            beginning if the end of the playlist is reached.
  21     Returns True if it was possible to skip forward.
  22
  23 prev( loop ) *
  24     Skips to the previous track in the playlist.
  25
  26     loop - If True, this will cause the playlist to loop to back to the
  27            beginning if trying to skip backwards before the first track.
  28     Returns True if it was possible to skip forward.
  29
  30 seek_by( amount ) *
  31     Seek "amount" in the current file.
  32
  33     amount - The number of _nanoseconds_ to seek from the current position in
  34              the current file.
  35
  36 current_position( ) *
  37     Get the current position in the file.
  38
  39     Returns the current position in _nanoseconds_ in the current file.
  40
  41 playPause( )
  42     Depending on the current status of the player, this will cause the
  43     opposite opperation to occur. Eg. If the player is paused, calling
  44     this will run play().
  45
  46 play_file( filepath )
  47     Erase the current playlist and start playing "filepath". If a custom
  48     playlist has been created the user will be prompted to save or erase
  49     the playlist.
  50
  51     filepath - The full path to a compatible audio file.
  52
  53 queue_file( filepath )
  54     Add a file to the end of the playlist.
  55
  56     filepath - The full path to a compatible audio file.
  57
  58 insert_file( position, filepath )
  59     Insert a file into the current playlist at "position".
  60
  61     position - The position that the file should be inserted starting from 0.
  62     filepath - The full path to a compatible audio file.
  63
  64 load_directory( filepath, append )
  65     Create a playlist from all the files in a directory.
  66
  67     filepath - The full path to a directory of audio files
  68     append   - If true, don't erase the playlist, just append files to the
  69                playlist. If false, the user will be asked if they'd like to
  70                overwrite the playlist.
  71
  72 show_main_window( )
  73     Brings the Panucci window to the front if it is obscured or minimized.
  74
  75
  76
  77         Stars (*) indicate a function which still has to be implemented