<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Audaspace: devices/IHandle.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_0ae5fd04a9b991f2c376fafa197d3147.html">devices</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#typedef-members">Typedefs</a> | <a href="#enum-members">Enumerations</a> </div> <div class="headertitle"> <div class="title">IHandle.h File Reference<div class="ingroups"><a class="el" href="group__devices.html">Devices</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Defines the <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> interface as well as possible states of the handle. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="Audaspace_8h_source.html">Audaspace.h</a>"</code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for IHandle.h:</div> <div class="dyncontent"> <div class="center"><img src="IHandle_8h__incl.png" border="0" usemap="#devices_2IHandle_8h" alt=""/></div> <map name="devices_2IHandle_8h" id="devices_2IHandle_8h"> <area shape="rect" title="Defines the IHandle interface as well as possible states of the handle." alt="" coords="5,5,136,32"/> <area shape="rect" href="Audaspace_8h.html" title="The main header file of the library defining the namespace and basic data types." alt="" coords="21,80,120,107"/> </map> </div> </div><div class="textblock"><div class="dynheader"> This graph shows which files directly or indirectly include this file:</div> <div class="dyncontent"> <div class="center"><img src="IHandle_8h__dep__incl.png" border="0" usemap="#devices_2IHandle_8hdep" alt=""/></div> <map name="devices_2IHandle_8hdep" id="devices_2IHandle_8hdep"> <area shape="rect" title="Defines the IHandle interface as well as possible states of the handle." alt="" coords="387,5,517,32"/> <area shape="rect" href="NULLDevice_8h.html" title="The NULLDevice class." alt="" coords="5,80,160,107"/> <area shape="rect" href="SoftwareDevice_8h.html" title="The SoftwareDevice class." alt="" coords="184,80,360,107"/> <area shape="rect" href="DynamicMusic_8h.html" title="The DynamicMusic class." alt="" coords="384,80,520,107"/> <area shape="rect" href="PlaybackCategory_8h.html" title="The PlaybackCategory class." alt="" coords="545,80,703,107"/> <area shape="rect" href="OpenALDevice_8h.html" title="The OpenALDevice class." alt="" coords="727,80,897,107"/> <area shape="rect" href="ReadDevice_8h.html" title="The ReadDevice class." alt="" coords="32,155,184,181"/> <area shape="rect" href="JackDevice_8h.html" title="The JackDevice class." alt="" coords="209,155,335,181"/> <area shape="rect" href="SDLDevice_8h.html" title="The SDLDevice class." alt="" coords="359,155,481,181"/> <area shape="rect" href="SequenceReader_8h.html" title="The SequenceReader class." alt="" coords="10,229,206,256"/> <area shape="rect" href="PlaybackManager_8h.html" title="The PlaybackManager class." alt="" coords="545,155,703,181"/> </map> </div> </div> <p><a href="IHandle_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="classIHandle.html">IHandle</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> interface represents a playback handles of a specific device. <a href="classIHandle.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ad7147ffa399f8915e95b9e2eb94ca6e5"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a>) (void *)</td></tr> <tr class="memdesc:ad7147ffa399f8915e95b9e2eb94ca6e5"><td class="mdescLeft"> </td><td class="mdescRight">The stopCallback is called when a handle reaches the end of the stream and thus gets stopped. <a href="#ad7147ffa399f8915e95b9e2eb94ca6e5">More...</a><br /></td></tr> <tr class="separator:ad7147ffa399f8915e95b9e2eb94ca6e5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <b>STATUS_INVALID</b> = 0, <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9">STATUS_PLAYING</a>, <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2">STATUS_PAUSED</a>, <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa">STATUS_STOPPED</a> }</td></tr> <tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft"> </td><td class="mdescRight">Status of a playback handle. <a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr> <tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Defines the <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> interface as well as possible states of the handle. </p> </div><h2 class="groupheader">Typedef Documentation</h2> <a id="ad7147ffa399f8915e95b9e2eb94ca6e5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad7147ffa399f8915e95b9e2eb94ca6e5">◆ </a></span>stopCallback</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef void(* stopCallback) (void *)</td> </tr> </table> </div><div class="memdoc"> <p>The stopCallback is called when a handle reaches the end of the stream and thus gets stopped. </p> <p>A user defined pointer is supplied to the callback. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">◆ </a></span>Status</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td> </tr> </table> </div><div class="memdoc"> <p>Status of a playback handle. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9"></a>STATUS_PLAYING </td><td class="fielddoc"><p>Invalid handle. Maybe due to stopping. </p> </td></tr> <tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2"></a>STATUS_PAUSED </td><td class="fielddoc"><p>Sound is playing. </p> </td></tr> <tr><td class="fieldname"><a id="a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa"></a>STATUS_STOPPED </td><td class="fielddoc"><p>Sound is being paused. </p> <p>Sound is stopped but kept in the device. </p> </td></tr> </table> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>