docs/gst/tmpl/gstquery.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstQuery
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Dynamically register new query types
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GstQuery functions are used to register a new query types to the gstreamer core.
  10 Query types can be used to perform queries on pads and elements.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15 #GstPad, #GstElement
  16 </para>
  17
  18 <!-- ##### ENUM GstQueryType ##### -->
  19 <para>
  20 Standard predefined Query types
  21 </para>
  22
  23 @GST_QUERY_NONE: invalid query type
  24 @GST_QUERY_POSITION: current position in stream
  25 @GST_QUERY_LATENCY: latency of stream
  26 @GST_QUERY_JITTER: current jitter of stream
  27 @GST_QUERY_RATE: current rate of the stream
  28 @GST_QUERY_SEEKING:
  29 @GST_QUERY_CONVERT:
  30 @GST_QUERY_FORMATS:
  31
  32 <!-- ##### MACRO GST_QUERY_TYPE_RATE_DEN ##### -->
  33 <para>
  34 Rates are relative to this value
  35 </para>
  36
  37
  38
  39 <!-- ##### STRUCT GstQueryTypeDefinition ##### -->
  40 <para>
  41 A Query Type definition
  42 </para>
  43
  44 @value: the unique id of the Query type
  45 @nick: a short nick
  46 @description: a longer description of the query type
  47
  48 <!-- ##### MACRO GST_QUERY_TYPE_FUNCTION ##### -->
  49 <para>
  50 Convenience function to define a function that returns an array of query types.
  51 </para>
  52
  53 @type: Type of first argument for function
  54 @functionname: The name of the function
  55 @...: query types, 0 to end the list
  56
  57
  58 <!-- ##### FUNCTION gst_query_type_register ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @nick:
  64 @description:
  65 @Returns:
  66
  67
  68 <!-- ##### FUNCTION gst_query_type_get_by_nick ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @nick:
  74 @Returns:
  75
  76
  77 <!-- ##### FUNCTION gst_query_types_contains ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @types:
  83 @type:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION gst_query_type_get_details ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @type:
  93 @Returns:
  94 <!-- # Unused Parameters # -->
  95 @Param1:
  96
  97