|
Revision 249, 1.4 kB
(checked in by pieterpalmers, 17 years ago)
|
- Extensive documentation update.
|
| Line | |
|---|
| 1 |
/* |
|---|
| 2 |
* This is the main page of the FreeBoB reference manual, built using |
|---|
| 3 |
* doxygen. |
|---|
| 4 |
*/ |
|---|
| 5 |
|
|---|
| 6 |
/** |
|---|
| 7 |
@mainpage FreeBoB - Firewire (pro-)audio for Linux |
|---|
| 8 |
|
|---|
| 9 |
@author Pieter Palmers <pieterpalmers@users.sourceforge.net> |
|---|
| 10 |
|
|---|
| 11 |
@section intro Introduction |
|---|
| 12 |
|
|---|
| 13 |
FreeBoB is intended as an intermediate layer between the Linux1394 kernel/userspace layer, and the various audio API's (ALSA, jack, ...) present. |
|---|
| 14 |
|
|---|
| 15 |
\note this is a SVN version, therefore it is highly volatile. Certain parts of the documentation can be outdated. This documentation is also auto-generated, and it can occur that unused classes and interfaces appear in the documentation. This pollution will be cleaned up as we go along. |
|---|
| 16 |
|
|---|
| 17 |
@see <http://freebob.sourceforge.net> |
|---|
| 18 |
|
|---|
| 19 |
@section library Client side library |
|---|
| 20 |
|
|---|
| 21 |
FreeBoB presents an interface that can be used to implement backends for various audio |
|---|
| 22 |
API's. Currently the best support is for the JACK backend. It is also intended to implement configuration applications like mixer controls etc.. |
|---|
| 23 |
|
|---|
| 24 |
The library API is split in two parts: |
|---|
| 25 |
- @ref freebob.h "<libfreebob/freebob.h>" is the discovery & configuration interface |
|---|
| 26 |
- @ref freebob_streaming.h "<libfreebob/freebob_streaming.h>" is the streaming interface |
|---|
| 27 |
|
|---|
| 28 |
|
|---|
| 29 |
@section devicesupport Adding support for unsupported devices |
|---|
| 30 |
|
|---|
| 31 |
Initial support is/was for BeBoB devices only, however the framework |
|---|
| 32 |
is usable for all firewire audio devices. |
|---|
| 33 |
|
|---|
| 34 |
Take a look at the @ref adding_devices page for a detailed description. |
|---|
| 35 |
|
|---|
| 36 |
*/ |
|---|
