From: Wim Taymans Date: Wed, 6 Jun 2012 07:15:04 +0000 (+0200) Subject: query: improve docs X-Git-Tag: RELEASE-0.11.92~13 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=15d85b9edb13f89475dba3269c1a7e0027b39b5c;p=platform%2Fupstream%2Fgstreamer.git query: improve docs --- diff --git a/gst/gstquery.c b/gst/gstquery.c index 4aaa17e..5fadc9d 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