summaryrefslogtreecommitdiff
path: root/gst/gstvalue.h
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.net>2006-08-14 12:35:06 +0000
committerTim-Philipp Müller <tim@centricular.net>2006-08-14 12:35:06 +0000
commit5f0bc06ae154ef3cff8b8517b7fbe5b187bcf65a (patch)
tree22c4cf280847f720b71717a5d033b426465b619c /gst/gstvalue.h
parentf85c2fd84dcd2d5e886fab7aac521cb57928a0a1 (diff)
gst/gststructure.c: Fix typo in docs and re-wrap docs blurb to not exceed 80 chars/line.
Original commit message from CVS: * gst/gststructure.c: Fix typo in docs and re-wrap docs blurb to not exceed 80 chars/line. * gst/gstvalue.h: Expand on the difference between arrays and lists as we use them.
Diffstat (limited to 'gst/gstvalue.h')
-rw-r--r--gst/gstvalue.h13
1 files changed, 11 insertions, 2 deletions
diff --git a/gst/gstvalue.h b/gst/gstvalue.h
index 4a19f0dba..f6b59d9b4 100644
--- a/gst/gstvalue.h
+++ b/gst/gstvalue.h
@@ -203,7 +203,11 @@ G_BEGIN_DECLS
/**
* GST_TYPE_LIST:
*
- * a #GValue type that represents an unordered list of #GValue values
+ * a #GValue type that represents an unordered list of #GValue values. This
+ * is used for example to express a list of possible values for a field in
+ * a caps structure, like a list of possible sample rates, of which only one
+ * will be chosen in the end. This means that all values in the list are
+ * meaningful on their own.
*
* Returns: the #GType of GstValueList (which is not explicitly typed)
*/
@@ -212,7 +216,12 @@ G_BEGIN_DECLS
/**
* GST_TYPE_ARRAY:
*
- * a #GValue type that represents an ordered list of #GValue values
+ * a #GValue type that represents an ordered list of #GValue values. This is
+ * used to express a set of values that is meaningful only in their specific
+ * combination and order of values. Each value on its own is not particularly
+ * meaningful, only the ordered array in its entirety is meaningful. This is
+ * used for example to express channel layouts for multichannel audio where
+ * each channel needs to be mapped to a position in the room.
*
* Returns: the #GType of GstArrayList (which is not explicitly typed)
*/