docs/libs/html/gstreamer-libs-GstStreamConsistency.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>GstStreamConsistency</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-check.html" title="GStreamer Check Unit Testing">
   9 <link rel="prev" href="gstreamer-libs-GstBufferStraw.html" title="GstBufferStraw">
  10 <link rel="next" href="gstreamer-hierarchy.html" title="Object Hierarchy">
  11 <meta name="generator" content="GTK-Doc V1.17 (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-libs-GstBufferStraw.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-check.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 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="gstreamer-hierarchy.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="#gstreamer-libs-GstStreamConsistency.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-libs-GstStreamConsistency.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gstreamer-libs-GstStreamConsistency"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gstreamer-libs-GstStreamConsistency.top_of_page"></a>GstStreamConsistency</span></h2>
  34 <p>GstStreamConsistency — Data flow consistency checker for GStreamer unit tests.</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gstreamer-libs-GstStreamConsistency.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">
  41 #include &lt;gst/check/gstconsistencychecker.h&gt;
  42
  43                     <a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency">GstStreamConsistency</a>;
  44 <a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="returnvalue">GstStreamConsistency</span></a> *  <a class="link" href="gstreamer-libs-GstStreamConsistency.html#gst-consistency-checker-new" title="gst_consistency_checker_new ()">gst_consistency_checker_new</a>     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);
  45 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstStreamConsistency.html#gst-consistency-checker-reset" title="gst_consistency_checker_reset ()">gst_consistency_checker_reset</a>       (<em class="parameter"><code><a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> *consist</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="gstreamer-libs-GstStreamConsistency.html#gst-consistency-checker-free" title="gst_consistency_checker_free ()">gst_consistency_checker_free</a>        (<em class="parameter"><code><a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> *consist</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gstreamer-libs-GstStreamConsistency.description"></a><h2>Description</h2>
  51 <p>
  52 These macros and functions are for internal use of the unit tests found
  53 inside the 'check' directories of various GStreamer packages.
  54 </p>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gstreamer-libs-GstStreamConsistency.details"></a><h2>Details</h2>
  58 <div class="refsect2">
  59 <a name="GstStreamConsistency"></a><h3>GstStreamConsistency</h3>
  60 <pre class="programlisting">typedef struct _GstStreamConsistency GstStreamConsistency;</pre>
  61 <p>
  62 Opaque consistency checker handle.
  63 </p>
  64 <p class="since">Since 0.10.24</p>
  65 </div>
  66 <hr>
  67 <div class="refsect2">
  68 <a name="gst-consistency-checker-new"></a><h3>gst_consistency_checker_new ()</h3>
  69 <pre class="programlisting"><a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="returnvalue">GstStreamConsistency</span></a> *  gst_consistency_checker_new     (<em class="parameter"><code><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> *pad</code></em>);</pre>
  70 <p>
  71 Sets up a data probe on the given pad which will raise assertions if the
  72 data flow is inconsistent.
  73 </p>
  74 <p>
  75 Currently only works for source pads.
  76 </p>
  77 <div class="variablelist"><table border="0">
  78 <col align="left" valign="top">
  79 <tbody>
  80 <tr>
  81 <td><p><span class="term"><em class="parameter"><code>pad</code></em> :</span></p></td>
  82 <td>The <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPad.html"><span class="type">GstPad</span></a> on which the dataflow will be checked.</td>
  83 </tr>
  84 <tr>
  85 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  86 <td>A <a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> structure used to track data flow.</td>
  87 </tr>
  88 </tbody>
  89 </table></div>
  90 <p class="since">Since 0.10.24</p>
  91 </div>
  92 <hr>
  93 <div class="refsect2">
  94 <a name="gst-consistency-checker-reset"></a><h3>gst_consistency_checker_reset ()</h3>
  95 <pre class="programlisting"><span class="returnvalue">void</span>                gst_consistency_checker_reset       (<em class="parameter"><code><a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> *consist</code></em>);</pre>
  96 <p>
  97 Reset the stream checker's internal variables.
  98 </p>
  99 <div class="variablelist"><table border="0">
 100 <col align="left" valign="top">
 101 <tbody><tr>
 102 <td><p><span class="term"><em class="parameter"><code>consist</code></em> :</span></p></td>
 103 <td>The <a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> to reset.</td>
 104 </tr></tbody>
 105 </table></div>
 106 <p class="since">Since 0.10.24</p>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="gst-consistency-checker-free"></a><h3>gst_consistency_checker_free ()</h3>
 111 <pre class="programlisting"><span class="returnvalue">void</span>                gst_consistency_checker_free        (<em class="parameter"><code><a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> *consist</code></em>);</pre>
 112 <p>
 113 Frees the allocated data and probe associated with <em class="parameter"><code>consist</code></em>.
 114 </p>
 115 <div class="variablelist"><table border="0">
 116 <col align="left" valign="top">
 117 <tbody><tr>
 118 <td><p><span class="term"><em class="parameter"><code>consist</code></em> :</span></p></td>
 119 <td>The <a class="link" href="gstreamer-libs-GstStreamConsistency.html#GstStreamConsistency" title="GstStreamConsistency"><span class="type">GstStreamConsistency</span></a> to free.</td>
 120 </tr></tbody>
 121 </table></div>
 122 <p class="since">Since 0.10.24</p>
 123 </div>
 124 </div>
 125 </div>
 126 <div class="footer">
 127 <hr>
 128           Generated by GTK-Doc V1.17</div>
 129 </body>
 130 </html>