doc/signal-api.txt

   1
   2         Stars (*) indicate a singal which still has to be implemented
   3
   4
   5 Player Signal API
   6
   7     "playing"                    : ( )
   8         This is called when the player starts playing.
   9
  10     "paused"                     : ( position, duration )
  11         This is called when the player pauses.
  12
  13     "stopped"                    : ( )
  14         This is called when a track stops playing.
  15
  16
  17 Playlist Signal API
  18
  19 *   "bookmark-added"             : ( parent, position, data )
  20         Called when a bookmark is added.
  21         - parent: the id of the bookmark's parent item
  22         - position: the position of the bookmark in relation to all the other
  23           bookmarks associated with the parent item.
  24         - data: a tuple of data that represents a row in the treemodel
  25
  26 *   "bookmark-removed"           : ( parent, position )
  27         Called when a bookmark is removed.
  28         - parent: the id of the bookmark's parent item
  29         - position: the position of the bookmark in relation to all the other
  30           bookmarks associated with the parent item.
  31
  32     "end-of-playlist"            : ( loop )
  33         Called when the end of the playlist is reached.
  34         - loop: if True, the playlist reached it's end but will loop back to
  35           the beginning. Otherwise, we stop playing.
  36
  37 *   "item-moved"                 : ( item, old_position, new_position )
  38         Called when an item in the playlist is moved.
  39         - item: the item id in question
  40         - old_position: the old position of said item
  41             - new_position: the new position of said item
  42
  43 *   "file-queued"                : ( item, position, bulk_add )
  44         Called when a new file is queued.
  45         - item_data: the id of item in question
  46         - position: the position of the item
  47         - bulk_add: whether or not this item is being added as part of a
  48           large set of files.
  49
  50 *   "file-removed"               : ( item, position )
  51         Called when a file is removed from the playlist.
  52         - item: the id of item in question
  53             - position: the position of said item
  54
  55     "new-metadata-available"     : ( )
  56         Called when new metadata is available.
  57
  58     "new-track-loaded"           : ( )
  59         Called when a new track is loaded as the playlist's current track.
  60
  61     "playlist-to-be-overwritten" : ( )
  62         Called when a playlist is about to be over-written. If the function
  63             returns True the playlist will be over-written. Otherwise the
  64             over-write will be aborted.
  65
  66     "seek-requested"             : ( position )
  67         Called when a seek is requested in the current track
  68         - position: the position in nanoseconds from the beginning of the track
  69
  70     "stop-requested"             : ( )
  71         Called when the playlist needs to change track. This call should be
  72         handled by a function that takes care of stopping the player which
  73         in turn calls the playlist's stop() function.