Remove some unused error codes.
[paraslash.git] / audiod.cmd
index 2c6ea9b14ac6c145b369ca140a9d2941cf1ec5d9..7ffe98e7d249368992568f42dcb1bc816eb7afb5 100644 (file)
@@ -14,11 +14,32 @@ H: on -> standby -> off -> on
 N: grab
 D: grab the audio stream
 L:
-U: -- grab [grab_options]
-H: grab ('splice') the audio stream at any position in the filter
-H: chain and send that data back to the client. Try
-H:     para_audioc -- grab -h
-H: for the list of available options.
+U: -- grab [-m[{s|p|a}]] [-p=<parent>] [-n=<name>] [-o]
+H:
+H: grab ('splice') the audio stream at any position in the buffer
+H: tree and send that data back to the client.
+H:
+H: Options:
+H:
+H: -m  Change grab mode. Defaults to sloppy grab if not given.
+H:
+H:             -ms: sloppy grab
+H:
+H:             -mp: pedantic grab
+H:
+H:             -ma: aggressive grab
+H:
+H:     The various grab modes only differ in what happens if the
+H:     file descriptor to write the grabbed audio data to is not
+H:     ready for writing (i.e. would block). Sloppy mode ignores
+H:     the write, pedantic mode aborts and aggressive mode tries
+H:     to write anyway.
+H:
+H: -p  Grab output of node <parent> of the buffer tree.
+H:
+H: -n  Name of the new buffer tree node. Defaults to 'grab'.
+H:
+H: -o  One-shot mode: Stop grabbing if audio file changes.
 ---
 N: help
 D: display command list or help for given command