mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 16:50:47 +00:00
7462cb8787
Original commit message from CVS: Documentation updates
103 lines
1.9 KiB
Text
103 lines
1.9 KiB
Text
<!-- ##### SECTION Title ##### -->
|
|
GstQuery
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Dynamically register new query types
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
GstQuery functions are used to register a new query types to the gstreamer core.
|
|
Query types can be used to perform queries on pads and elements.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
#GstPad, #GstElement
|
|
</para>
|
|
|
|
<!-- ##### ENUM GstQueryType ##### -->
|
|
<para>
|
|
Standard predefined Query types
|
|
</para>
|
|
|
|
@GST_QUERY_NONE: invalid query type
|
|
@GST_QUERY_TOTAL: total length of stream
|
|
@GST_QUERY_POSITION: current position in stream
|
|
@GST_QUERY_LATENCY: latency of stream
|
|
@GST_QUERY_JITTER: current jitter of stream
|
|
@GST_QUERY_START: start of configured segment
|
|
@GST_QUERY_SEGMENT_END: end of configured segment
|
|
@GST_QUERY_RATE: current rate of the stream
|
|
|
|
<!-- ##### MACRO GST_QUERY_TYPE_RATE_DEN ##### -->
|
|
<para>
|
|
Rates are relative to this value
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GstQueryTypeDefinition ##### -->
|
|
<para>
|
|
A Query Type definition
|
|
</para>
|
|
|
|
@value: the unique id of the Query type
|
|
@nick: a short nick
|
|
@description: a longer description of the query type
|
|
|
|
<!-- ##### MACRO GST_QUERY_TYPE_FUNCTION ##### -->
|
|
<para>
|
|
Convenience function to define a function that returns an array of query types.
|
|
</para>
|
|
|
|
@type: Type of first argument for function
|
|
@functionname: The name of the function
|
|
@...: query types, 0 to end the list
|
|
|
|
|
|
<!-- ##### FUNCTION gst_query_type_register ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@nick:
|
|
@description:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_query_type_get_by_nick ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@nick:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_query_types_contains ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@types:
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_query_type_get_details ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gst_query_type_get_definitions ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|