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 <!-- ##### SECTION Stability_Level ##### -->
  19
  20
  21 <!-- ##### ENUM GstFormat ##### -->
  22 <para>
  23 Standard predefined formats
  24 </para>
  25
  26 @GST_FORMAT_UNDEFINED: undefined format
  27 @GST_FORMAT_DEFAULT: the default format of the pad/element
  28 @GST_FORMAT_BYTES: bytes
  29 @GST_FORMAT_TIME: time in nanoseconds
  30 @GST_FORMAT_BUFFERS: buffers
  31 @GST_FORMAT_PERCENT: percentage of stream
  32
  33 <!-- ##### MACRO GST_FORMAT_PERCENT_MAX ##### -->
  34 <para>
  35 The PERCENT format is between 0 and this value
  36 </para>
  37
  38
  39
  40 <!-- ##### MACRO GST_FORMAT_PERCENT_SCALE ##### -->
  41 <para>
  42 The value used to scale down the reported PERCENT format value to
  43 its real value.
  44 </para>
  45
  46
  47
  48 <!-- ##### STRUCT GstFormatDefinition ##### -->
  49 <para>
  50 A format definition
  51 </para>
  52
  53 @value: The unique id of this format
  54 @nick: A short nick of the format
  55 @description: A longer description of the format
  56
  57 <!-- ##### FUNCTION gst_format_register ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @nick:
  63 @description:
  64 @Returns:
  65
  66
  67 <!-- ##### FUNCTION gst_format_get_by_nick ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @nick:
  73 @Returns:
  74
  75
  76 <!-- ##### FUNCTION gst_formats_contains ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @formats:
  82 @format:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION gst_format_get_details ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @format:
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gst_format_iterate_definitions ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @Returns:
 101
 102