audiomixer: Document the pad properties
authorNirbheek Chauhan <nirbheek@centricular.com>
Sat, 27 Dec 2014 10:19:39 +0000 (15:49 +0530)
committerTim-Philipp Müller <tim@centricular.com>
Sat, 27 Dec 2014 11:02:36 +0000 (11:02 +0000)
gst/audiomixer/gstaudiomixer.c

index 35e6cc0..48ef528 100644 (file)
  * The audiomixer currently mixes all data received on the sinkpads as soon as
  * possible without trying to synchronize the streams.
  *
+ * The input pads are from a GstPad subclass and have additional
+ * properties to mute each pad individually and set the volume:
+ *
+ * <itemizedlist>
+ * <listitem>
+ * "mute": Whether to mute the pad or not (#gboolean)
+ * </listitem>
+ * <listitem>
+ * "volume": The volume of the pad, between 0.0 and 10.0 (#gdouble)
+ * </listitem>
+ * </itemizedlist>
+ *
  * <refsect2>
  * <title>Example launch line</title>
  * |[