paraslash Paraslash Audio Streaming
About   News   Download   Documentation   Development

Documentation


Everything shown here corresponds to the current master branch of the public git repository.

General information

If you are new to paraslash, start with the user manual. It covers installation, configuration and basic usage.

Manual pages

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 man para_server.

[para_server] [para_audiod] [para_client] [para_audioc] [para_afh] [para_recv] [para_filter] [para_write] [para_gui] [para_mixer] [para_play]

Source code documentation

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.

Subsystems

To get started in a particular subsystem, follow the corresponding link below. This selection is not exhaustive, though.

[Scheduler] [Audio Format Handlers] [Audio File Selector] [Virtual Streaming System] [Senders] [Crypto API] [Buffer Trees] [Forward Error Correction] [Receivers] [Filters] [Writers] [Interactive Sessions]

Executables

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.

[para_server] [para_audiod] [para_client] [para_audioc] [para_afh] [para_recv] [para_filter] [para_write] [para_gui] [para_mixer] [para_play]

Indices

[Data Structure Index] [Enumerations] [File List] [Global Variables]