PageRenderTime 53ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 0ms

/web/audiere-1.9.4-devel-doxygen/classaudiere_1_1StopEvent.html

https://github.com/Bananattack/audiere
HTML | 231 lines | 214 code | 16 blank | 1 comment | 0 complexity | 3f7ffc01ef484321a635e85659c13ad7 MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>audiere: audiere::StopEvent Class Reference</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.4.6 -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

  10.     <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    11. 

  11.     <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    12. 

  12.     <li id="current"><a href="classes.html"><span>Classes</span></a></li>
    13. 

  13.     <li><a href="files.html"><span>Files</span></a></li>
    14. 

  14.     <li><a href="dirs.html"><span>Directories</span></a></li>
    15. 

  15.     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.   </ul></div>
    17. 

  17. <div class="tabs">
    18. 

  18.   <ul>
    19. 

  19.     <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    20. 

  20.     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    21. 

  21.     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    22. 

  22.     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    23. 

  23.   </ul></div>
    24. 

  24. <div class="nav">
    25. 

  25. <a class="el" href="namespaceaudiere.html">audiere</a>::<a class="el" href="classaudiere_1_1StopEvent.html">StopEvent</a></div>
    26. 

  26. <h1>audiere::StopEvent Class Reference</h1><!-- doxytag: class="audiere::StopEvent" --><!-- doxytag: inherits="audiere::Event" --><code>#include &lt;<a class="el" href="audiere_8h-source.html">audiere.h</a>&gt;</code>
    27. 

  27. <p>
    28. 

  28. 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>
    29. 

  29. <map name="audiere_1_1StopEvent__inherit__map">
    30. 

  30. <area href="classaudiere_1_1RefImplementation.html" shape="rect" coords="5,229,280,256" alt="">
    31. 

  31. <area href="classaudiere_1_1Event.html" shape="rect" coords="88,80,197,107" alt="">
    32. 

  32. <area href="classaudiere_1_1RefCounted.html" shape="rect" coords="71,5,215,32" alt="">
    33. 

  33. <area href="classaudiere_1_1StopEventImpl.html" shape="rect" coords="61,304,224,331" alt="">
    34. 

  34. </map>
    35. 

  35. <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>
    36. 

  36. <map name="audiere_1_1StopEvent__coll__map">
    37. 

  37. <area href="classaudiere_1_1Event.html" shape="rect" coords="23,80,132,107" alt="">
    38. 

  38. <area href="classaudiere_1_1RefCounted.html" shape="rect" coords="6,6,150,32" alt="">
    39. 

  39. </map>
    40. 

  40. <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">
    41. 

  41. <tr><td></td></tr>
    42. 

  42. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
    43. 

  43. <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</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>, 
    44. 

  44. <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722">STREAM_ENDED</a>
    45. 

  45.  }</td></tr>
    46. 

  46. 

  47. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
    48. 

  48. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb">EventType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#ebd81b2b824d495e16072effc4d4332e">getType</a> ()</td></tr>
    49. 

  49. 

  50. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classaudiere_1_1OutputStream.html">OutputStream</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#567fafcb7f78599aed944fe782576887">getOutputStream</a> ()=0</td></tr>
    51. 

  51. 

  52. <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">Reason</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#5a2a69ceadf2da4f71cc39710d948f1d">getReason</a> ()=0</td></tr>
    53. 

  53. 

  54. <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
    55. 

  55. <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudiere_1_1StopEvent.html#70510a313e5db6d5a5d54d49bfbff296">~StopEvent</a> ()</td></tr>
    56. 

  56. 

  57. </table>
    58. 

  58. <hr><a name="_details"></a><h2>Detailed Description</h2>
    59. 

  59. 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. 
    60. 

  60. <p>
    61. 

  61. 

  62. <p>
    63. 

  63. 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>
    64. 

  64. <a class="anchor" name="a0c553c4c49a60597bcb24b6be227087"></a><!-- doxytag: member="audiere::StopEvent::Reason" ref="a0c553c4c49a60597bcb24b6be227087" args="" --><p>
    65. 

  65. <table class="mdTable" cellpadding="2" cellspacing="0">
    66. 

  66.   <tr>
    67. 

  67.     <td class="mdRow">
    68. 

  68.       <table cellpadding="0" cellspacing="0" border="0">
    69. 

  69.         <tr>
    70. 

  70.           <td class="md" nowrap valign="top">enum <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">audiere::StopEvent::Reason</a>          </td>
    71. 

  71.         </tr>
    72. 

  72.       </table>
    73. 

  73.     </td>
    74. 

  74.   </tr>
    75. 

  75. </table>
    76. 

  76. <table cellspacing="5" cellpadding="0" border="0">
    77. 

  77.   <tr>
    78. 

  78.     <td>
    79. 

  79.       &nbsp;
    80. 

  80.     </td>
    81. 

  81.     <td>
    82. 

  82. 

  83. <p>
    84. 

  84. A code representing the reason the stream stopped playback. 
    85. 

  85. <p>
    86. 

  86. <dl compact><dt><b>Enumerator: </b></dt><dd>
    87. 

  87. <table border="0" cellspacing="2" cellpadding="0">
    88. 

  88. <tr><td valign="top"><em><a class="anchor" name="a0c553c4c49a60597bcb24b6be227087e8fcf1dd76b0fb514e45dc23eecfdc33"></a><!-- doxytag: member="STOP_CALLED" ref="a0c553c4c49a60597bcb24b6be227087e8fcf1dd76b0fb514e45dc23eecfdc33" args="" -->STOP_CALLED</em>&nbsp;</td><td>
    89. 

  89. stop() was called from an external source. </td></tr>
    90. 

  90. <tr><td valign="top"><em><a class="anchor" name="a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722"></a><!-- doxytag: member="STREAM_ENDED" ref="a0c553c4c49a60597bcb24b6be227087036a39e05bedf4d2a1d5e58a9b611722" args="" -->STREAM_ENDED</em>&nbsp;</td><td>
    91. 

  91. The stream reached its end. </td></tr>
    92. 

  92. </table>
    93. 

  93. </dl>
    94. 

  94. 

  95. <p>
    96. 

  96. 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>
    97. 

  97.   </tr>
    98. 

  98. </table>
    99. 

  99. <hr><h2>Constructor &amp; Destructor Documentation</h2>
    100. 

  100. <a class="anchor" name="70510a313e5db6d5a5d54d49bfbff296"></a><!-- doxytag: member="audiere::StopEvent::~StopEvent" ref="70510a313e5db6d5a5d54d49bfbff296" args="()" --><p>
    101. 

  101. <table class="mdTable" cellpadding="2" cellspacing="0">
    102. 

  102.   <tr>
    103. 

  103.     <td class="mdRow">
    104. 

  104.       <table cellpadding="0" cellspacing="0" border="0">
    105. 

  105.         <tr>
    106. 

  106.           <td class="md" nowrap valign="top">audiere::StopEvent::~StopEvent           </td>
    107. 

  107.           <td class="md" valign="top">(&nbsp;</td>
    108. 

  108.           <td class="mdname1" valign="top" nowrap>          </td>
    109. 

  109.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    110. 

  110.           <td class="md" nowrap><code> [inline, protected]</code></td>
    111. 

  111.         </tr>
    112. 

  112.       </table>
    113. 

  113.     </td>
    114. 

  114.   </tr>
    115. 

  115. </table>
    116. 

  116. <table cellspacing="5" cellpadding="0" border="0">
    117. 

  117.   <tr>
    118. 

  118.     <td>
    119. 

  119.       &nbsp;
    120. 

  120.     </td>
    121. 

  121.     <td>
    122. 

  122. 

  123. <p>
    124. 

  124. 

  125. <p>
    126. 

  126. 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>
    127. 

  127.   </tr>
    128. 

  128. </table>
    129. 

  129. <hr><h2>Member Function Documentation</h2>
    130. 

  130. <a class="anchor" name="567fafcb7f78599aed944fe782576887"></a><!-- doxytag: member="audiere::StopEvent::getOutputStream" ref="567fafcb7f78599aed944fe782576887" args="()=0" --><p>
    131. 

  131. <table class="mdTable" cellpadding="2" cellspacing="0">
    132. 

  132.   <tr>
    133. 

  133.     <td class="mdRow">
    134. 

  134.       <table cellpadding="0" cellspacing="0" border="0">
    135. 

  135.         <tr>
    136. 

  136.           <td class="md" nowrap valign="top">virtual <a class="el" href="classaudiere_1_1OutputStream.html">OutputStream</a>* audiere::StopEvent::getOutputStream           </td>
    137. 

  137.           <td class="md" valign="top">(&nbsp;</td>
    138. 

  138.           <td class="mdname1" valign="top" nowrap>          </td>
    139. 

  139.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    140. 

  140.           <td class="md" nowrap><code> [pure virtual]</code></td>
    141. 

  141.         </tr>
    142. 

  142.       </table>
    143. 

  143.     </td>
    144. 

  144.   </tr>
    145. 

  145. </table>
    146. 

  146. <table cellspacing="5" cellpadding="0" border="0">
    147. 

  147.   <tr>
    148. 

  148.     <td>
    149. 

  149.       &nbsp;
    150. 

  150.     </td>
    151. 

  151.     <td>
    152. 

  152. 

  153. <p>
    154. 

  154. <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>
    155. 

  155. 

  156. <p>
    157. 

  157. Implemented in <a class="el" href="classaudiere_1_1StopEventImpl.html#7cb10dc1339d64b5c46730cc3107bbe2">audiere::StopEventImpl</a>.    </td>
    158. 

  158.   </tr>
    159. 

  159. </table>
    160. 

  160. <a class="anchor" name="5a2a69ceadf2da4f71cc39710d948f1d"></a><!-- doxytag: member="audiere::StopEvent::getReason" ref="5a2a69ceadf2da4f71cc39710d948f1d" args="()=0" --><p>
    161. 

  161. <table class="mdTable" cellpadding="2" cellspacing="0">
    162. 

  162.   <tr>
    163. 

  163.     <td class="mdRow">
    164. 

  164.       <table cellpadding="0" cellspacing="0" border="0">
    165. 

  165.         <tr>
    166. 

  166.           <td class="md" nowrap valign="top">virtual <a class="el" href="classaudiere_1_1StopEvent.html#a0c553c4c49a60597bcb24b6be227087">Reason</a> audiere::StopEvent::getReason           </td>
    167. 

  167.           <td class="md" valign="top">(&nbsp;</td>
    168. 

  168.           <td class="mdname1" valign="top" nowrap>          </td>
    169. 

  169.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    170. 

  170.           <td class="md" nowrap><code> [pure virtual]</code></td>
    171. 

  171.         </tr>
    172. 

  172.       </table>
    173. 

  173.     </td>
    174. 

  174.   </tr>
    175. 

  175. </table>
    176. 

  176. <table cellspacing="5" cellpadding="0" border="0">
    177. 

  177.   <tr>
    178. 

  178.     <td>
    179. 

  179.       &nbsp;
    180. 

  180.     </td>
    181. 

  181.     <td>
    182. 

  182. 

  183. <p>
    184. 

  184. <dl compact><dt><b>Returns:</b></dt><dd>Reason for the stop event. </dd></dl>
    185. 

  185. 

  186. <p>
    187. 

  187. Implemented in <a class="el" href="classaudiere_1_1StopEventImpl.html#4da63d7bff43fe0ec79366dfc3a3b111">audiere::StopEventImpl</a>.    </td>
    188. 

  188.   </tr>
    189. 

  189. </table>
    190. 

  190. <a class="anchor" name="ebd81b2b824d495e16072effc4d4332e"></a><!-- doxytag: member="audiere::StopEvent::getType" ref="ebd81b2b824d495e16072effc4d4332e" args="()" --><p>
    191. 

  191. <table class="mdTable" cellpadding="2" cellspacing="0">
    192. 

  192.   <tr>
    193. 

  193.     <td class="mdRow">
    194. 

  194.       <table cellpadding="0" cellspacing="0" border="0">
    195. 

  195.         <tr>
    196. 

  196.           <td class="md" nowrap valign="top"><a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb">EventType</a> audiere::StopEvent::getType           </td>
    197. 

  197.           <td class="md" valign="top">(&nbsp;</td>
    198. 

  198.           <td class="mdname1" valign="top" nowrap>          </td>
    199. 

  199.           <td class="md" valign="top">&nbsp;)&nbsp;</td>
    200. 

  200.           <td class="md" nowrap><code> [inline, virtual]</code></td>
    201. 

  201.         </tr>
    202. 

  202.       </table>
    203. 

  203.     </td>
    204. 

  204.   </tr>
    205. 

  205. </table>
    206. 

  206. <table cellspacing="5" cellpadding="0" border="0">
    207. 

  207.   <tr>
    208. 

  208.     <td>
    209. 

  209.       &nbsp;
    210. 

  210.     </td>
    211. 

  211.     <td>
    212. 

  212. 

  213. <p>
    214. 

  214. Returns the EventType code for this event. 
    215. 

  215. <p>
    216. 

  216. 

  217. <p>
    218. 

  218. Implements <a class="el" href="classaudiere_1_1Event.html#727a09b3ca1849eec92a938681fae5ff">audiere::Event</a>.
    219. 

  219. <p>
    220. 

  220. 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>.
    221. 

  221. <p>
    222. 

  222. References <a class="el" href="namespaceaudiere.html#4973d3ba192e6b538d5ebabfcd149ecb2aa1026644925598afc0eec091377629">audiere::ET_STOP</a>.    </td>
    223. 

  223.   </tr>
    224. 

  224. </table>
    225. 

  225. <hr>The documentation for this class was generated from the following file:<ul>
    226. 

  226. <li><a class="el" href="audiere_8h-source.html">audiere.h</a></ul>
    227. 

  227. <hr size="1"><address style="align: right;"><small>Generated on Mon Feb 13 23:08:45 2006 for audiere by&nbsp;
    228. 

  228. <a href="http://www.doxygen.org/index.html">
    229. 

  229. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
    230. 

  230. </body>
    231. 

  231. </html>
    232. 

  232.