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