<!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 Source File</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="headertitle"> <div class="title">IHandle.h</div> </div> </div><!--header--> <div class="contents"> <a href="IHandle_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2009-2016 Jörg Müller</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "<a class="code" href="Audaspace_8h.html">Audaspace.h</a>"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b"> 30</a></span> <span class="keyword">enum</span> <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  STATUS_INVALID = 0, </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9"> 33</a></span>  <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9">STATUS_PLAYING</a>, </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2"> 34</a></span>  <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2">STATUS_PAUSED</a>, </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa"> 35</a></span>  <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa">STATUS_STOPPED</a> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> };</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5"> 42</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a>)(<span class="keywordtype">void</span>*);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classIHandle.html"> 48</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classIHandle.html">IHandle</a></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classIHandle.html#a89bef702f304fc1e567e73096851ae7f"> 54</a></span>  <span class="keyword">virtual</span> <a class="code" href="classIHandle.html#a89bef702f304fc1e567e73096851ae7f">~IHandle</a>() {}</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> pause()=0;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> resume()=0;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> stop()=0;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getKeep()=0;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setKeep(<span class="keywordtype">bool</span> keep)=0;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> seek(<span class="keywordtype">float</span> position)=0;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> getPosition()=0;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">virtual</span> <a class="code" href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> getStatus()=0;</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> getVolume()=0;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setVolume(<span class="keywordtype">float</span> volume)=0;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> getPitch()=0;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setPitch(<span class="keywordtype">float</span> pitch)=0;</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> getLoopCount()=0;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setLoopCount(<span class="keywordtype">int</span> count)=0;</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> setStopCallback(<a class="code" href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a> callback = 0, <span class="keywordtype">void</span>* data = 0)=0;</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> };</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> </div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="Audaspace_8h_html_acd7584504197a1397aaf57af797e1813"><div class="ttname"><a href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define AUD_NAMESPACE_BEGIN</div><div class="ttdoc">Opens the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:116</div></div> <div class="ttc" id="Audaspace_8h_html_ad9080e3b9907fa3d0f5df561c65aa098"><div class="ttname"><a href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a></div><div class="ttdeci">#define AUD_API</div><div class="ttdoc">Used for exporting symbols in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:93</div></div> <div class="ttc" id="classIHandle_html_a89bef702f304fc1e567e73096851ae7f"><div class="ttname"><a href="classIHandle.html#a89bef702f304fc1e567e73096851ae7f">IHandle::~IHandle</a></div><div class="ttdeci">virtual ~IHandle()</div><div class="ttdoc">Destroys the handle.</div><div class="ttdef"><b>Definition:</b> IHandle.h:54</div></div> <div class="ttc" id="IHandle_8h_html_ad7147ffa399f8915e95b9e2eb94ca6e5"><div class="ttname"><a href="IHandle_8h.html#ad7147ffa399f8915e95b9e2eb94ca6e5">stopCallback</a></div><div class="ttdeci">void(* stopCallback)(void *)</div><div class="ttdoc">The stopCallback is called when a handle reaches the end of the stream and thus gets stopped.</div><div class="ttdef"><b>Definition:</b> IHandle.h:42</div></div> <div class="ttc" id="IHandle_8h_html_a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2"><div class="ttname"><a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba157de9df0aded1e3334734e780916bc2">STATUS_PAUSED</a></div><div class="ttdoc">Sound is playing.</div><div class="ttdef"><b>Definition:</b> IHandle.h:34</div></div> <div class="ttc" id="IHandle_8h_html_a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa"><div class="ttname"><a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba331a22c9674afd68e8de27851c174efa">STATUS_STOPPED</a></div><div class="ttdoc">Sound is being paused.</div><div class="ttdef"><b>Definition:</b> IHandle.h:35</div></div> <div class="ttc" id="Audaspace_8h_html_a4cf7088a9bb0256563f28fd13c80b066"><div class="ttname"><a href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttdeci">#define AUD_NAMESPACE_END</div><div class="ttdoc">Closes the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:119</div></div> <div class="ttc" id="classIHandle_html"><div class="ttname"><a href="classIHandle.html">IHandle</a></div><div class="ttdoc">The IHandle interface represents a playback handles of a specific device.</div><div class="ttdef"><b>Definition:</b> IHandle.h:48</div></div> <div class="ttc" id="Audaspace_8h_html"><div class="ttname"><a href="Audaspace_8h.html">Audaspace.h</a></div><div class="ttdoc">The main header file of the library defining the namespace and basic data types.</div></div> <div class="ttc" id="IHandle_8h_html_a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9"><div class="ttname"><a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70ba2760a68e8e3497589da0dac2ab6e3ec9">STATUS_PLAYING</a></div><div class="ttdoc">Invalid handle. Maybe due to stopping.</div><div class="ttdef"><b>Definition:</b> IHandle.h:33</div></div> <div class="ttc" id="IHandle_8h_html_a67a0db04d321a74b7e7fcfd3f1a3f70b"><div class="ttname"><a href="IHandle_8h.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></div><div class="ttdeci">Status</div><div class="ttdoc">Status of a playback handle.</div><div class="ttdef"><b>Definition:</b> IHandle.h:30</div></div> </div><!-- fragment --></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>