Merge branch 't/command_util_cleanups'
[paraslash.git] / audiod.cmd
1 BN: audiod
2 SF: audiod_command.c
3 SN: list of audiod commands
4 ---
5 N: cycle
6 D: switch to next mode
7 U: cycle
8 H: on -> standby -> off -> on
9 ---
10 N: grab
11 D: grab the audio stream
12 L:
13 U: -- grab [-m[{s|p|a}]] [-p=PARENT] [-n=NAME] [-o]
14 H:
15 H: grab ('splice') the audio stream at any position in the buffer
16 H: tree and send that data back to the client.
17 H:
18 H: Options:
19 H:
20 H: -m Change grab mode. Defaults to sloppy grab if not given.
21 H:
22 H: -ms: sloppy grab
23 H:
24 H: -mp: pedantic grab
25 H:
26 H: -ma: aggressive grab
27 H:
28 H: The various grab modes only differ in what happens if the
29 H: file descriptor to write the grabbed audio data to is not
30 H: ready for writing (i.e. would block). Sloppy mode ignores
31 H: the write, pedantic mode aborts and aggressive mode tries
32 H: to write anyway.
33 H:
34 H: -p Grab output of node PARENT of the buffer tree.
35 H:
36 H: -n Name of the new buffer tree node. Defaults to 'grab'.
37 H:
38 H: -o One-shot mode: Stop grabbing if audio file changes.
39 ---
40 N: help
41 D: display command list or help for given command
42 U: help [command]
43 H: When I was younger, so much younger than today, I never needed anybody's help
44 H: in any way. But now these days are gone, I'm not so self assured. Now I find
45 H: I've changed my mind and opened up the doors.
46 H: -- Beatles: Help
47 ---
48 N: off
49 D: deactivate para_audiod
50 U: off
51 H: Close connection to para_server and stop all decoders.
52 ---
53 N: on
54 D: activate para_audiod
55 U: on
56 H: Establish connection to para_server, retrieve para_server's current status. If
57 H: playing, start corresponding decoder. Otherwise stop all decoders.
58 ---
59 N: sb
60 D: enter standby mode
61 U: sb
62 H: Stop all decoders but leave connection to para_server open.
63 ---
64 N: stat
65 D: print status information
66 U: stat [-p] [item1 ...]
67 H: Dump given status items (all if none given) to stdout. If -p is given, use
68 H: parser-friendly mode.
69 ---
70 N: tasks
71 D: list current tasks
72 U: tasks
73 H: print the list of task ids together with the status of each task
74 ---
75 N: term
76 D: terminate audiod
77 U: term
78 H: Stop all decoders, shut down connection to para_server and exit.