mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-04 21:55:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: query doc improvements

Browse source 
More xrefs. Mentioned that some queries need a running pipeline.
This commit is contained in:
Stefan Kost 2010-11-19 15:06:05 +02:00
parent a4c5448eee
commit 898583b2a0
3 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
gst/gstelement.c
View file

@ -1648,6 +1648,8 @@ gst_element_default_query (GstElement * element, GstQuery * query)
* forwards the query to a random srcpad or to the peer of a * forwards the query to a random srcpad or to the peer of a
* random linked sinkpad of this element. * random linked sinkpad of this element.
* *
* Please note that some queries might need a running pipeline to work.
*
* Returns: TRUE if the query could be performed. * Returns: TRUE if the query could be performed.
* *
* MT safe. * MT safe.

9
gst/gstpad.c
View file

@ -3668,13 +3668,16 @@ no_iter:
* @query: the #GstQuery to perform. * @query: the #GstQuery to perform.
* *
* Dispatches a query to a pad. The query should have been allocated by the * Dispatches a query to a pad. The query should have been allocated by the
* caller via one of the type-specific allocation functions in gstquery.h. The * caller via one of the type-specific allocation functions. The element that
* element is responsible for filling the query with an appropriate response, * the pad belongs to is responsible for filling the query with an appropriate
* which should then be parsed with a type-specific query parsing function. * response, which should then be parsed with a type-specific query parsing
* function.
* *
* Again, the caller is responsible for both the allocation and deallocation of * Again, the caller is responsible for both the allocation and deallocation of
* the query structure. * the query structure.
* *
* Please also note that some queries might need a running pipeline to work.
*
* Returns: TRUE if the query could be performed. * Returns: TRUE if the query could be performed.
*/ */
gboolean gboolean

8
gst/gstquery.c
View file

@ -27,9 +27,11 @@
* to create queries, and to set and parse values in them. * to create queries, and to set and parse values in them.
* @see_also: #GstPad, #GstElement * @see_also: #GstPad, #GstElement
* *
* GstQuery functions are used to register a new query types to the gstreamer * GstQuery functions are used to register new query types to the gstreamer
* core. * core and use them.
* Query types can be used to perform queries on pads and elements. * Queries can be performed on pads (gst_pad_query()) and elements
* (gst_element_query()). Please note that some queries might need a running
* pipeline to work.
* *
* Queries can be created using the gst_query_new_*() functions. * Queries can be created using the gst_query_new_*() functions.
* Query values can be set using gst_query_set_*(), and parsed using * Query values can be set using gst_query_set_*(), and parsed using