diff options
author | Alfred E. Heggestad <aeh@db.org> | 2015-06-17 23:17:18 +0200 |
---|---|---|
committer | Alfred E. Heggestad <aeh@db.org> | 2015-06-17 23:17:18 +0200 |
commit | 2023026a65c2cd425154999a3b7981c8b1b28985 (patch) | |
tree | fd59e0bdb74dfc1040e4ff8eba8464096d881a6a /modules/auloop | |
parent | 69d26555b437261be0d7e6c6337a4bc412c43988 (diff) |
module: updated documentation
Diffstat (limited to 'modules/auloop')
-rw-r--r-- | modules/auloop/auloop.c | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/modules/auloop/auloop.c b/modules/auloop/auloop.c index b432da9..c87b060 100644 --- a/modules/auloop/auloop.c +++ b/modules/auloop/auloop.c @@ -1,7 +1,7 @@ /** * @file auloop.c Audio loop * - * Copyright (C) 2010 Creytiv.com + * Copyright (C) 2010 - 2015 Creytiv.com */ #include <string.h> #include <re.h> @@ -9,6 +9,23 @@ #include <baresip.h> +/** + * @defgroup auloop auloop + * + * Application module for testing audio drivers + * + * The audio loop will connect the AUSRC device to the AUPLAY device + * so that a local loopback audio can be heard. Different audio parameters + * can be tested, such as sampling rate and number of channels. + * + * The following commands are available: + \verbatim + a Start audio-loop + A Stop audio-loop + \endverbatim + */ + + /* Configurable items */ #define PTIME 20 |