summaryrefslogtreecommitdiff
path: root/modules/aubridge/aubridge.c
diff options
context:
space:
mode:
Diffstat (limited to 'modules/aubridge/aubridge.c')
-rw-r--r--modules/aubridge/aubridge.c20
1 files changed, 19 insertions, 1 deletions
diff --git a/modules/aubridge/aubridge.c b/modules/aubridge/aubridge.c
index 421d903..f1fcfa3 100644
--- a/modules/aubridge/aubridge.c
+++ b/modules/aubridge/aubridge.c
@@ -1,13 +1,31 @@
/**
* @file aubridge.c Audio bridge
*
- * Copyright (C) 2010 Creytiv.com
+ * Copyright (C) 2010 - 2015 Creytiv.com
*/
#include <re.h>
#include <baresip.h>
#include "aubridge.h"
+/**
+ * @defgroup aubridge aubridge
+ *
+ * Audio bridge module
+ *
+ * This module can be used to connect two audio devices together,
+ * so that all output to AUPLAY device is bridged as the input to
+ * a AUSRC device.
+ *
+ * Sample config:
+ *
+ \verbatim
+ audio_player aubridge,pseudo0
+ audio_source aubridge,pseudo0
+ \endverbatim
+ */
+
+
static struct ausrc *ausrc;
static struct auplay *auplay;