<!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::MessageStepDone 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_1MessageStepDone.html">MessageStepDone</a>
</div>
</div>
<div class="contents">
<h1>Gst::MessageStepDone Class Reference</h1><!-- doxytag: class="Gst::MessageStepDone" --><!-- doxytag: inherits="Gst::Message" -->
<p>A step done message. <a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classGst_1_1Message.html">Gst::Message</a>.</p>
<div class="dynheader">
Collaboration diagram for Gst::MessageStepDone:</div>
<div class="dynsection">
<div class="center"><img src="classGst_1_1MessageStepDone__coll__graph.png" border="0" usemap="#Gst_1_1MessageStepDone_coll__map" alt="Collaboration graph"/></div>
<map name="Gst_1_1MessageStepDone_coll__map" id="Gst_1_1MessageStepDone_coll__map">
<area shape="rect" href="classGst_1_1Message.html" title="Gst::Message - Lightweight objects to signal the application of pipeline events." alt="" coords="33,83,137,112"/><area shape="rect" href="classGst_1_1MiniObject.html" title="Gst::MiniObject" alt="" coords="29,5,141,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGst_1_1MessageStepDone-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_1MessageStepDone.html#a8b7e5e72c89c4b6cefe801a748147860">MessageStepDone</a> (GstMessage* castitem)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageStepDone.html#a7dbbd7d332890b0ed7997f65900ad31a">parse</a> (<a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a>& format, guint64& amount, double& rate, bool& flush, bool& intermediate, guint64& duration, bool& eos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extract the values of the step done message. <a href="#a7dbbd7d332890b0ed7997f65900ad31a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">guint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageStepDone.html#a6579c3b76b682f2c6acda6121d67b935">parse</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the duration of the step done message. <a href="#a6579c3b76b682f2c6acda6121d67b935"></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_1MessageStepDone.html#a6a3204068cd3562b8339ed53a9786287">parse_format</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the format of the step done message. <a href="#a6a3204068cd3562b8339ed53a9786287"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">guint64 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageStepDone.html#afb5cd1f2ae5c515efc9bdba344641d4d">parse_amount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the amount of the step done message. <a href="#afb5cd1f2ae5c515efc9bdba344641d4d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageStepDone.html#a9c7b32179af24df8d64f8b828d367c3e">parse_rate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the rate of the step done message. <a href="#a9c7b32179af24df8d64f8b828d367c3e"></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_1MessageStepDone.html#a8ecfc75f0b3a58279c553547301f92f5">parse_flush</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the flush flag of the step done message. <a href="#a8ecfc75f0b3a58279c553547301f92f5"></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_1MessageStepDone.html#afd30f31188a493738ecec224294fac17">parse_intermediate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the intermediate flag of the step done message. <a href="#afd30f31188a493738ecec224294fac17"></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_1MessageStepDone.html#a1da8abee109f2935e502fb8a23b0163b">parse_eos</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the eos flag of the step done message. <a href="#a1da8abee109f2935e502fb8a23b0163b"></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_1Message.html">Gst::Message</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageStepDone.html#a1eba05e06c11e3c2c2bcb5a5e416a914">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Object.html">Gst::Object</a> >& src, <a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> format, guint64 amount, double rate, bool flush, bool intermediate, guint64 duration, bool eos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a step done message. <a href="#a1eba05e06c11e3c2c2bcb5a5e416a914"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A step done message. </p>
<p>See <a class="el" href="classGst_1_1MessageStepDone.html#a1eba05e06c11e3c2c2bcb5a5e416a914" title="Create a step done message.">create()</a> for more details. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8b7e5e72c89c4b6cefe801a748147860"></a><!-- doxytag: member="Gst::MessageStepDone::MessageStepDone" ref="a8b7e5e72c89c4b6cefe801a748147860" args="(GstMessage *castitem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gst::MessageStepDone::MessageStepDone </td>
<td>(</td>
<td class="paramtype">GstMessage * </td>
<td class="paramname"> <em>castitem</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="a1eba05e06c11e3c2c2bcb5a5e416a914"></a><!-- doxytag: member="Gst::MessageStepDone::create" ref="a1eba05e06c11e3c2c2bcb5a5e416a914" args="(const Glib::RefPtr< Gst::Object > &src, Gst::Format format, guint64 amount, double rate, bool flush, bool intermediate, guint64 duration, bool eos)" -->
<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_1Message.html">Gst::Message</a>> Gst::MessageStepDone::create </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Object.html">Gst::Object</a> >& </td>
<td class="paramname"> <em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a> </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint64 </td>
<td class="paramname"> <em>amount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>intermediate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint64 </td>
<td class="paramname"> <em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>eos</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 step done message. </p>
<p>This message is posted by elements when they complete a part, when <em>intermediate</em> set to true, or a complete step operation.</p>
<p><em>duration</em> will contain the amount of time (in <a class="el" href="group__gstreamermmEnums.html#gga9aeb4c7c49680888ff819ac95fb13cffa3fbd7aaf4f1bc4ada096dff953e3398e">Gst::FORMAT_TIME</a>) of the stepped <em>amount</em> of media in format <em>format</em>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>The object originating the message. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>The format of amount. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>amount</em> </td><td>The amount of stepped data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rate</em> </td><td>The rate of the stepped amount. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flush</em> </td><td>Is this an flushing step. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>intermediate</em> </td><td>Is this an intermediate step. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>duration</em> </td><td>The duration of the data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eos</em> </td><td>The step caused EOS. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new step done message. MT safe.</dd></dl>
<p>Since 0.10.24. </p>
</div>
</div>
<a class="anchor" id="a6579c3b76b682f2c6acda6121d67b935"></a><!-- doxytag: member="Gst::MessageStepDone::parse" ref="a6579c3b76b682f2c6acda6121d67b935" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint64 Gst::MessageStepDone::parse </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the duration of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The duration. </dd></dl>
</div>
</div>
<a class="anchor" id="a7dbbd7d332890b0ed7997f65900ad31a"></a><!-- doxytag: member="Gst::MessageStepDone::parse" ref="a7dbbd7d332890b0ed7997f65900ad31a" args="(Gst::Format &format, guint64 &amount, double &rate, bool &flush, bool &intermediate, guint64 &duration, bool &eos) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::MessageStepDone::parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Gst::Format</a>& </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint64 & </td>
<td class="paramname"> <em>amount</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double & </td>
<td class="paramname"> <em>rate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>flush</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>intermediate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint64 & </td>
<td class="paramname"> <em>duration</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>eos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extract the values of the step done message. </p>
<p>MT safe.</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>Result location for the format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>amount</em> </td><td>Result location for the amount. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rate</em> </td><td>Result location for the rate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flush</em> </td><td>Result location for the flush flag. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>intermediate</em> </td><td>Result location for the intermediate flag. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>duration</em> </td><td>Result location for the duration. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>eos</em> </td><td>Result location for the EOS flag.</td></tr>
</table>
</dd>
</dl>
<p>Since 0.10.24. </p>
</div>
</div>
<a class="anchor" id="afb5cd1f2ae5c515efc9bdba344641d4d"></a><!-- doxytag: member="Gst::MessageStepDone::parse_amount" ref="afb5cd1f2ae5c515efc9bdba344641d4d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint64 Gst::MessageStepDone::parse_amount </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the amount of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The amount. </dd></dl>
</div>
</div>
<a class="anchor" id="a1da8abee109f2935e502fb8a23b0163b"></a><!-- doxytag: member="Gst::MessageStepDone::parse_eos" ref="a1da8abee109f2935e502fb8a23b0163b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::MessageStepDone::parse_eos </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the eos flag of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The eos flag. </dd></dl>
</div>
</div>
<a class="anchor" id="a8ecfc75f0b3a58279c553547301f92f5"></a><!-- doxytag: member="Gst::MessageStepDone::parse_flush" ref="a8ecfc75f0b3a58279c553547301f92f5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::MessageStepDone::parse_flush </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the flush flag of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The flush flag. </dd></dl>
</div>
</div>
<a class="anchor" id="a6a3204068cd3562b8339ed53a9786287"></a><!-- doxytag: member="Gst::MessageStepDone::parse_format" ref="a6a3204068cd3562b8339ed53a9786287" 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::MessageStepDone::parse_format </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the format of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The format. </dd></dl>
</div>
</div>
<a class="anchor" id="afd30f31188a493738ecec224294fac17"></a><!-- doxytag: member="Gst::MessageStepDone::parse_intermediate" ref="afd30f31188a493738ecec224294fac17" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gst::MessageStepDone::parse_intermediate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the intermediate flag of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The intermediate flag. </dd></dl>
</div>
</div>
<a class="anchor" id="a9c7b32179af24df8d64f8b828d367c3e"></a><!-- doxytag: member="Gst::MessageStepDone::parse_rate" ref="a9c7b32179af24df8d64f8b828d367c3e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double Gst::MessageStepDone::parse_rate </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extracts the rate of the step done message. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The rate. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gstreamermm/message.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 22:32:57 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
7a65d2578765429f23843d9c8d1c0efa
>
files
>
586
