blob: 7b74c3d242c7389f744b59a76eeaa4b06a1930f8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<h1>Documentation</h1>
<hr>
<p> Everything shown here corresponds to the current <tt>master</tt> branch
of the public git repository. </p>
<h2> General information </h2>
<p> If you are new to paraslash, start with the <a href="manual.html">user
manual</a>. It covers installation, configuration and basic usage. </p>
<h2> Manual pages </h2>
<p> Each executable has its own manual page. If the paraslash package is
already installed, the same information can be obtained by running a command
such as <tt>man para_server</tt>. </p>
<p>
[<a href="para_server.man.html">para_server</a>]
[<a href="para_audiod.man.html">para_audiod</a>]
[<a href="para_client.man.html">para_client</a>]
[<a href="para_audioc.man.html">para_audioc</a>]
[<a href="para_afh.man.html">para_afh</a>]
[<a href="para_recv.man.html">para_recv</a>]
[<a href="para_filter.man.html">para_filter</a>]
[<a href="para_write.man.html">para_write</a>]
[<a href="para_gui.man.html">para_gui</a>]
[<a href="para_mixer.man.html">para_mixer</a>]
[<a href="para_play.man.html">para_play</a>]
</p>
<h2> Source code documentation </h2>
<p> Only the non-static functions and variables are documented here. Not shown
are files related to the build system (makefiles and autoconf related files)
and the lopsub suite files which contain the descriptions of the command
line options. </p>
<h3> Subsystems </h3>
<p> To get started in a particular subsystem, follow the corresponding link
below. This selection is not exhaustive, though. </p>
<p>
[<a href="doxygen/html/sched_8h.html">Scheduler</a>]
[<a href="doxygen/html/afh_8h.html">Audio Format Handlers</a>]
[<a href="doxygen/html/afs_8h.html">Audio File Selector</a>]
[<a href="doxygen/html/vss_8h.html">Virtual Streaming System</a>]
[<a href="doxygen/html/send_8h.html">Senders</a>]
[<a href="doxygen/html/crypt_8h.html">Crypto API</a>]
[<a href="doxygen/html/buffer__tree_8h.html">Buffer Trees</a>]
[<a href="doxygen/html/fec_8h.html">Forward Error Correction</a>]
[<a href="doxygen/html/recv_8h.html">Receivers</a>]
[<a href="doxygen/html/filter_8h.html">Filters</a>]
[<a href="doxygen/html/write_8h.html">Writers</a>]
[<a href="doxygen/html/interactive_8h.html">Interactive Sessions</a>]
</p>
<h3> Executables </h3>
<p> The detailed description lists related source files and explains how
the program interacts with the functions defined there. The comment of the
main function describes the tasks which are registered to the paraslash
scheduler at startup. </p>
<p>
[<a href="doxygen/html/server_8c.html">para_server</a>]
[<a href="doxygen/html/audiod_8c.html">para_audiod</a>]
[<a href="doxygen/html/client_8c.html">para_client</a>]
[<a href="doxygen/html/audioc_8c.html">para_audioc</a>]
[<a href="doxygen/html/afh_8c.html">para_afh</a>]
[<a href="doxygen/html/recv_8c.html">para_recv</a>]
[<a href="doxygen/html/filter_8c.html">para_filter</a>]
[<a href="doxygen/html/write_8c.html">para_write</a>]
[<a href="doxygen/html/gui_8c.html">para_gui</a>]
[<a href="doxygen/html/mixer_8c.html">para_mixer</a>]
[<a href="doxygen/html/play_8c.html">para_play</a>]
</p>
<h3> Indices </h3>
<p>
[<a href="doxygen/html/classes.html">Data Structure Index</a>]
[<a href="doxygen/html/globals_enum.html">Enumerations</a>]
[<a href="doxygen/html/files.html">File List</a>]
[<a href="doxygen/html/globals_vars.html">Global Variables</a>]
</p>
|
