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