<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>gstreamermm: Gst::EventBufferSize Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceGst.html">Gst</a>::<a class="el" href="classGst_1_1EventBufferSize.html">EventBufferSize</a> </div> </div> <div class="contents"> <h1>Gst::EventBufferSize Class Reference</h1><!-- doxytag: class="Gst::EventBufferSize" --><!-- doxytag: inherits="Gst::Event" --> <p>A buffer size event. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGst_1_1Event.html">Gst::Event</a>.</p> <div class="dynheader"> Collaboration diagram for Gst::EventBufferSize:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1EventBufferSize__coll__graph.png" border="0" usemap="#Gst_1_1EventBufferSize_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1EventBufferSize_coll__map" id="Gst_1_1EventBufferSize_coll__map"> <area shape="rect" href="classGst_1_1Event.html" title="Gst::Event - A structure describing events that are passed up and down a pipeline..." alt="" coords="36,83,119,112"/><area shape="rect" href="classMiniObject.html" title="MiniObject" alt="" coords="36,5,119,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1EventBufferSize-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#af4619446150925df4663fb66ade0682c">EventBufferSize</a> (GstEvent* event)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#a1ddbe318829a3856d56b016d09ff99b2">parse</a> (<a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a>& format, gint64& minsize, gint64& maxsize, bool& async) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the format, minsize, maxsize and async-flag in the buffersize event. <a href="#a1ddbe318829a3856d56b016d09ff99b2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">gint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#af3393d47e601c2423b52209dc15199f3">parse</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the minsize in the buffersize event. <a href="#af3393d47e601c2423b52209dc15199f3"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#a4c67bc52d086c016582ab19e3f77cd30">parse_format</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the format, in the buffersize event. <a href="#a4c67bc52d086c016582ab19e3f77cd30"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">gint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#ae17e1051d52c0587dfe77b0a4f594d10">parse_max_size</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the maxsize in the buffersize event. <a href="#ae17e1051d52c0587dfe77b0a4f594d10"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#a5329f66834f0d968b88f4b4842a1557a">parse_async</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the async-flag in the buffersize event. <a href="#a5329f66834f0d968b88f4b4842a1557a"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Event.html">Gst::Event</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1EventBufferSize.html#ae0675e9eeec24c5b48b994daf1c5c7ea">create</a> (<a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> format, gint64 minsize, gint64 maxsize, bool async)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new buffersize event. <a href="#ae0675e9eeec24c5b48b994daf1c5c7ea"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A buffer size event. </p> <p>See <a class="el" href="classGst_1_1EventBufferSize.html#ae0675e9eeec24c5b48b994daf1c5c7ea" title="Create a new buffersize event.">create()</a> for more details. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="af4619446150925df4663fb66ade0682c"></a><!-- doxytag: member="Gst::EventBufferSize::EventBufferSize" ref="af4619446150925df4663fb66ade0682c" args="(GstEvent *event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::EventBufferSize::EventBufferSize </td> <td>(</td> <td class="paramtype">GstEvent * </td> <td class="paramname"> <em>event</em></td> <td> ) </td> <td><code> [explicit]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae0675e9eeec24c5b48b994daf1c5c7ea"></a><!-- doxytag: member="Gst::EventBufferSize::create" ref="ae0675e9eeec24c5b48b994daf1c5c7ea" args="(Format format, gint64 minsize, gint64 maxsize, bool async)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1Event.html">Gst::Event</a>> Gst::EventBufferSize::create </td> <td>(</td> <td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> </td> <td class="paramname"> <em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gint64 </td> <td class="paramname"> <em>minsize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gint64 </td> <td class="paramname"> <em>maxsize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>async</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Create a new buffersize event. </p> <p>The event is sent downstream and notifies elements that they should provide a buffer of the specified dimensions.</p> <p>When the async flag is set, a thread boundary is prefered.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td><a class="el" href="classGst_1_1Buffer.html" title="Gst::Buffer - Data-passing buffer type, supporting sub-buffers.">Buffer</a> format. </td></tr> <tr><td valign="top"></td><td valign="top"><em>minsize</em> </td><td>Minimum buffer size. </td></tr> <tr><td valign="top"></td><td valign="top"><em>maxsize</em> </td><td>Maximum buffer size. </td></tr> <tr><td valign="top"></td><td valign="top"><em>async</em> </td><td>Thread behavior. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGst_1_1EventBufferSize.html" title="A buffer size event.">Gst::EventBufferSize</a>. </dd></dl> </div> </div> <a class="anchor" id="af3393d47e601c2423b52209dc15199f3"></a><!-- doxytag: member="Gst::EventBufferSize::parse" ref="af3393d47e601c2423b52209dc15199f3" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gint64 Gst::EventBufferSize::parse </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the minsize in the buffersize event. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The mininum size. </dd></dl> </div> </div> <a class="anchor" id="a1ddbe318829a3856d56b016d09ff99b2"></a><!-- doxytag: member="Gst::EventBufferSize::parse" ref="a1ddbe318829a3856d56b016d09ff99b2" args="(Format &format, gint64 &minsize, gint64 &maxsize, bool &async) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gst::EventBufferSize::parse </td> <td>(</td> <td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a>& </td> <td class="paramname"> <em>format</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gint64 & </td> <td class="paramname"> <em>minsize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">gint64 & </td> <td class="paramname"> <em>maxsize</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool & </td> <td class="paramname"> <em>async</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the format, minsize, maxsize and async-flag in the buffersize event. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>A reference to store the format in. </td></tr> <tr><td valign="top"></td><td valign="top"><em>minsize</em> </td><td>A reference to store the minsize in. </td></tr> <tr><td valign="top"></td><td valign="top"><em>maxsize</em> </td><td>A reference to store the maxsize in. </td></tr> <tr><td valign="top"></td><td valign="top"><em>async</em> </td><td>A reference to store the async-flag in. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a5329f66834f0d968b88f4b4842a1557a"></a><!-- doxytag: member="Gst::EventBufferSize::parse_async" ref="a5329f66834f0d968b88f4b4842a1557a" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool Gst::EventBufferSize::parse_async </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the async-flag in the buffersize event. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The async flag. </dd></dl> </div> </div> <a class="anchor" id="a4c67bc52d086c016582ab19e3f77cd30"></a><!-- doxytag: member="Gst::EventBufferSize::parse_format" ref="a4c67bc52d086c016582ab19e3f77cd30" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> Gst::EventBufferSize::parse_format </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the format, in the buffersize event. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The format. </dd></dl> </div> </div> <a class="anchor" id="ae17e1051d52c0587dfe77b0a4f594d10"></a><!-- doxytag: member="Gst::EventBufferSize::parse_max_size" ref="ae17e1051d52c0587dfe77b0a4f594d10" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gint64 Gst::EventBufferSize::parse_max_size </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Get the maxsize in the buffersize event. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>The maximum size. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>gstreamermm/event.h</li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 22:32:55 2009 for gstreamermm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>