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