Merge branch 'maint' into next
[paraslash.git] / audiod.cmd
index 2c6ea9b..94f3ca0 100644 (file)
@@ -14,11 +14,36 @@ H: on -> standby -> off -> on
 N: grab
 D: grab the audio stream
 L:
 N: grab
 D: grab the audio stream
 L:
-U: -- grab [grab_options]
+U: -- grab -[n=<num>] [-m[{s|p|a}]] [-i] [-o] [-f=<format>]
+H:
 H: grab ('splice') the audio stream at any position in the filter
 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.
+H: chain and send that data back to the client.
+H:
+H: Options:
+H:
+H: -n  Point of the filter chain to grab. Filters count from zero.
+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: -i  Grab the filter input instead of its output.
+H:
+H: -o  One-shot mode: Stop grabbing if audio file changes.
+H:
+H: -f  Only grab streams of this format (mp3, ogg, aac). The default is to
+H:     grab any stream.
+H:
 ---
 N: help
 D: display command list or help for given command
 ---
 N: help
 D: display command list or help for given command