summaryrefslogtreecommitdiff
path: root/gst/gstquery.c
diff options
context:
space:
mode:
authorWim Taymans <wim.taymans@collabora.co.uk>2012-06-06 09:15:04 +0200
committerWim Taymans <wim.taymans@collabora.co.uk>2012-06-06 09:15:04 +0200
commit15d85b9edb13f89475dba3269c1a7e0027b39b5c (patch)
treec1bf2979052ff7df084a1e5b829e7fca64344d2f /gst/gstquery.c
parentd907544ab12ebbed5bc9c51fa0858e39e4cddebb (diff)
downloadgstreamer-15d85b9edb13f89475dba3269c1a7e0027b39b5c.tar.gz
query: improve docs
Diffstat (limited to 'gst/gstquery.c')
-rw-r--r--gst/gstquery.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/gst/gstquery.c b/gst/gstquery.c
index 4aaa17e93d..5fadc9deb7 100644
--- a/gst/gstquery.c
+++ b/gst/gstquery.c
@@ -2197,7 +2197,7 @@ gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
*
* Constructs a new query object for querying the caps.
*
- * The CAPS query should return the* allowable caps for a pad in the context
+ * The CAPS query should return the allowable caps for a pad in the context
* of the element's state, its link to other elements, and the devices or files
* it has opened. These caps must be a subset of the pad template caps. In the
* NULL state with no links, the CAPS query should ideally return the same caps
@@ -2210,6 +2210,10 @@ gst_query_parse_accept_caps_result (GstQuery * query, gboolean * result)
* the CAPS query should return the most specific caps it reasonably can, since this
* helps with autoplugging.
*
+ * The @filter is used to restrict the result caps, only the caps matching
+ * @filter should be returned from the CAPS query. Specifying a filter might
+ * greatly reduce the amount of processing an element needs to do.
+ *
* Free-function: gst_query_unref
*
* Returns: (transfer full): a new #GstQuery