@@ -12,13 +12,13 @@ UI hints line to start playing the first track in the search result. -DCOP interface XXX-KDE4 +DBus interface ============== -Minirok exports a DCOP interface containing functions to perform -Playlist actions (play, pause, playPause, stop, next, previous, -stopAfterCurrent), and a function to retrieve the currently playing -track, "nowPlaying". +Minirok exports a DBus interface; the object path is /Player, and the +service org.kde.minirok. There are functions to perform playlist actions +(Play, Pause, PlayPause, Stop, Next, Previous, StopAfterCurrent), and a +function to retrieve the currently playing track, "NowPlaying". This last functions comes in two flavours: without an argument, it will return a string like "Artist - Title", or just "Title" if there's no @@ -26,21 +26,20 @@ known artist. However, you can pass a string argument that will be formatted against a dict of the tags with the Python % operator. For example: - % dcop minirok player nowPlaying "%(Artist)s - %(Title)s (%(Album)s)" + % qdbus org.kde.minirok \ + /Player NowPlaying "%(Artist)s - %(Title)s [%(Album)s]" Do not forget the "s" after the brackets, it's needed by Python. -There is also a appendToPlaylist function, which does the same as -`minirok --append`. The function takes a QStringList as argument, so to -invoke it you must place the arguments between square brackets, like this: +There is also an AppendToPlaylist function, which does the same as +`minirok --append`. The function takes a list of paths as argument, so +to invoke it you must place the arguments between brackets, like this: - % dcop minirok player appendToPlaylist [ /path/to/file.mp3 ... ] + % qdbus org.kde.minirok \ + /Player AppendToPlaylist '(' /path/to/file.mp3 ... ')' Note that you have to specify the full paths of files, or it won't work. -Finally, there is a toggleWindow function, which hides/shows the main -window. - Regular expressions =================== README.Usage @@ -83,25 +83,33 @@ </refsect1> <refsect1> - <title>DCOP INTERFACE</title> + <title>DBUS INTERFACE</title> <para> - Minirok offers a DCOP interface to control the player and various - other bits. To invoke a DCOP function, run from a terminal - <command>dcop minirok player <replaceable>functionName</replaceable></command>. - Here's a list of available functions: + Minirok offers a DBus interface to control the player and various + other bits. At the moment a single object /Player is provided, + under the org.kde.minirok service. To invoke a DBus method, run + from a terminal <command>qdbus org.kde.minirok /Player + <replaceable>methodName</replaceable></command>. + <command>dbus-send</command>(1) should also work, but + then you'll need to fully qualify the method name. </para> - <programlisting> play - pause - playPause - stop - next - previous - nowPlaying - toggleWindow - appendToPlaylist - stopAfterCurrent</programlisting> <para> - See the <filename>README.Usage</filename> file for details. + Here's a list of available methods: + </para> + <programlisting> Play + Pause + PlayPause + Stop + Next + Previous + NowPlaying + AppendToPlaylist + StopAfterCurrent</programlisting> + <para> + See the <filename>README.Usage</filename> file for details. Note + that this interface will only be available if the required + dependencies are installed. See the <filename>README</filename> + file a list of these. </para> </refsect1> minirok.xml 978758021ff3eaca0583a93eff36ceb26a69e083 Adeodato Simó dato@net.com.org.es http://github.com/dato/minirok/commit/6a7803c9fbe8700809a447f34feec51e66cf6242 6a7803c9fbe8700809a447f34feec51e66cf6242 2008-04-09T02:36:37-07:00 2008-04-08T11:39:14-07:00 Update README.Usage and the man page for DBus. 03caefeb4ec943f02859def35cd8e71f9f3a29d0 Adeodato Simó dato@net.com.org.es