audioconvert: document passing an empty mix-matrix
authorMathieu Duponchelle <mathieu@centricular.com>
Thu, 26 Oct 2017 16:05:31 +0000 (18:05 +0200)
committerMathieu Duponchelle <mathieu@centricular.com>
Thu, 26 Oct 2017 16:05:46 +0000 (18:05 +0200)
gst/audioconvert/gstaudioconvert.c

index fa3d024..1f84917 100644 (file)
  *
  * > If an empty mix matrix is specified, a (potentially truncated)
  * > identity matrix will be generated.
+ *
+ * ## Example empty matrix generation code
+ * |[
+ * GValue v = G_VALUE_INIT;
+ *
+ * g_value_init (&v2, GST_TYPE_ARRAY);
+ * g_object_set_property (G_OBJECT (audioconvert), "mix-matrix", &v);
+ * g_value_unset (&v);
+ * ]|
+ *
+ * ## Example empty matrix launch line
+ * |[
+ * gst-launch-1.0 -v audiotestsrc ! audio/x-raw,channels=8 ! audioconvert mix-matrix="<>" ! audio/x-raw,channels=16,channel-mask=\(bitmask\)0x0000000000000000 ! fakesink
+ * ]|
  */
 
 /*