<!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::MessageSegmentStart 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_1MessageSegmentStart.html">MessageSegmentStart</a> </div> </div> <div class="contents"> <h1>Gst::MessageSegmentStart Class Reference</h1><!-- doxytag: class="Gst::MessageSegmentStart" --><!-- doxytag: inherits="Gst::Message" --> <p>A segment start 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::MessageSegmentStart:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1MessageSegmentStart__coll__graph.png" border="0" usemap="#Gst_1_1MessageSegmentStart_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1MessageSegmentStart_coll__map" id="Gst_1_1MessageSegmentStart_coll__map"> <area shape="rect" href="classGst_1_1Message.html" title="Gst::Message - Lightweight objects to signal the application of pipeline events." alt="" coords="45,83,149,112"/><area shape="rect" href="classGst_1_1MiniObject.html" title="Gst::MiniObject" alt="" coords="41,5,153,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1MessageSegmentStart-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_1MessageSegmentStart.html#ac3f45399188a48514e06388f6114a05b">MessageSegmentStart</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_1MessageSegmentStart.html#a57e5175b0ae4160485ee827d4d08400c">parse</a> (<a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a>& format, gint64& position) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts the position and format from the segment start message. <a href="#a57e5175b0ae4160485ee827d4d08400c"></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_1MessageSegmentStart.html#af3a6bef8bda2c773f0746040cefc08bf">parse</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts and returns the position from the segment start message. <a href="#af3a6bef8bda2c773f0746040cefc08bf"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1MessageSegmentStart.html#aa1a9d20a58d58dd0852501e92a257f87">parse_format</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Extracts and returns the format from the segment start message. <a href="#aa1a9d20a58d58dd0852501e92a257f87"></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_1MessageSegmentStart.html#a6b4a7d2ae24e456d9cbe073a65104ec4">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">Format</a> format, gint64 position)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new segment message. <a href="#a6b4a7d2ae24e456d9cbe073a65104ec4"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A segment start message. </p> <p>See <a class="el" href="classGst_1_1MessageSegmentStart.html#a6b4a7d2ae24e456d9cbe073a65104ec4" title="Create a new segment message.">create()</a> for more details. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac3f45399188a48514e06388f6114a05b"></a><!-- doxytag: member="Gst::MessageSegmentStart::MessageSegmentStart" ref="ac3f45399188a48514e06388f6114a05b" args="(GstMessage *castitem)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::MessageSegmentStart::MessageSegmentStart </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="a6b4a7d2ae24e456d9cbe073a65104ec4"></a><!-- doxytag: member="Gst::MessageSegmentStart::create" ref="a6b4a7d2ae24e456d9cbe073a65104ec4" args="(const Glib::RefPtr< Gst::Object > &src, Format format, gint64 position)" --> <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::MessageSegmentStart::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">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>position</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 segment message. </p> <p>This message is posted by elements that start playback of a segment as a result of a segment seek. This message is not received by the application but is used for maintenance reasons in container elements.</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 the position being played. </td></tr> <tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>The position of the segment being played. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The new segment start message. MT safe. </dd></dl> </div> </div> <a class="anchor" id="af3a6bef8bda2c773f0746040cefc08bf"></a><!-- doxytag: member="Gst::MessageSegmentStart::parse" ref="af3a6bef8bda2c773f0746040cefc08bf" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gint64 Gst::MessageSegmentStart::parse </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Extracts and returns the position from the segment start message. </p> <p>MT safe.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The position. </dd></dl> </div> </div> <a class="anchor" id="a57e5175b0ae4160485ee827d4d08400c"></a><!-- doxytag: member="Gst::MessageSegmentStart::parse" ref="a57e5175b0ae4160485ee827d4d08400c" args="(Format &format, gint64 &position) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void Gst::MessageSegmentStart::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>position</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Extracts the position and format from the segment start 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>position</em> </td><td>Result location for the position. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aa1a9d20a58d58dd0852501e92a257f87"></a><!-- doxytag: member="Gst::MessageSegmentStart::parse_format" ref="aa1a9d20a58d58dd0852501e92a257f87" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__gstreamermmEnums.html#ga9aeb4c7c49680888ff819ac95fb13cff">Format</a> Gst::MessageSegmentStart::parse_format </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Extracts and returns the format from the segment start message. </p> <p>MT safe.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>The format. </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>