summaryrefslogtreecommitdiffstats
path: root/ext/pulse/pulsemixer.c
diff options
context:
space:
mode:
Diffstat (limited to 'ext/pulse/pulsemixer.c')
-rw-r--r--ext/pulse/pulsemixer.c19
1 files changed, 19 insertions, 0 deletions
diff --git a/ext/pulse/pulsemixer.c b/ext/pulse/pulsemixer.c
index e2957aa6..25e8631e 100644
--- a/ext/pulse/pulsemixer.c
+++ b/ext/pulse/pulsemixer.c
@@ -19,6 +19,25 @@
* USA.
*/
+/**
+ * SECTION:element-pulsemixer
+ * @short_description: Element to control sound input and output levels for the PulseAudio sound server
+ * @see_also: pulsesrc, pulsesink
+ *
+ * <refsect2>
+ * <para>
+ * This element lets you adjust sound input and output levels for the
+ * PulseAudio sound server. It supports the GstMixer interface, which can be
+ * used to obtain a list of available mixer tracks. Set the mixer element to
+ * READY state before using the GstMixer interface on it.
+ * </para>
+ * <title>Example pipelines</title>
+ * <para>
+ * pulsemixer can't be used in a sensible way in gst-launch.
+ * </para>
+ * </refsect2>
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif