docs/gst/tmpl/gsttypefactory.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstTypeFactory
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Add types to plugins.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A GstTypeFactory is used to add a new type and a typedetection function
  10 to a plugin.
  11 </para>
  12
  13 <!-- ##### SECTION See_Also ##### -->
  14 <para>
  15 #GstPluginFeature
  16 </para>
  17
  18 <!-- ##### STRUCT GstTypeFactory ##### -->
  19 <para>
  20 The struct with the typefactory information.
  21 </para>
  22
  23 @feature:
  24 @mime:
  25 @exts:
  26 @typefindfunc:
  27
  28 <!-- ##### STRUCT GstTypeDefinition ##### -->
  29 <para>
  30
  31 </para>
  32
  33 @name: The name of this factory
  34 @mime: The mime type of the new type.
  35 @exts: The extensions of this type.
  36 @typefindfunc: An optional typefind function.
  37
  38 <!-- ##### USER_FUNCTION GstTypeFindFunc ##### -->
  39 <para>
  40 This is the function that will be called when a typefind has to be
  41 performed by a plugin.
  42 </para>
  43
  44 @buf: the buffer with media on which to perform the typefind
  45 @priv: private; don't touch
  46 @Returns: A #GstCaps structure describing the type or NULL if the
  47           type was not recognized by this function;
  48
  49
  50 <!-- ##### FUNCTION gst_typefactory_new ##### -->
  51 <para>
  52
  53 </para>
  54
  55 @definition:
  56 @Returns:
  57
  58
  59 <!-- ##### FUNCTION gst_typefactory_find ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @name:
  65 @Returns:
  66
  67