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