/web/audiere-1.9.4-devel-doxygen/classaudiere_1_1StopEvent.html
HTML | 231 lines | 214 code | 16 blank | 1 comment | 0 complexity | 3f7ffc01ef484321a635e85659c13ad7 MD5 | raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
- <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
- <title>audiere: audiere::StopEvent Class Reference</title>
- <link href="doxygen.css" rel="stylesheet" type="text/css">
- <link href="tabs.css" rel="stylesheet" type="text/css">
- </head><body>
- <!-- Generated by Doxygen 1.4.6 -->
- <div class="tabs">
- <ul>
- <li><a href="main.html"><span>Main Page</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li id="current"><a href="classes.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li><a href="dirs.html"><span>Directories</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- </ul></div>
- <div class="tabs">
- <ul>
- <li><a href="classes.html"><span>Alphabetical List</span></a></li>
- <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="nav">
- <a class="el" href="namespaceaudiere.html">audiere</a>::<a class="el" href="classaudiere_1_1StopEvent.html">StopEvent</a></div>
- <h1>audiere::StopEvent Class Reference</h1><!-- doxytag: class="audiere::StopEvent" --><!-- doxytag: inherits="audiere::Event" --><code>#include <<a class="el" href="audiere_8h-source.html">audiere.h</a>></code>
- <p>
- Inheritance diagram for audiere::StopEvent:<p><center><img src="classaudiere_1_1StopEvent__inherit__graph.png" border="0" usemap="#audiere_1_1StopEvent__inherit__map" alt="Inheritance graph"></center>
- <map name="audiere_1_1StopEvent__inherit__map">
- <area href="classaudiere_1_1RefImplementation.html" shape="rect" coords="5,229,280,256" alt="">
- <area href="classaudiere_1_1Event.html" shape="rect" coords="88,80,197,107" alt="">
- <area href="classaudiere_1_1RefCounted.html" shape="rect" coords="71,5,215,32" alt="">
- <area href="classaudiere_1_1StopEventImpl.html" shape="rect" coords="61,304,224,331" alt="">
- </map>
- <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for audiere::StopEvent:<p><center><img src="classaudiere_1_1StopEvent__coll__graph.png" border="0" usemap="#audiere_1_1StopEvent__coll__map" alt="Collaboration graph"></center>
- <map name="audiere_1_1StopEvent__coll__map">
- <area href="classaudiere_1_1Event.html" shape="rect" coords="23,80,132,107" alt="">
- <area href="classaudiere_1_1RefCounted.html" shape="rect" coords="6,6,150,32" alt="">
- </map>
- <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classaudiere_1_1StopEvent-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
- <tr><td></td></tr>
- <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">Reason</a> { <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087e8fcf1dd76b0fb514e45dc23eecfdc33">STOP_CALLED</a>,
- <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722">STREAM_ENDED</a>
- }</td></tr>
- <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb">EventType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#ebd81b2b824d495e16072effc4d4332e">getType</a> ()</td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classaudiere_1_1OutputStream.html">OutputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#567fafcb7f78599aed944fe782576887">getOutputStream</a> ()=0</td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">Reason</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#5a2a69ceadf2da4f71cc39710d948f1d">getReason</a> ()=0</td></tr>
- <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
- <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#70510a313e5db6d5a5d54d49bfbff296">~StopEvent</a> ()</td></tr>
- </table>
- <hr><a name="_details"></a><h2>Detailed Description</h2>
- An event object that gets passed to implementations of <a class="el" href="classaudiere_1_1StopCallback.html">StopCallback</a> when a stream has stopped playing.
- <p>
- <p>
- Definition at line <a class="el" href="audiere_8h-source.html#l00610">610</a> of file <a class="el" href="audiere_8h-source.html">audiere.h</a>.<hr><h2>Member Enumeration Documentation</h2>
- <a class="anchor" name="a0c553c4c49a60597bcb24b6be227087"></a><!-- doxytag: member="audiere::StopEvent::Reason" ref="a0c553c4c49a60597bcb24b6be227087" args="" --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">enum <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">audiere::StopEvent::Reason</a> </td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- A code representing the reason the stream stopped playback.
- <p>
- <dl compact><dt><b>Enumerator: </b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"><em><a class="anchor" name="a0c553c4c49a60597bcb24b6be227087e8fcf1dd76b0fb514e45dc23eecfdc33"></a><!-- doxytag: member="STOP_CALLED" ref="a0c553c4c49a60597bcb24b6be227087e8fcf1dd76b0fb514e45dc23eecfdc33" args="" -->STOP_CALLED</em> </td><td>
- stop() was called from an external source. </td></tr>
- <tr><td valign="top"><em><a class="anchor" name="a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722"></a><!-- doxytag: member="STREAM_ENDED" ref="a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722" args="" -->STREAM_ENDED</em> </td><td>
- The stream reached its end. </td></tr>
- </table>
- </dl>
- <p>
- Definition at line <a class="el" href="audiere_8h-source.html#l00618">618</a> of file <a class="el" href="audiere_8h-source.html">audiere.h</a>. </td>
- </tr>
- </table>
- <hr><h2>Constructor & Destructor Documentation</h2>
- <a class="anchor" name="70510a313e5db6d5a5d54d49bfbff296"></a><!-- doxytag: member="audiere::StopEvent::~StopEvent" ref="70510a313e5db6d5a5d54d49bfbff296" args="()" --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">audiere::StopEvent::~StopEvent </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, protected]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <p>
- Definition at line <a class="el" href="audiere_8h-source.html#l00612">612</a> of file <a class="el" href="audiere_8h-source.html">audiere.h</a>. </td>
- </tr>
- </table>
- <hr><h2>Member Function Documentation</h2>
- <a class="anchor" name="567fafcb7f78599aed944fe782576887"></a><!-- doxytag: member="audiere::StopEvent::getOutputStream" ref="567fafcb7f78599aed944fe782576887" args="()=0" --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">virtual <a class="el" href="classaudiere_1_1OutputStream.html">OutputStream</a>* audiere::StopEvent::getOutputStream </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [pure virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>Pointer to the <a class="el" href="classaudiere_1_1OutputStream.html">OutputStream</a> that stopped playback. </dd></dl>
- <p>
- Implemented in <a class="el" href="classaudiere_1_1StopEventImpl.html#7cb10dc1339d64b5c46730cc3107bbe2">audiere::StopEventImpl</a>. </td>
- </tr>
- </table>
- <a class="anchor" name="5a2a69ceadf2da4f71cc39710d948f1d"></a><!-- doxytag: member="audiere::StopEvent::getReason" ref="5a2a69ceadf2da4f71cc39710d948f1d" args="()=0" --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">virtual <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">Reason</a> audiere::StopEvent::getReason </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [pure virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- <dl compact><dt><b>Returns:</b></dt><dd>Reason for the stop event. </dd></dl>
- <p>
- Implemented in <a class="el" href="classaudiere_1_1StopEventImpl.html#4da63d7bff43fe0ec79366dfc3a3b111">audiere::StopEventImpl</a>. </td>
- </tr>
- </table>
- <a class="anchor" name="ebd81b2b824d495e16072effc4d4332e"></a><!-- doxytag: member="audiere::StopEvent::getType" ref="ebd81b2b824d495e16072effc4d4332e" args="()" --><p>
- <table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"><a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb">EventType</a> audiere::StopEvent::getType </td>
- <td class="md" valign="top">( </td>
- <td class="mdname1" valign="top" nowrap> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [inline, virtual]</code></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
- <p>
- Returns the EventType code for this event.
- <p>
- <p>
- Implements <a class="el" href="classaudiere_1_1Event.html#727a09b3ca1849eec92a938681fae5ff">audiere::Event</a>.
- <p>
- Definition at line <a class="el" href="audiere_8h-source.html#l00615">615</a> of file <a class="el" href="audiere_8h-source.html">audiere.h</a>.
- <p>
- References <a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb2aa1026644925598afc0eec091377629">audiere::ET_STOP</a>. </td>
- </tr>
- </table>
- <hr>The documentation for this class was generated from the following file:<ul>
- <li><a class="el" href="audiere_8h-source.html">audiere.h</a></ul>
- <hr size="1"><address style="align: right;"><small>Generated on Mon Feb 13 23:08:45 2006 for audiere by
- <a href="http://www.doxygen.org/index.html">
- <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
- </body>
- </html>