| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GstBufferStraw: GStreamer 1.0 Library Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual"> |
| <link rel="up" href="gstreamer-check.html" title="GStreamer Check Unit Testing"> |
| <link rel="prev" href="gstreamer-libs-GstCheck.html" title="GstCheck"> |
| <link rel="next" href="gstreamer-libs-GstStreamConsistency.html" title="GstStreamConsistency"> |
| <meta name="generator" content="GTK-Doc V1.25 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#gstreamer-libs-GstBufferStraw.description" class="shortcut">Description</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="gstreamer-check.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="gstreamer-libs-GstCheck.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="gstreamer-libs-GstStreamConsistency.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="gstreamer-libs-GstBufferStraw"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="gstreamer-libs-GstBufferStraw.top_of_page"></a>GstBufferStraw</span></h2> |
| <p>GstBufferStraw — Buffer interception code for GStreamer unit tests</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="gstreamer-libs-GstBufferStraw.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()">gst_buffer_straw_start_pipeline</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-get-buffer" title="gst_buffer_straw_get_buffer ()">gst_buffer_straw_get_buffer</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <span class="returnvalue">void</span> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-stop-pipeline" title="gst_buffer_straw_stop_pipeline ()">gst_buffer_straw_stop_pipeline</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-libs-GstBufferStraw.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gst/check/gstbufferstraw.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-libs-GstBufferStraw.description"></a><h2>Description</h2> |
| <p>These macros and functions are for internal use of the unit tests found |
| inside the 'check' directories of various GStreamer packages.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-libs-GstBufferStraw.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="gst-buffer-straw-start-pipeline"></a><h3>gst_buffer_straw_start_pipeline ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| gst_buffer_straw_start_pipeline (<em class="parameter"><code><a href="../html/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *bin</code></em>, |
| <em class="parameter"><code><a href="../html/GstPad.html#GstPad-struct"><span class="type">GstPad</span></a> *pad</code></em>);</pre> |
| <p>Sets up a pipeline for buffer sucking. This will allow you to call |
| <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-get-buffer" title="gst_buffer_straw_get_buffer ()"><code class="function">gst_buffer_straw_get_buffer()</code></a> to access buffers as they pass over <em class="parameter"><code>pad</code></em> |
| .</p> |
| <p>This function is normally used in unit tests that want to verify that a |
| particular element is outputting correct buffers. For example, you would make |
| a pipeline via <a href="../html/gstreamer-GstParse.html#gst-parse-launch"><code class="function">gst_parse_launch()</code></a>, pull out the pad you want to monitor, then |
| call <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-get-buffer" title="gst_buffer_straw_get_buffer ()"><code class="function">gst_buffer_straw_get_buffer()</code></a> to get the buffers that pass through <em class="parameter"><code>pad</code></em> |
| . |
| The pipeline will block until you have sucked off the buffers.</p> |
| <p>This function will set the state of <em class="parameter"><code>bin</code></em> |
| to PLAYING; to clean up, be sure to |
| call <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-stop-pipeline" title="gst_buffer_straw_stop_pipeline ()"><code class="function">gst_buffer_straw_stop_pipeline()</code></a>.</p> |
| <p>Note that you may not start two buffer straws at the same time. This function |
| is intended for unit tests, not general API use. In fact it calls fail_if |
| from libcheck, so you cannot use it outside unit tests.</p> |
| <div class="refsect3"> |
| <a name="gst-buffer-straw-start-pipeline.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>bin</p></td> |
| <td class="parameter_description"><p>the pipeline to run</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>pad</p></td> |
| <td class="parameter_description"><p>a pad on an element in <em class="parameter"><code>bin</code></em> |
| </p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-buffer-straw-get-buffer"></a><h3>gst_buffer_straw_get_buffer ()</h3> |
| <pre class="programlisting"><a href="../html/GstBuffer.html#GstBuffer-struct"><span class="returnvalue">GstBuffer</span></a> * |
| gst_buffer_straw_get_buffer (<em class="parameter"><code><a href="../html/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *bin</code></em>, |
| <em class="parameter"><code><a href="../html/GstPad.html#GstPad-struct"><span class="type">GstPad</span></a> *pad</code></em>);</pre> |
| <p>Get one buffer from <em class="parameter"><code>pad</code></em> |
| . Implemented via buffer probes. This function will |
| block until the pipeline passes a buffer over <em class="parameter"><code>pad</code></em> |
| , so for robust behavior |
| in unit tests, you need to use check's timeout to fail out in the case that a |
| buffer never arrives.</p> |
| <p>You must have previously called <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a> on |
| <em class="parameter"><code>pipeline</code></em> |
| and <em class="parameter"><code>pad</code></em> |
| .</p> |
| <div class="refsect3"> |
| <a name="gst-buffer-straw-get-buffer.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>bin</p></td> |
| <td class="parameter_description"><p>the pipeline previously started via <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>pad</p></td> |
| <td class="parameter_description"><p>the pad previously passed to <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="gst-buffer-straw-get-buffer.returns"></a><h4>Returns</h4> |
| <p> the captured <a href="../html/GstBuffer.html#GstBuffer-struct"><span class="type">GstBuffer</span></a>.</p> |
| </div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="gst-buffer-straw-stop-pipeline"></a><h3>gst_buffer_straw_stop_pipeline ()</h3> |
| <pre class="programlisting"><span class="returnvalue">void</span> |
| gst_buffer_straw_stop_pipeline (<em class="parameter"><code><a href="../html/GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *bin</code></em>, |
| <em class="parameter"><code><a href="../html/GstPad.html#GstPad-struct"><span class="type">GstPad</span></a> *pad</code></em>);</pre> |
| <p>Set <em class="parameter"><code>bin</code></em> |
| to <a href="../html/GstElement.html#GST-STATE-NULL:CAPS"><span class="type">GST_STATE_NULL</span></a> and release resource allocated in |
| <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a>.</p> |
| <p>You must have previously called <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a> on |
| <em class="parameter"><code>pipeline</code></em> |
| and <em class="parameter"><code>pad</code></em> |
| .</p> |
| <div class="refsect3"> |
| <a name="gst-buffer-straw-stop-pipeline.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>bin</p></td> |
| <td class="parameter_description"><p>the pipeline previously started via <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>pad</p></td> |
| <td class="parameter_description"><p>the pad previously passed to <a class="link" href="gstreamer-libs-GstBufferStraw.html#gst-buffer-straw-start-pipeline" title="gst_buffer_straw_start_pipeline ()"><code class="function">gst_buffer_straw_start_pipeline()</code></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gstreamer-libs-GstBufferStraw.other_details"></a><h2>Types and Values</h2> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25</div> |
| </body> |
| </html> |
