docs/gst/tmpl/gstformat.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstFormat
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Dynamically register new formats
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 GstFormats functions are used to register a new format to the gstreamer core.
  10 formats can be used to perform seeking or conversions/query operations.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15 #GstPad, #GstElement
  16 </para>
  17
  18 <!-- ##### ENUM GstFormat ##### -->
  19 <para>
  20 Standard predefined formats
  21 </para>
  22
  23 @GST_FORMAT_UNDEFINED: undefined format
  24 @GST_FORMAT_DEFAULT: the default format of the pad/element
  25 @GST_FORMAT_BYTES: bytes
  26 @GST_FORMAT_TIME: time in nanoseconds
  27 @GST_FORMAT_BUFFERS: buffers
  28 @GST_FORMAT_PERCENT: percentage of stream
  29
  30 <!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
  31 <para>
  32 The PERCENT format is between 0 and this value
  33 </para>
  34
  35
  36
  37 <!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
  38 <para>
  39 The value used to scale down the reported PERCENT format value to
  40 its real value.
  41 </para>
  42
  43
  44
  45 <!-- ##### STRUCT GstFormatDefinition ##### -->
  46 <para>
  47 A format definition
  48 </para>
  49
  50 @value: The unique id of this format
  51 @nick: A short nick of the format
  52 @description: A longer description of the format
  53
  54 <!-- ##### MACRO GST_FORMATS_FUNCTION ##### -->
  55 <para>
  56 A convenience function to define a function that returns an array
  57 of formats.
  58 </para>
  59
  60 @type: The type of the first argument of the function
  61 @functionname: The name of the function
  62 @...: comma separated list of functions closed with 0
  63
  64
  65 <!-- ##### FUNCTION gst_format_register ##### -->
  66 <para>
  67
  68 </para>
  69
  70 @nick:
  71 @description:
  72 @Returns:
  73
  74
  75 <!-- ##### FUNCTION gst_format_get_by_nick ##### -->
  76 <para>
  77
  78 </para>
  79
  80 @nick:
  81 @Returns:
  82
  83
  84 <!-- ##### FUNCTION gst_formats_contains ##### -->
  85 <para>
  86
  87 </para>
  88
  89 @formats:
  90 @format:
  91 @Returns:
  92
  93
  94 <!-- ##### FUNCTION gst_format_get_details ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @format:
 100 @Returns:
 101
 102
 103 <!-- ##### FUNCTION gst_format_get_definitions ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @Returns:
 109
 110