rename "synopsis" to "usage".
[paraslash.git] / audiod.cmd
1 FN: audiod_command_list
2 HC: prototypes for the audiod command handlers
3 CC: array of audiod commands
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 [grab_options]
17 H: grab ('splice') the audio stream at any position in the filter
18 H: chain and send that data back to the client. Try
19 H: para_audioc -- grab -h
20 H: for the list of available options.
21 ---
22 N: help
23 D: display command list or help for given command
24 U: help [command]
25 H: When I was younger, so much younger than today, I never needed anybody's help
26 H: in any way. But now these days are gone, I'm not so self assured. Now I find
27 H: I've changed my mind and opened up the doors.
28 H: -- Beatles: Help
29 ---
30 N: kill
31 D: kill an active audiod task
32 U: kill task_id [task_id ...]
33 H: call sched_unregister() and the event_handler of the given task(s)
34 ---
35 N: off
36 D: deactivate para_audiod
37 U: off
38 H: Close connection to para_server and stop all decoders.
39 ---
40 N: on
41 D: activate para_audiod
42 U: on
43 H: Establish connection to para_server, retrieve para_server's current status. If
44 H: playing, start corresponding decoder. Otherwise stop all decoders.
45 ---
46 N: sb
47 D: enter standby mode
48 U: sb
49 H: Stop all decoders but leave connection to para_server open.
50 ---
51 N: stat
52 D: print status information
53 U: stat [item1 ...]
54 H: Dump given status items (all if none given) to stdout.
55 ---
56 N: tasks
57 D: list current tasks
58 U: tasks
59 H: print the list of task ids together with the status of each task
60 ---
61 N: term
62 D: terminate audiod
63 U: term
64 H: Stop all decoders, shut down connection to para_server and exit.