Browse code
basic docs
fiddlerwoaroof authored on 13/09/2016 06:46:01Showing 1 changed files
| ... | ... |
@@ -1 +1,19 @@ |
| 1 |
-This is the stub README.txt for the "mpd-remote" project. |
|
| 1 |
+A fairly simple wrapper around the MPD protocol |
|
| 2 |
+ |
|
| 3 |
+ |
|
| 4 |
+``` |
|
| 5 |
+(WITH-MPD-CONNECTION (socket-symbol stream-symbol &optional (host "127.0.0.1") (port 6600)) &body body) |
|
| 6 |
+``` |
|
| 7 |
+ |
|
| 8 |
+This macro wraps up a socket connection to the mpd server, binding the resulting socket and stream to the |
|
| 9 |
+appropriate symbols. |
|
| 10 |
+ |
|
| 11 |
+``` |
|
| 12 |
+(SEND-COMMAND stream command &rest args &key) |
|
| 13 |
+``` |
|
| 14 |
+ |
|
| 15 |
+This generic function wraps individual commands to be sent to the mpd server, using RENDER-COMMAND to |
|
| 16 |
+determine the textual representation of a command. Command is a keyword that determines the command to be set: |
|
| 17 |
+specialize these two methods with an eql-specializer on COMMAND to override the default handling. |
|
| 18 |
+In particular, commands that return song info use an eql-specializer on an `:AROUND` method to transform |
|
| 19 |
+the results from mpd into objects of the type MPD-REMOTE.SONG::SONG |