classoboe_1_1_default_stream_values.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.15"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Oboe: oboe::DefaultStreamValues Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">Oboe
  25. &#160;<span id="projectnumber">1.2</span>
  26. </div>
  27. <div id="projectbrief">A library for creating real-time audio apps on Android</div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.15 -->
  35. <script type="text/javascript">
  36. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. /* @license-end */
  39. </script>
  40. <script type="text/javascript" src="menudata.js"></script>
  41. <script type="text/javascript" src="menu.js"></script>
  42. <script type="text/javascript">
  43. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  44. $(function() {
  45. initMenu('',true,false,'search.php','Search');
  46. $(document).ready(function() { init_search(); });
  47. });
  48. /* @license-end */</script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <iframe src="javascript:void(0)" frameborder="0"
  59. name="MSearchResults" id="MSearchResults">
  60. </iframe>
  61. </div>
  62. <div id="nav-path" class="navpath">
  63. <ul>
  64. <li class="navelem"><a class="el" href="namespaceoboe.html">oboe</a></li><li class="navelem"><a class="el" href="classoboe_1_1_default_stream_values.html">DefaultStreamValues</a></li> </ul>
  65. </div>
  66. </div><!-- top -->
  67. <div class="header">
  68. <div class="summary">
  69. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  70. <a href="classoboe_1_1_default_stream_values-members.html">List of all members</a> </div>
  71. <div class="headertitle">
  72. <div class="title">oboe::DefaultStreamValues Class Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p><code>#include &lt;<a class="el" href="_definitions_8h_source.html">Definitions.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
  78. Static Public Attributes</h2></td></tr>
  79. <tr class="memitem:a46a5d9a653f2153f618cadcab764e1b1"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_default_stream_values.html#a46a5d9a653f2153f618cadcab764e1b1">SampleRate</a></td></tr>
  80. <tr class="separator:a46a5d9a653f2153f618cadcab764e1b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ab5ea5576699cebc56193f5c297d3e300"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_default_stream_values.html#ab5ea5576699cebc56193f5c297d3e300">FramesPerBurst</a></td></tr>
  82. <tr class="separator:ab5ea5576699cebc56193f5c297d3e300"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ad5dce538d5963c81bf58350ab730962d"><td class="memItemLeft" align="right" valign="top">static int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_default_stream_values.html#ad5dce538d5963c81bf58350ab730962d">ChannelCount</a></td></tr>
  84. <tr class="separator:ad5dce538d5963c81bf58350ab730962d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table>
  86. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  87. <div class="textblock"><p>On API 16 to 26 OpenSL ES will be used. When using OpenSL ES the optimal values for sampleRate and framesPerBurst are not known by the native code. On API 17+ these values should be obtained from the AudioManager using this code:</p>
  88. <pre><code>
  89. // Note that this technique only works for built-in speakers and headphones.
  90. AudioManager myAudioMgr = (AudioManager) getSystemService(Context.AUDIO_SERVICE);
  91. String sampleRateStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_SAMPLE_RATE);
  92. int defaultSampleRate = Integer.parseInt(sampleRateStr);
  93. String framesPerBurstStr = myAudioMgr.getProperty(AudioManager.PROPERTY_OUTPUT_FRAMES_PER_BUFFER);
  94. int defaultFramesPerBurst = Integer.parseInt(framesPerBurstStr);
  95. </code></pre><p>It can then be passed down to Oboe through JNI.</p>
  96. <p>AAudio will get the optimal framesPerBurst from the HAL and will ignore this value. </p>
  97. </div><h2 class="groupheader">Member Data Documentation</h2>
  98. <a id="ad5dce538d5963c81bf58350ab730962d"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#ad5dce538d5963c81bf58350ab730962d">&#9670;&nbsp;</a></span>ChannelCount</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="mlabels">
  103. <tr>
  104. <td class="mlabels-left">
  105. <table class="memname">
  106. <tr>
  107. <td class="memname">int32_t oboe::DefaultStreamValues::ChannelCount</td>
  108. </tr>
  109. </table>
  110. </td>
  111. <td class="mlabels-right">
  112. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  113. </tr>
  114. </table>
  115. </div><div class="memdoc">
  116. <p>The default channel count to use when opening new audio streams </p>
  117. </div>
  118. </div>
  119. <a id="ab5ea5576699cebc56193f5c297d3e300"></a>
  120. <h2 class="memtitle"><span class="permalink"><a href="#ab5ea5576699cebc56193f5c297d3e300">&#9670;&nbsp;</a></span>FramesPerBurst</h2>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="mlabels">
  124. <tr>
  125. <td class="mlabels-left">
  126. <table class="memname">
  127. <tr>
  128. <td class="memname">int32_t oboe::DefaultStreamValues::FramesPerBurst</td>
  129. </tr>
  130. </table>
  131. </td>
  132. <td class="mlabels-right">
  133. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  134. </tr>
  135. </table>
  136. </div><div class="memdoc">
  137. <p>The default frames per burst to use when opening new audio streams </p>
  138. </div>
  139. </div>
  140. <a id="a46a5d9a653f2153f618cadcab764e1b1"></a>
  141. <h2 class="memtitle"><span class="permalink"><a href="#a46a5d9a653f2153f618cadcab764e1b1">&#9670;&nbsp;</a></span>SampleRate</h2>
  142. <div class="memitem">
  143. <div class="memproto">
  144. <table class="mlabels">
  145. <tr>
  146. <td class="mlabels-left">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">int32_t oboe::DefaultStreamValues::SampleRate</td>
  150. </tr>
  151. </table>
  152. </td>
  153. <td class="mlabels-right">
  154. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>The default sample rate to use when opening new audio streams </p>
  159. </div>
  160. </div>
  161. <hr/>The documentation for this class was generated from the following file:<ul>
  162. <li>include/oboe/<a class="el" href="_definitions_8h_source.html">Definitions.h</a></li>
  163. </ul>
  164. </div><!-- contents -->
  165. <!-- start footer part -->
  166. <hr class="footer"/><address class="footer"><small>
  167. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  168. <img class="footer" src="doxygen.png" alt="doxygen"/>
  169. </a> 1.8.15
  170. </small></address>
  171. </body>
  172. </html>