docs/libs/html/gst-plugins-base-libs-gstpbutils.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>gstpbutils</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-base-utils.html" title="Base Utils Library">
   9 <link rel="prev" href="gstreamer-base-utils.html" title="Base Utils Library">
  10 <link rel="next" href="gst-plugins-base-libs-gstpluginsbaseversion.html" title="gstpluginsbaseversion">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gstreamer-base-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-base-utils.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-libs-gstpluginsbaseversion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-libs-gstpbutils.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-libs-gstpbutils.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-base-libs-gstpbutils"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-base-libs-gstpbutils.top_of_page"></a>gstpbutils</span></h2>
  34 <p>gstpbutils — General Application and Plugin Utility Library</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-base-libs-gstpbutils.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/pbutils/pbutils.h&gt;
  42
  43 <span class="returnvalue">void</span>                <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()">gst_pb_utils_init</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
  44 </pre>
  45 </div>
  46 <div class="refsect1">
  47 <a name="gst-plugins-base-libs-gstpbutils.description"></a><h2>Description</h2>
  48 <p>
  49 </p>
  50 <div class="refsect2">
  51 <a name="idp7121744"></a><h3>Linking to this library</h3>
  52 <p>
  53 libgstpbutils is a general utility library for plugins and applications,
  54 available since gst-plugins-base 0.10.12. It currently provides the
  55 following:
  56 </p>
  57 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  58 <li class="listitem"><p>
  59 human-readable description strings of codecs, elements, sources, decoders,
  60 encoders, or sinks from decoder/encoder caps, element names, or protocol
  61 names.
  62 </p></li>
  63 <li class="listitem"><p>
  64 support for applications to initiate installation of missing plugins (if
  65 this is supported by the distribution or operating system used)
  66 </p></li>
  67 <li class="listitem"><p>
  68 API for GStreamer elements to create missing-plugin messages in order to
  69 communicate to the application that a certain type of plugin is missing
  70 (decoder, encoder, URI protocol source, URI protocol sink, named element)
  71 </p></li>
  72 <li class="listitem"><p>
  73 API for applications to recognise and handle missing-plugin messages
  74 </p></li>
  75 </ul></div>
  76 <p>
  77 You should obtain the required CFLAGS and LIBS using pkg-config on the
  78 gstreamer-plugins-base-0.10 module. You will then also need to add
  79 '-lgstpbutils-0.10' manually to your LIBS line.
  80 </p>
  81 <p>
  82 Before using any of its functions, applications and plugins must call
  83 <a class="link" href="gst-plugins-base-libs-gstpbutils.html#gst-pb-utils-init" title="gst_pb_utils_init ()"><code class="function">gst_pb_utils_init()</code></a> to initialise the library.
  84 </p>
  85 </div>
  86 <p>
  87 </p>
  88 </div>
  89 <div class="refsect1">
  90 <a name="gst-plugins-base-libs-gstpbutils.details"></a><h2>Details</h2>
  91 <div class="refsect2">
  92 <a name="gst-pb-utils-init"></a><h3>gst_pb_utils_init ()</h3>
  93 <pre class="programlisting"><span class="returnvalue">void</span>                gst_pb_utils_init                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  94 <p>
  95 Initialises the base utils support library. This function is not
  96 thread-safe. Applications should call it after calling <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-Gst.html#gst-init"><code class="function">gst_init()</code></a>,
  97 plugins should call it from their plugin_init function.
  98 </p>
  99 <p>
 100 This function may be called multiple times. It will do nothing if the
 101 library has already been initialised.
 102 </p>
 103 <p class="since">Since 0.10.12</p>
 104 </div>
 105 </div>
 106 </div>
 107 <div class="footer">
 108 <hr>
 109           Generated by GTK-Doc V1.18</div>
 110 </body>
 111 </html>