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::AudioStreamBase 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  <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&dn=gpl-2.0.txt GPL-v2 */ 37var 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&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 57<!-- iframe showing the search results (closed by default) --> 58<div id="MSearchResultsWindow"> 59<iframe src="javascript:void(0)" frameborder="0" 60 name="MSearchResults" id="MSearchResults"> 61</iframe> 62</div> 63 64<div id="nav-path" class="navpath"> 65 <ul> 66<li class="navelem"><a class="el" href="namespaceoboe.html">oboe</a></li><li class="navelem"><a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a></li> </ul> 67</div> 68</div><!-- top --> 69<div class="header"> 70 <div class="summary"> 71<a href="#pub-methods">Public Member Functions</a> | 72<a href="#pro-attribs">Protected Attributes</a> | 73<a href="classoboe_1_1_audio_stream_base-members.html">List of all members</a> </div> 74 <div class="headertitle"> 75<div class="title">oboe::AudioStreamBase Class Reference</div> </div> 76</div><!--header--> 77<div class="contents"> 78 79<p><code>#include <<a class="el" href="_audio_stream_base_8h_source.html">AudioStreamBase.h</a>></code></p> 80<div class="dynheader"> 81Inheritance diagram for oboe::AudioStreamBase:</div> 82<div class="dyncontent"> 83 <div class="center"> 84 <img src="classoboe_1_1_audio_stream_base.png" usemap="#oboe::AudioStreamBase_map" alt=""/> 85 <map id="oboe::AudioStreamBase_map" name="oboe::AudioStreamBase_map"> 86<area href="classoboe_1_1_audio_stream.html" alt="oboe::AudioStream" shape="rect" coords="0,56,158,80"/> 87<area href="classoboe_1_1_audio_stream_builder.html" alt="oboe::AudioStreamBuilder" shape="rect" coords="168,56,326,80"/> 88 </map> 89</div></div> 90<table class="memberdecls"> 91<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 92Public Member Functions</h2></td></tr> 93<tr class="memitem:aa6b103e1b0f808bbc4949d56f0829f98"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#aa6b103e1b0f808bbc4949d56f0829f98">AudioStreamBase</a> (const <a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a> &)=default</td></tr> 94<tr class="separator:aa6b103e1b0f808bbc4949d56f0829f98"><td class="memSeparator" colspan="2"> </td></tr> 95<tr class="memitem:aa9c987a59555d7a60b9f7a63f4afc7fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#aa9c987a59555d7a60b9f7a63f4afc7fc">operator=</a> (const <a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a> &)=default</td></tr> 96<tr class="separator:aa9c987a59555d7a60b9f7a63f4afc7fc"><td class="memSeparator" colspan="2"> </td></tr> 97<tr class="memitem:a87e6bf37d6a2a5e983b8ca8d29aea575"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a87e6bf37d6a2a5e983b8ca8d29aea575">getChannelCount</a> () const</td></tr> 98<tr class="separator:a87e6bf37d6a2a5e983b8ca8d29aea575"><td class="memSeparator" colspan="2"> </td></tr> 99<tr class="memitem:a6f86f2233a04c5a0b056f0c1c261f1b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5ae">Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a6f86f2233a04c5a0b056f0c1c261f1b1">getDirection</a> () const</td></tr> 100<tr class="separator:a6f86f2233a04c5a0b056f0c1c261f1b1"><td class="memSeparator" colspan="2"> </td></tr> 101<tr class="memitem:ae9d32f3e09174bad69e74f147ee33087"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ae9d32f3e09174bad69e74f147ee33087">getSampleRate</a> () const</td></tr> 102<tr class="separator:ae9d32f3e09174bad69e74f147ee33087"><td class="memSeparator" colspan="2"> </td></tr> 103<tr class="memitem:a8878a90949badbb5486cc2e022a57086"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a8878a90949badbb5486cc2e022a57086">getFramesPerCallback</a> () const</td></tr> 104<tr class="separator:a8878a90949badbb5486cc2e022a57086"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:ab1e640461d7bf9d596decb913da7ac86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a92afc593e856571aacbfd02e57075df6">AudioFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ab1e640461d7bf9d596decb913da7ac86">getFormat</a> () const</td></tr> 106<tr class="separator:ab1e640461d7bf9d596decb913da7ac86"><td class="memSeparator" colspan="2"> </td></tr> 107<tr class="memitem:af5217ab05bfde0d7637024b599302d0b"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#af5217ab05bfde0d7637024b599302d0b">getBufferSizeInFrames</a> ()</td></tr> 108<tr class="separator:af5217ab05bfde0d7637024b599302d0b"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:ab1531253e64aaebe9e9eddbafb9098fc"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ab1531253e64aaebe9e9eddbafb9098fc">getBufferCapacityInFrames</a> () const</td></tr> 110<tr class="separator:ab1531253e64aaebe9e9eddbafb9098fc"><td class="memSeparator" colspan="2"> </td></tr> 111<tr class="memitem:a1fb033fc963f971bd1aa8f6707e49b41"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520">SharingMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a1fb033fc963f971bd1aa8f6707e49b41">getSharingMode</a> () const</td></tr> 112<tr class="separator:a1fb033fc963f971bd1aa8f6707e49b41"><td class="memSeparator" colspan="2"> </td></tr> 113<tr class="memitem:a2ddb935de0e24dd7ae8e2cfbecac9fdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a1068781f3920654b1bfd7ed136468184">PerformanceMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a2ddb935de0e24dd7ae8e2cfbecac9fdc">getPerformanceMode</a> () const</td></tr> 114<tr class="separator:a2ddb935de0e24dd7ae8e2cfbecac9fdc"><td class="memSeparator" colspan="2"> </td></tr> 115<tr class="memitem:a093057d625bc896864b959974c265f21"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a093057d625bc896864b959974c265f21">getDeviceId</a> () const</td></tr> 116<tr class="separator:a093057d625bc896864b959974c265f21"><td class="memSeparator" colspan="2"> </td></tr> 117<tr class="memitem:a1b4a2a191546708da657510c3cd6b797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoboe_1_1_audio_stream_callback.html">AudioStreamCallback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a1b4a2a191546708da657510c3cd6b797">getCallback</a> () const</td></tr> 118<tr class="separator:a1b4a2a191546708da657510c3cd6b797"><td class="memSeparator" colspan="2"> </td></tr> 119<tr class="memitem:a0bcfb2f8bd11c92b541fd910da9af397"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0">Usage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a0bcfb2f8bd11c92b541fd910da9af397">getUsage</a> () const</td></tr> 120<tr class="separator:a0bcfb2f8bd11c92b541fd910da9af397"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:ab12e2d068fa87e0553b01a400d96eb82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a2a3cec6f021c1a324df60273710c604b">ContentType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ab12e2d068fa87e0553b01a400d96eb82">getContentType</a> () const</td></tr> 122<tr class="separator:ab12e2d068fa87e0553b01a400d96eb82"><td class="memSeparator" colspan="2"> </td></tr> 123<tr class="memitem:a5c773b93b8aa38191c7199cab023428a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a4477ed232b02e2694d9309baf55a8f06">InputPreset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a5c773b93b8aa38191c7199cab023428a">getInputPreset</a> () const</td></tr> 124<tr class="separator:a5c773b93b8aa38191c7199cab023428a"><td class="memSeparator" colspan="2"> </td></tr> 125<tr class="memitem:aa3c502ce09bbad7690a2dd6acaf8892e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#aa3c502ce09bbad7690a2dd6acaf8892e">getSessionId</a> () const</td></tr> 126<tr class="separator:aa3c502ce09bbad7690a2dd6acaf8892e"><td class="memSeparator" colspan="2"> </td></tr> 127<tr class="memitem:aa4ec3aa76e69350fbce6f00786211495"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#aa4ec3aa76e69350fbce6f00786211495">isChannelConversionAllowed</a> () const</td></tr> 128<tr class="separator:aa4ec3aa76e69350fbce6f00786211495"><td class="memSeparator" colspan="2"> </td></tr> 129<tr class="memitem:ace3625a7332bf02a86818fdf63fcccb4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ace3625a7332bf02a86818fdf63fcccb4">isFormatConversionAllowed</a> () const</td></tr> 130<tr class="separator:ace3625a7332bf02a86818fdf63fcccb4"><td class="memSeparator" colspan="2"> </td></tr> 131<tr class="memitem:a1de8d6982d411a0cf50a32efba0ca3f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a82f3720eba7654aceb7282be36f9ff1d">SampleRateConversionQuality</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a1de8d6982d411a0cf50a32efba0ca3f2">getSampleRateConversionQuality</a> () const</td></tr> 132<tr class="separator:a1de8d6982d411a0cf50a32efba0ca3f2"><td class="memSeparator" colspan="2"> </td></tr> 133</table><table class="memberdecls"> 134<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> 135Protected Attributes</h2></td></tr> 136<tr class="memitem:ae3f72318212dd9977d7fa0ced92c91f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classoboe_1_1_audio_stream_callback.html">AudioStreamCallback</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ae3f72318212dd9977d7fa0ced92c91f4">mStreamCallback</a> = nullptr</td></tr> 137<tr class="separator:ae3f72318212dd9977d7fa0ced92c91f4"><td class="memSeparator" colspan="2"> </td></tr> 138<tr class="memitem:a3962eb94420ad0ecea70029236001899"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a3962eb94420ad0ecea70029236001899">mFramesPerCallback</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 139<tr class="separator:a3962eb94420ad0ecea70029236001899"><td class="memSeparator" colspan="2"> </td></tr> 140<tr class="memitem:a5ff460bac9d14dfeac4eeddfcbb6e206"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a5ff460bac9d14dfeac4eeddfcbb6e206">mChannelCount</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 141<tr class="separator:a5ff460bac9d14dfeac4eeddfcbb6e206"><td class="memSeparator" colspan="2"> </td></tr> 142<tr class="memitem:a998885bb6c4f37e145f4626ad4177dea"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a998885bb6c4f37e145f4626ad4177dea">mSampleRate</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 143<tr class="separator:a998885bb6c4f37e145f4626ad4177dea"><td class="memSeparator" colspan="2"> </td></tr> 144<tr class="memitem:a23dafa12fb1a6242b088ebd5a52798c8"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a23dafa12fb1a6242b088ebd5a52798c8">mDeviceId</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 145<tr class="separator:a23dafa12fb1a6242b088ebd5a52798c8"><td class="memSeparator" colspan="2"> </td></tr> 146<tr class="memitem:ac81d4719b350f8138aad1af38f0873b6"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ac81d4719b350f8138aad1af38f0873b6">mBufferCapacityInFrames</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 147<tr class="separator:ac81d4719b350f8138aad1af38f0873b6"><td class="memSeparator" colspan="2"> </td></tr> 148<tr class="memitem:a3b65595d26d1eae1b8ce9925a5b98f6a"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a3b65595d26d1eae1b8ce9925a5b98f6a">mBufferSizeInFrames</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 149<tr class="separator:a3b65595d26d1eae1b8ce9925a5b98f6a"><td class="memSeparator" colspan="2"> </td></tr> 150<tr class="memitem:a54061319ed348329a29d883a5de2482e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a54061319ed348329a29d883a5de2482e">mFramesPerBurst</a> = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td></tr> 151<tr class="separator:a54061319ed348329a29d883a5de2482e"><td class="memSeparator" colspan="2"> </td></tr> 152<tr class="memitem:ae9187492b679c97a0963e264954be473"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520">SharingMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ae9187492b679c97a0963e264954be473">mSharingMode</a> = <a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520aa6156ea9d66fef24e87e841fbabf7cca">SharingMode::Shared</a></td></tr> 153<tr class="separator:ae9187492b679c97a0963e264954be473"><td class="memSeparator" colspan="2"> </td></tr> 154<tr class="memitem:a7869f04836c2c2bdc10c7309ad4b8e09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a92afc593e856571aacbfd02e57075df6">AudioFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a7869f04836c2c2bdc10c7309ad4b8e09">mFormat</a> = AudioFormat::Unspecified</td></tr> 155<tr class="separator:a7869f04836c2c2bdc10c7309ad4b8e09"><td class="memSeparator" colspan="2"> </td></tr> 156<tr class="memitem:a26e9294721561d3b16bcaeec5faf4880"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5ae">Direction</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a26e9294721561d3b16bcaeec5faf4880">mDirection</a> = <a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5aea29c2c02a361c9d7028472e5d92cd4a54">Direction::Output</a></td></tr> 157<tr class="separator:a26e9294721561d3b16bcaeec5faf4880"><td class="memSeparator" colspan="2"> </td></tr> 158<tr class="memitem:ab99671c2d0552557e75dc7b4afe91765"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a1068781f3920654b1bfd7ed136468184">PerformanceMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#ab99671c2d0552557e75dc7b4afe91765">mPerformanceMode</a> = PerformanceMode::None</td></tr> 159<tr class="separator:ab99671c2d0552557e75dc7b4afe91765"><td class="memSeparator" colspan="2"> </td></tr> 160<tr class="memitem:a5b518e82f39c9fcbd7050fd66adb253c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0">Usage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a5b518e82f39c9fcbd7050fd66adb253c">mUsage</a> = <a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0a3b563524fdb17b4a86590470d40bef74">Usage::Media</a></td></tr> 161<tr class="separator:a5b518e82f39c9fcbd7050fd66adb253c"><td class="memSeparator" colspan="2"> </td></tr> 162<tr class="memitem:a5f8f0e5add381b841856de80ea4cdb2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a2a3cec6f021c1a324df60273710c604b">ContentType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a5f8f0e5add381b841856de80ea4cdb2b">mContentType</a> = ContentType::Music</td></tr> 163<tr class="separator:a5f8f0e5add381b841856de80ea4cdb2b"><td class="memSeparator" colspan="2"> </td></tr> 164<tr class="memitem:a1e5d4f5b30c4cc36f81ffd858cc00589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a4477ed232b02e2694d9309baf55a8f06">InputPreset</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#a1e5d4f5b30c4cc36f81ffd858cc00589">mInputPreset</a> = InputPreset::VoiceRecognition</td></tr> 165<tr class="separator:a1e5d4f5b30c4cc36f81ffd858cc00589"><td class="memSeparator" colspan="2"> </td></tr> 166<tr class="memitem:abe1c1e9cada1ced9b5c1504ac9b07737"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceoboe.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classoboe_1_1_audio_stream_base.html#abe1c1e9cada1ced9b5c1504ac9b07737">mSessionId</a> = SessionId::None</td></tr> 167<tr class="separator:abe1c1e9cada1ced9b5c1504ac9b07737"><td class="memSeparator" colspan="2"> </td></tr> 168<tr class="memitem:ae47a39b573250751f933dd159d09bf0f"><td class="memItemLeft" align="right" valign="top"><a id="ae47a39b573250751f933dd159d09bf0f"></a> 169bool </td><td class="memItemRight" valign="bottom"><b>mChannelConversionAllowed</b> = false</td></tr> 170<tr class="separator:ae47a39b573250751f933dd159d09bf0f"><td class="memSeparator" colspan="2"> </td></tr> 171<tr class="memitem:a9394a88eb5f8b74fa72eabf28f403f87"><td class="memItemLeft" align="right" valign="top"><a id="a9394a88eb5f8b74fa72eabf28f403f87"></a> 172bool </td><td class="memItemRight" valign="bottom"><b>mFormatConversionAllowed</b> = false</td></tr> 173<tr class="separator:a9394a88eb5f8b74fa72eabf28f403f87"><td class="memSeparator" colspan="2"> </td></tr> 174<tr class="memitem:a2dd35a6f009f36172838260144218f6d"><td class="memItemLeft" align="right" valign="top"><a id="a2dd35a6f009f36172838260144218f6d"></a> 175<a class="el" href="namespaceoboe.html#a82f3720eba7654aceb7282be36f9ff1d">SampleRateConversionQuality</a> </td><td class="memItemRight" valign="bottom"><b>mSampleRateConversionQuality</b> = SampleRateConversionQuality::None</td></tr> 176<tr class="separator:a2dd35a6f009f36172838260144218f6d"><td class="memSeparator" colspan="2"> </td></tr> 177</table> 178<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 179<div class="textblock"><p>Base class containing parameters for audio streams and builders. </p> 180</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> 181<a id="aa6b103e1b0f808bbc4949d56f0829f98"></a> 182<h2 class="memtitle"><span class="permalink"><a href="#aa6b103e1b0f808bbc4949d56f0829f98">◆ </a></span>AudioStreamBase()</h2> 183 184<div class="memitem"> 185<div class="memproto"> 186<table class="mlabels"> 187 <tr> 188 <td class="mlabels-left"> 189 <table class="memname"> 190 <tr> 191 <td class="memname">oboe::AudioStreamBase::AudioStreamBase </td> 192 <td>(</td> 193 <td class="paramtype">const <a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a> & </td> 194 <td class="paramname"></td><td>)</td> 195 <td></td> 196 </tr> 197 </table> 198 </td> 199 <td class="mlabels-right"> 200<span class="mlabels"><span class="mlabel">default</span></span> </td> 201 </tr> 202</table> 203</div><div class="memdoc"> 204<p>Default copy constructor </p> 205 206</div> 207</div> 208<h2 class="groupheader">Member Function Documentation</h2> 209<a id="ab1531253e64aaebe9e9eddbafb9098fc"></a> 210<h2 class="memtitle"><span class="permalink"><a href="#ab1531253e64aaebe9e9eddbafb9098fc">◆ </a></span>getBufferCapacityInFrames()</h2> 211 212<div class="memitem"> 213<div class="memproto"> 214<table class="mlabels"> 215 <tr> 216 <td class="mlabels-left"> 217 <table class="memname"> 218 <tr> 219 <td class="memname">virtual int32_t oboe::AudioStreamBase::getBufferCapacityInFrames </td> 220 <td>(</td> 221 <td class="paramname"></td><td>)</td> 222 <td> const</td> 223 </tr> 224 </table> 225 </td> 226 <td class="mlabels-right"> 227<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> 228 </tr> 229</table> 230</div><div class="memdoc"> 231<dl class="section return"><dt>Returns</dt><dd>capacityInFrames or kUnspecified </dd></dl> 232 233</div> 234</div> 235<a id="af5217ab05bfde0d7637024b599302d0b"></a> 236<h2 class="memtitle"><span class="permalink"><a href="#af5217ab05bfde0d7637024b599302d0b">◆ </a></span>getBufferSizeInFrames()</h2> 237 238<div class="memitem"> 239<div class="memproto"> 240<table class="mlabels"> 241 <tr> 242 <td class="mlabels-left"> 243 <table class="memname"> 244 <tr> 245 <td class="memname">virtual int32_t oboe::AudioStreamBase::getBufferSizeInFrames </td> 246 <td>(</td> 247 <td class="paramname"></td><td>)</td> 248 <td></td> 249 </tr> 250 </table> 251 </td> 252 <td class="mlabels-right"> 253<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> 254 </tr> 255</table> 256</div><div class="memdoc"> 257<p>Query the maximum number of frames that can be filled without blocking. If the stream has been closed the last known value will be returned.</p> 258<dl class="section return"><dt>Returns</dt><dd>buffer size </dd></dl> 259 260</div> 261</div> 262<a id="a1b4a2a191546708da657510c3cd6b797"></a> 263<h2 class="memtitle"><span class="permalink"><a href="#a1b4a2a191546708da657510c3cd6b797">◆ </a></span>getCallback()</h2> 264 265<div class="memitem"> 266<div class="memproto"> 267<table class="mlabels"> 268 <tr> 269 <td class="mlabels-left"> 270 <table class="memname"> 271 <tr> 272 <td class="memname"><a class="el" href="classoboe_1_1_audio_stream_callback.html">AudioStreamCallback</a>* oboe::AudioStreamBase::getCallback </td> 273 <td>(</td> 274 <td class="paramname"></td><td>)</td> 275 <td> const</td> 276 </tr> 277 </table> 278 </td> 279 <td class="mlabels-right"> 280<span class="mlabels"><span class="mlabel">inline</span></span> </td> 281 </tr> 282</table> 283</div><div class="memdoc"> 284<dl class="section return"><dt>Returns</dt><dd>the callback object for this stream, if set. </dd></dl> 285 286</div> 287</div> 288<a id="a87e6bf37d6a2a5e983b8ca8d29aea575"></a> 289<h2 class="memtitle"><span class="permalink"><a href="#a87e6bf37d6a2a5e983b8ca8d29aea575">◆ </a></span>getChannelCount()</h2> 290 291<div class="memitem"> 292<div class="memproto"> 293<table class="mlabels"> 294 <tr> 295 <td class="mlabels-left"> 296 <table class="memname"> 297 <tr> 298 <td class="memname">int32_t oboe::AudioStreamBase::getChannelCount </td> 299 <td>(</td> 300 <td class="paramname"></td><td>)</td> 301 <td> const</td> 302 </tr> 303 </table> 304 </td> 305 <td class="mlabels-right"> 306<span class="mlabels"><span class="mlabel">inline</span></span> </td> 307 </tr> 308</table> 309</div><div class="memdoc"> 310<dl class="section return"><dt>Returns</dt><dd>number of channels, for example 2 for stereo, or kUnspecified </dd></dl> 311 312</div> 313</div> 314<a id="ab12e2d068fa87e0553b01a400d96eb82"></a> 315<h2 class="memtitle"><span class="permalink"><a href="#ab12e2d068fa87e0553b01a400d96eb82">◆ </a></span>getContentType()</h2> 316 317<div class="memitem"> 318<div class="memproto"> 319<table class="mlabels"> 320 <tr> 321 <td class="mlabels-left"> 322 <table class="memname"> 323 <tr> 324 <td class="memname"><a class="el" href="namespaceoboe.html#a2a3cec6f021c1a324df60273710c604b">ContentType</a> oboe::AudioStreamBase::getContentType </td> 325 <td>(</td> 326 <td class="paramname"></td><td>)</td> 327 <td> const</td> 328 </tr> 329 </table> 330 </td> 331 <td class="mlabels-right"> 332<span class="mlabels"><span class="mlabel">inline</span></span> </td> 333 </tr> 334</table> 335</div><div class="memdoc"> 336<dl class="section return"><dt>Returns</dt><dd>the stream's content type. </dd></dl> 337 338</div> 339</div> 340<a id="a093057d625bc896864b959974c265f21"></a> 341<h2 class="memtitle"><span class="permalink"><a href="#a093057d625bc896864b959974c265f21">◆ </a></span>getDeviceId()</h2> 342 343<div class="memitem"> 344<div class="memproto"> 345<table class="mlabels"> 346 <tr> 347 <td class="mlabels-left"> 348 <table class="memname"> 349 <tr> 350 <td class="memname">int32_t oboe::AudioStreamBase::getDeviceId </td> 351 <td>(</td> 352 <td class="paramname"></td><td>)</td> 353 <td> const</td> 354 </tr> 355 </table> 356 </td> 357 <td class="mlabels-right"> 358<span class="mlabels"><span class="mlabel">inline</span></span> </td> 359 </tr> 360</table> 361</div><div class="memdoc"> 362<dl class="section return"><dt>Returns</dt><dd>the device ID of the stream. </dd></dl> 363 364</div> 365</div> 366<a id="a6f86f2233a04c5a0b056f0c1c261f1b1"></a> 367<h2 class="memtitle"><span class="permalink"><a href="#a6f86f2233a04c5a0b056f0c1c261f1b1">◆ </a></span>getDirection()</h2> 368 369<div class="memitem"> 370<div class="memproto"> 371<table class="mlabels"> 372 <tr> 373 <td class="mlabels-left"> 374 <table class="memname"> 375 <tr> 376 <td class="memname"><a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5ae">Direction</a> oboe::AudioStreamBase::getDirection </td> 377 <td>(</td> 378 <td class="paramname"></td><td>)</td> 379 <td> const</td> 380 </tr> 381 </table> 382 </td> 383 <td class="mlabels-right"> 384<span class="mlabels"><span class="mlabel">inline</span></span> </td> 385 </tr> 386</table> 387</div><div class="memdoc"> 388<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5aea324118a6721dd6b8a9b9f4e327df2bf5">Direction::Input</a> or <a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5aea29c2c02a361c9d7028472e5d92cd4a54">Direction::Output</a> </dd></dl> 389 390</div> 391</div> 392<a id="ab1e640461d7bf9d596decb913da7ac86"></a> 393<h2 class="memtitle"><span class="permalink"><a href="#ab1e640461d7bf9d596decb913da7ac86">◆ </a></span>getFormat()</h2> 394 395<div class="memitem"> 396<div class="memproto"> 397<table class="mlabels"> 398 <tr> 399 <td class="mlabels-left"> 400 <table class="memname"> 401 <tr> 402 <td class="memname"><a class="el" href="namespaceoboe.html#a92afc593e856571aacbfd02e57075df6">AudioFormat</a> oboe::AudioStreamBase::getFormat </td> 403 <td>(</td> 404 <td class="paramname"></td><td>)</td> 405 <td> const</td> 406 </tr> 407 </table> 408 </td> 409 <td class="mlabels-right"> 410<span class="mlabels"><span class="mlabel">inline</span></span> </td> 411 </tr> 412</table> 413</div><div class="memdoc"> 414<dl class="section return"><dt>Returns</dt><dd>the audio sample format (e.g. Float or I16) </dd></dl> 415 416</div> 417</div> 418<a id="a8878a90949badbb5486cc2e022a57086"></a> 419<h2 class="memtitle"><span class="permalink"><a href="#a8878a90949badbb5486cc2e022a57086">◆ </a></span>getFramesPerCallback()</h2> 420 421<div class="memitem"> 422<div class="memproto"> 423<table class="mlabels"> 424 <tr> 425 <td class="mlabels-left"> 426 <table class="memname"> 427 <tr> 428 <td class="memname">int32_t oboe::AudioStreamBase::getFramesPerCallback </td> 429 <td>(</td> 430 <td class="paramname"></td><td>)</td> 431 <td> const</td> 432 </tr> 433 </table> 434 </td> 435 <td class="mlabels-right"> 436<span class="mlabels"><span class="mlabel">inline</span></span> </td> 437 </tr> 438</table> 439</div><div class="memdoc"> 440<dl class="section return"><dt>Returns</dt><dd>the number of frames in each callback or kUnspecified. </dd></dl> 441 442</div> 443</div> 444<a id="a5c773b93b8aa38191c7199cab023428a"></a> 445<h2 class="memtitle"><span class="permalink"><a href="#a5c773b93b8aa38191c7199cab023428a">◆ </a></span>getInputPreset()</h2> 446 447<div class="memitem"> 448<div class="memproto"> 449<table class="mlabels"> 450 <tr> 451 <td class="mlabels-left"> 452 <table class="memname"> 453 <tr> 454 <td class="memname"><a class="el" href="namespaceoboe.html#a4477ed232b02e2694d9309baf55a8f06">InputPreset</a> oboe::AudioStreamBase::getInputPreset </td> 455 <td>(</td> 456 <td class="paramname"></td><td>)</td> 457 <td> const</td> 458 </tr> 459 </table> 460 </td> 461 <td class="mlabels-right"> 462<span class="mlabels"><span class="mlabel">inline</span></span> </td> 463 </tr> 464</table> 465</div><div class="memdoc"> 466<dl class="section return"><dt>Returns</dt><dd>the stream's input preset. </dd></dl> 467 468</div> 469</div> 470<a id="a2ddb935de0e24dd7ae8e2cfbecac9fdc"></a> 471<h2 class="memtitle"><span class="permalink"><a href="#a2ddb935de0e24dd7ae8e2cfbecac9fdc">◆ </a></span>getPerformanceMode()</h2> 472 473<div class="memitem"> 474<div class="memproto"> 475<table class="mlabels"> 476 <tr> 477 <td class="mlabels-left"> 478 <table class="memname"> 479 <tr> 480 <td class="memname"><a class="el" href="namespaceoboe.html#a1068781f3920654b1bfd7ed136468184">PerformanceMode</a> oboe::AudioStreamBase::getPerformanceMode </td> 481 <td>(</td> 482 <td class="paramname"></td><td>)</td> 483 <td> const</td> 484 </tr> 485 </table> 486 </td> 487 <td class="mlabels-right"> 488<span class="mlabels"><span class="mlabel">inline</span></span> </td> 489 </tr> 490</table> 491</div><div class="memdoc"> 492<dl class="section return"><dt>Returns</dt><dd>the performance mode of the stream. </dd></dl> 493 494</div> 495</div> 496<a id="ae9d32f3e09174bad69e74f147ee33087"></a> 497<h2 class="memtitle"><span class="permalink"><a href="#ae9d32f3e09174bad69e74f147ee33087">◆ </a></span>getSampleRate()</h2> 498 499<div class="memitem"> 500<div class="memproto"> 501<table class="mlabels"> 502 <tr> 503 <td class="mlabels-left"> 504 <table class="memname"> 505 <tr> 506 <td class="memname">int32_t oboe::AudioStreamBase::getSampleRate </td> 507 <td>(</td> 508 <td class="paramname"></td><td>)</td> 509 <td> const</td> 510 </tr> 511 </table> 512 </td> 513 <td class="mlabels-right"> 514<span class="mlabels"><span class="mlabel">inline</span></span> </td> 515 </tr> 516</table> 517</div><div class="memdoc"> 518<dl class="section return"><dt>Returns</dt><dd>sample rate for the stream or kUnspecified </dd></dl> 519 520</div> 521</div> 522<a id="a1de8d6982d411a0cf50a32efba0ca3f2"></a> 523<h2 class="memtitle"><span class="permalink"><a href="#a1de8d6982d411a0cf50a32efba0ca3f2">◆ </a></span>getSampleRateConversionQuality()</h2> 524 525<div class="memitem"> 526<div class="memproto"> 527<table class="mlabels"> 528 <tr> 529 <td class="mlabels-left"> 530 <table class="memname"> 531 <tr> 532 <td class="memname"><a class="el" href="namespaceoboe.html#a82f3720eba7654aceb7282be36f9ff1d">SampleRateConversionQuality</a> oboe::AudioStreamBase::getSampleRateConversionQuality </td> 533 <td>(</td> 534 <td class="paramname"></td><td>)</td> 535 <td> const</td> 536 </tr> 537 </table> 538 </td> 539 <td class="mlabels-right"> 540<span class="mlabels"><span class="mlabel">inline</span></span> </td> 541 </tr> 542</table> 543</div><div class="memdoc"> 544<dl class="section return"><dt>Returns</dt><dd>whether and how Oboe can convert sample rates to achieve optimal results. </dd></dl> 545 546</div> 547</div> 548<a id="aa3c502ce09bbad7690a2dd6acaf8892e"></a> 549<h2 class="memtitle"><span class="permalink"><a href="#aa3c502ce09bbad7690a2dd6acaf8892e">◆ </a></span>getSessionId()</h2> 550 551<div class="memitem"> 552<div class="memproto"> 553<table class="mlabels"> 554 <tr> 555 <td class="mlabels-left"> 556 <table class="memname"> 557 <tr> 558 <td class="memname"><a class="el" href="namespaceoboe.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> oboe::AudioStreamBase::getSessionId </td> 559 <td>(</td> 560 <td class="paramname"></td><td>)</td> 561 <td> const</td> 562 </tr> 563 </table> 564 </td> 565 <td class="mlabels-right"> 566<span class="mlabels"><span class="mlabel">inline</span></span> </td> 567 </tr> 568</table> 569</div><div class="memdoc"> 570<dl class="section return"><dt>Returns</dt><dd>the stream's session ID allocation strategy (None or Allocate). </dd></dl> 571 572</div> 573</div> 574<a id="a1fb033fc963f971bd1aa8f6707e49b41"></a> 575<h2 class="memtitle"><span class="permalink"><a href="#a1fb033fc963f971bd1aa8f6707e49b41">◆ </a></span>getSharingMode()</h2> 576 577<div class="memitem"> 578<div class="memproto"> 579<table class="mlabels"> 580 <tr> 581 <td class="mlabels-left"> 582 <table class="memname"> 583 <tr> 584 <td class="memname"><a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520">SharingMode</a> oboe::AudioStreamBase::getSharingMode </td> 585 <td>(</td> 586 <td class="paramname"></td><td>)</td> 587 <td> const</td> 588 </tr> 589 </table> 590 </td> 591 <td class="mlabels-right"> 592<span class="mlabels"><span class="mlabel">inline</span></span> </td> 593 </tr> 594</table> 595</div><div class="memdoc"> 596<dl class="section return"><dt>Returns</dt><dd>the sharing mode of the stream. </dd></dl> 597 598</div> 599</div> 600<a id="a0bcfb2f8bd11c92b541fd910da9af397"></a> 601<h2 class="memtitle"><span class="permalink"><a href="#a0bcfb2f8bd11c92b541fd910da9af397">◆ </a></span>getUsage()</h2> 602 603<div class="memitem"> 604<div class="memproto"> 605<table class="mlabels"> 606 <tr> 607 <td class="mlabels-left"> 608 <table class="memname"> 609 <tr> 610 <td class="memname"><a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0">Usage</a> oboe::AudioStreamBase::getUsage </td> 611 <td>(</td> 612 <td class="paramname"></td><td>)</td> 613 <td> const</td> 614 </tr> 615 </table> 616 </td> 617 <td class="mlabels-right"> 618<span class="mlabels"><span class="mlabel">inline</span></span> </td> 619 </tr> 620</table> 621</div><div class="memdoc"> 622<dl class="section return"><dt>Returns</dt><dd>the usage for this stream. </dd></dl> 623 624</div> 625</div> 626<a id="aa4ec3aa76e69350fbce6f00786211495"></a> 627<h2 class="memtitle"><span class="permalink"><a href="#aa4ec3aa76e69350fbce6f00786211495">◆ </a></span>isChannelConversionAllowed()</h2> 628 629<div class="memitem"> 630<div class="memproto"> 631<table class="mlabels"> 632 <tr> 633 <td class="mlabels-left"> 634 <table class="memname"> 635 <tr> 636 <td class="memname">bool oboe::AudioStreamBase::isChannelConversionAllowed </td> 637 <td>(</td> 638 <td class="paramname"></td><td>)</td> 639 <td> const</td> 640 </tr> 641 </table> 642 </td> 643 <td class="mlabels-right"> 644<span class="mlabels"><span class="mlabel">inline</span></span> </td> 645 </tr> 646</table> 647</div><div class="memdoc"> 648<dl class="section return"><dt>Returns</dt><dd>true if Oboe can convert channel counts to achieve optimal results. </dd></dl> 649 650</div> 651</div> 652<a id="ace3625a7332bf02a86818fdf63fcccb4"></a> 653<h2 class="memtitle"><span class="permalink"><a href="#ace3625a7332bf02a86818fdf63fcccb4">◆ </a></span>isFormatConversionAllowed()</h2> 654 655<div class="memitem"> 656<div class="memproto"> 657<table class="mlabels"> 658 <tr> 659 <td class="mlabels-left"> 660 <table class="memname"> 661 <tr> 662 <td class="memname">bool oboe::AudioStreamBase::isFormatConversionAllowed </td> 663 <td>(</td> 664 <td class="paramname"></td><td>)</td> 665 <td> const</td> 666 </tr> 667 </table> 668 </td> 669 <td class="mlabels-right"> 670<span class="mlabels"><span class="mlabel">inline</span></span> </td> 671 </tr> 672</table> 673</div><div class="memdoc"> 674<dl class="section return"><dt>Returns</dt><dd>true if Oboe can convert data formats to achieve optimal results. </dd></dl> 675 676</div> 677</div> 678<a id="aa9c987a59555d7a60b9f7a63f4afc7fc"></a> 679<h2 class="memtitle"><span class="permalink"><a href="#aa9c987a59555d7a60b9f7a63f4afc7fc">◆ </a></span>operator=()</h2> 680 681<div class="memitem"> 682<div class="memproto"> 683<table class="mlabels"> 684 <tr> 685 <td class="mlabels-left"> 686 <table class="memname"> 687 <tr> 688 <td class="memname"><a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a>& oboe::AudioStreamBase::operator= </td> 689 <td>(</td> 690 <td class="paramtype">const <a class="el" href="classoboe_1_1_audio_stream_base.html">AudioStreamBase</a> & </td> 691 <td class="paramname"></td><td>)</td> 692 <td></td> 693 </tr> 694 </table> 695 </td> 696 <td class="mlabels-right"> 697<span class="mlabels"><span class="mlabel">default</span></span> </td> 698 </tr> 699</table> 700</div><div class="memdoc"> 701<p>Default assignment operator </p> 702 703</div> 704</div> 705<h2 class="groupheader">Member Data Documentation</h2> 706<a id="ac81d4719b350f8138aad1af38f0873b6"></a> 707<h2 class="memtitle"><span class="permalink"><a href="#ac81d4719b350f8138aad1af38f0873b6">◆ </a></span>mBufferCapacityInFrames</h2> 708 709<div class="memitem"> 710<div class="memproto"> 711<table class="mlabels"> 712 <tr> 713 <td class="mlabels-left"> 714 <table class="memname"> 715 <tr> 716 <td class="memname">int32_t oboe::AudioStreamBase::mBufferCapacityInFrames = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 717 </tr> 718 </table> 719 </td> 720 <td class="mlabels-right"> 721<span class="mlabels"><span class="mlabel">protected</span></span> </td> 722 </tr> 723</table> 724</div><div class="memdoc"> 725<p>Stream buffer capacity specified as a number of audio frames </p> 726 727</div> 728</div> 729<a id="a3b65595d26d1eae1b8ce9925a5b98f6a"></a> 730<h2 class="memtitle"><span class="permalink"><a href="#a3b65595d26d1eae1b8ce9925a5b98f6a">◆ </a></span>mBufferSizeInFrames</h2> 731 732<div class="memitem"> 733<div class="memproto"> 734<table class="mlabels"> 735 <tr> 736 <td class="mlabels-left"> 737 <table class="memname"> 738 <tr> 739 <td class="memname">int32_t oboe::AudioStreamBase::mBufferSizeInFrames = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 740 </tr> 741 </table> 742 </td> 743 <td class="mlabels-right"> 744<span class="mlabels"><span class="mlabel">protected</span></span> </td> 745 </tr> 746</table> 747</div><div class="memdoc"> 748<p>Stream buffer size specified as a number of audio frames </p> 749 750</div> 751</div> 752<a id="a5ff460bac9d14dfeac4eeddfcbb6e206"></a> 753<h2 class="memtitle"><span class="permalink"><a href="#a5ff460bac9d14dfeac4eeddfcbb6e206">◆ </a></span>mChannelCount</h2> 754 755<div class="memitem"> 756<div class="memproto"> 757<table class="mlabels"> 758 <tr> 759 <td class="mlabels-left"> 760 <table class="memname"> 761 <tr> 762 <td class="memname">int32_t oboe::AudioStreamBase::mChannelCount = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 763 </tr> 764 </table> 765 </td> 766 <td class="mlabels-right"> 767<span class="mlabels"><span class="mlabel">protected</span></span> </td> 768 </tr> 769</table> 770</div><div class="memdoc"> 771<p>Stream channel count </p> 772 773</div> 774</div> 775<a id="a5f8f0e5add381b841856de80ea4cdb2b"></a> 776<h2 class="memtitle"><span class="permalink"><a href="#a5f8f0e5add381b841856de80ea4cdb2b">◆ </a></span>mContentType</h2> 777 778<div class="memitem"> 779<div class="memproto"> 780<table class="mlabels"> 781 <tr> 782 <td class="mlabels-left"> 783 <table class="memname"> 784 <tr> 785 <td class="memname"><a class="el" href="namespaceoboe.html#a2a3cec6f021c1a324df60273710c604b">ContentType</a> oboe::AudioStreamBase::mContentType = ContentType::Music</td> 786 </tr> 787 </table> 788 </td> 789 <td class="mlabels-right"> 790<span class="mlabels"><span class="mlabel">protected</span></span> </td> 791 </tr> 792</table> 793</div><div class="memdoc"> 794<p>Stream content type. Only active on Android 28+ </p> 795 796</div> 797</div> 798<a id="a23dafa12fb1a6242b088ebd5a52798c8"></a> 799<h2 class="memtitle"><span class="permalink"><a href="#a23dafa12fb1a6242b088ebd5a52798c8">◆ </a></span>mDeviceId</h2> 800 801<div class="memitem"> 802<div class="memproto"> 803<table class="mlabels"> 804 <tr> 805 <td class="mlabels-left"> 806 <table class="memname"> 807 <tr> 808 <td class="memname">int32_t oboe::AudioStreamBase::mDeviceId = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 809 </tr> 810 </table> 811 </td> 812 <td class="mlabels-right"> 813<span class="mlabels"><span class="mlabel">protected</span></span> </td> 814 </tr> 815</table> 816</div><div class="memdoc"> 817<p>Stream audio device ID </p> 818 819</div> 820</div> 821<a id="a26e9294721561d3b16bcaeec5faf4880"></a> 822<h2 class="memtitle"><span class="permalink"><a href="#a26e9294721561d3b16bcaeec5faf4880">◆ </a></span>mDirection</h2> 823 824<div class="memitem"> 825<div class="memproto"> 826<table class="mlabels"> 827 <tr> 828 <td class="mlabels-left"> 829 <table class="memname"> 830 <tr> 831 <td class="memname"><a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5ae">Direction</a> oboe::AudioStreamBase::mDirection = <a class="el" href="namespaceoboe.html#af2147500089212955498a08ef2edb5aea29c2c02a361c9d7028472e5d92cd4a54">Direction::Output</a></td> 832 </tr> 833 </table> 834 </td> 835 <td class="mlabels-right"> 836<span class="mlabels"><span class="mlabel">protected</span></span> </td> 837 </tr> 838</table> 839</div><div class="memdoc"> 840<p>Stream direction </p> 841 842</div> 843</div> 844<a id="a7869f04836c2c2bdc10c7309ad4b8e09"></a> 845<h2 class="memtitle"><span class="permalink"><a href="#a7869f04836c2c2bdc10c7309ad4b8e09">◆ </a></span>mFormat</h2> 846 847<div class="memitem"> 848<div class="memproto"> 849<table class="mlabels"> 850 <tr> 851 <td class="mlabels-left"> 852 <table class="memname"> 853 <tr> 854 <td class="memname"><a class="el" href="namespaceoboe.html#a92afc593e856571aacbfd02e57075df6">AudioFormat</a> oboe::AudioStreamBase::mFormat = AudioFormat::Unspecified</td> 855 </tr> 856 </table> 857 </td> 858 <td class="mlabels-right"> 859<span class="mlabels"><span class="mlabel">protected</span></span> </td> 860 </tr> 861</table> 862</div><div class="memdoc"> 863<p>Format of audio frames </p> 864 865</div> 866</div> 867<a id="a54061319ed348329a29d883a5de2482e"></a> 868<h2 class="memtitle"><span class="permalink"><a href="#a54061319ed348329a29d883a5de2482e">◆ </a></span>mFramesPerBurst</h2> 869 870<div class="memitem"> 871<div class="memproto"> 872<table class="mlabels"> 873 <tr> 874 <td class="mlabels-left"> 875 <table class="memname"> 876 <tr> 877 <td class="memname">int32_t oboe::AudioStreamBase::mFramesPerBurst = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 878 </tr> 879 </table> 880 </td> 881 <td class="mlabels-right"> 882<span class="mlabels"><span class="mlabel">protected</span></span> </td> 883 </tr> 884</table> 885</div><div class="memdoc"> 886<p>Number of frames which will be copied to/from the audio device in a single read/write operation </p> 887 888</div> 889</div> 890<a id="a3962eb94420ad0ecea70029236001899"></a> 891<h2 class="memtitle"><span class="permalink"><a href="#a3962eb94420ad0ecea70029236001899">◆ </a></span>mFramesPerCallback</h2> 892 893<div class="memitem"> 894<div class="memproto"> 895<table class="mlabels"> 896 <tr> 897 <td class="mlabels-left"> 898 <table class="memname"> 899 <tr> 900 <td class="memname">int32_t oboe::AudioStreamBase::mFramesPerCallback = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 901 </tr> 902 </table> 903 </td> 904 <td class="mlabels-right"> 905<span class="mlabels"><span class="mlabel">protected</span></span> </td> 906 </tr> 907</table> 908</div><div class="memdoc"> 909<p>Number of audio frames which will be requested in each callback </p> 910 911</div> 912</div> 913<a id="a1e5d4f5b30c4cc36f81ffd858cc00589"></a> 914<h2 class="memtitle"><span class="permalink"><a href="#a1e5d4f5b30c4cc36f81ffd858cc00589">◆ </a></span>mInputPreset</h2> 915 916<div class="memitem"> 917<div class="memproto"> 918<table class="mlabels"> 919 <tr> 920 <td class="mlabels-left"> 921 <table class="memname"> 922 <tr> 923 <td class="memname"><a class="el" href="namespaceoboe.html#a4477ed232b02e2694d9309baf55a8f06">InputPreset</a> oboe::AudioStreamBase::mInputPreset = InputPreset::VoiceRecognition</td> 924 </tr> 925 </table> 926 </td> 927 <td class="mlabels-right"> 928<span class="mlabels"><span class="mlabel">protected</span></span> </td> 929 </tr> 930</table> 931</div><div class="memdoc"> 932<p>Stream input preset. Only active on Android 28+ TODO InputPreset::Unspecified should be considered as a possible default alternative. </p> 933 934</div> 935</div> 936<a id="ab99671c2d0552557e75dc7b4afe91765"></a> 937<h2 class="memtitle"><span class="permalink"><a href="#ab99671c2d0552557e75dc7b4afe91765">◆ </a></span>mPerformanceMode</h2> 938 939<div class="memitem"> 940<div class="memproto"> 941<table class="mlabels"> 942 <tr> 943 <td class="mlabels-left"> 944 <table class="memname"> 945 <tr> 946 <td class="memname"><a class="el" href="namespaceoboe.html#a1068781f3920654b1bfd7ed136468184">PerformanceMode</a> oboe::AudioStreamBase::mPerformanceMode = PerformanceMode::None</td> 947 </tr> 948 </table> 949 </td> 950 <td class="mlabels-right"> 951<span class="mlabels"><span class="mlabel">protected</span></span> </td> 952 </tr> 953</table> 954</div><div class="memdoc"> 955<p>Stream performance mode </p> 956 957</div> 958</div> 959<a id="a998885bb6c4f37e145f4626ad4177dea"></a> 960<h2 class="memtitle"><span class="permalink"><a href="#a998885bb6c4f37e145f4626ad4177dea">◆ </a></span>mSampleRate</h2> 961 962<div class="memitem"> 963<div class="memproto"> 964<table class="mlabels"> 965 <tr> 966 <td class="mlabels-left"> 967 <table class="memname"> 968 <tr> 969 <td class="memname">int32_t oboe::AudioStreamBase::mSampleRate = <a class="el" href="namespaceoboe.html#ab0772052200184e514082eaa89be7905">kUnspecified</a></td> 970 </tr> 971 </table> 972 </td> 973 <td class="mlabels-right"> 974<span class="mlabels"><span class="mlabel">protected</span></span> </td> 975 </tr> 976</table> 977</div><div class="memdoc"> 978<p>Stream sample rate </p> 979 980</div> 981</div> 982<a id="abe1c1e9cada1ced9b5c1504ac9b07737"></a> 983<h2 class="memtitle"><span class="permalink"><a href="#abe1c1e9cada1ced9b5c1504ac9b07737">◆ </a></span>mSessionId</h2> 984 985<div class="memitem"> 986<div class="memproto"> 987<table class="mlabels"> 988 <tr> 989 <td class="mlabels-left"> 990 <table class="memname"> 991 <tr> 992 <td class="memname"><a class="el" href="namespaceoboe.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> oboe::AudioStreamBase::mSessionId = SessionId::None</td> 993 </tr> 994 </table> 995 </td> 996 <td class="mlabels-right"> 997<span class="mlabels"><span class="mlabel">protected</span></span> </td> 998 </tr> 999</table> 1000</div><div class="memdoc"> 1001<p>Stream session ID allocation strategy. Only active on Android 28+ </p> 1002 1003</div> 1004</div> 1005<a id="ae9187492b679c97a0963e264954be473"></a> 1006<h2 class="memtitle"><span class="permalink"><a href="#ae9187492b679c97a0963e264954be473">◆ </a></span>mSharingMode</h2> 1007 1008<div class="memitem"> 1009<div class="memproto"> 1010<table class="mlabels"> 1011 <tr> 1012 <td class="mlabels-left"> 1013 <table class="memname"> 1014 <tr> 1015 <td class="memname"><a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520">SharingMode</a> oboe::AudioStreamBase::mSharingMode = <a class="el" href="namespaceoboe.html#a8330247b25429953a08354f41834d520aa6156ea9d66fef24e87e841fbabf7cca">SharingMode::Shared</a></td> 1016 </tr> 1017 </table> 1018 </td> 1019 <td class="mlabels-right"> 1020<span class="mlabels"><span class="mlabel">protected</span></span> </td> 1021 </tr> 1022</table> 1023</div><div class="memdoc"> 1024<p>Stream sharing mode </p> 1025 1026</div> 1027</div> 1028<a id="ae3f72318212dd9977d7fa0ced92c91f4"></a> 1029<h2 class="memtitle"><span class="permalink"><a href="#ae3f72318212dd9977d7fa0ced92c91f4">◆ </a></span>mStreamCallback</h2> 1030 1031<div class="memitem"> 1032<div class="memproto"> 1033<table class="mlabels"> 1034 <tr> 1035 <td class="mlabels-left"> 1036 <table class="memname"> 1037 <tr> 1038 <td class="memname"><a class="el" href="classoboe_1_1_audio_stream_callback.html">AudioStreamCallback</a>* oboe::AudioStreamBase::mStreamCallback = nullptr</td> 1039 </tr> 1040 </table> 1041 </td> 1042 <td class="mlabels-right"> 1043<span class="mlabels"><span class="mlabel">protected</span></span> </td> 1044 </tr> 1045</table> 1046</div><div class="memdoc"> 1047<p>The callback which will be fired when new data is ready to be read/written </p> 1048 1049</div> 1050</div> 1051<a id="a5b518e82f39c9fcbd7050fd66adb253c"></a> 1052<h2 class="memtitle"><span class="permalink"><a href="#a5b518e82f39c9fcbd7050fd66adb253c">◆ </a></span>mUsage</h2> 1053 1054<div class="memitem"> 1055<div class="memproto"> 1056<table class="mlabels"> 1057 <tr> 1058 <td class="mlabels-left"> 1059 <table class="memname"> 1060 <tr> 1061 <td class="memname"><a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0">Usage</a> oboe::AudioStreamBase::mUsage = <a class="el" href="namespaceoboe.html#a104ee8396c173fefac429759ea3c21a0a3b563524fdb17b4a86590470d40bef74">Usage::Media</a></td> 1062 </tr> 1063 </table> 1064 </td> 1065 <td class="mlabels-right"> 1066<span class="mlabels"><span class="mlabel">protected</span></span> </td> 1067 </tr> 1068</table> 1069</div><div class="memdoc"> 1070<p>Stream usage. Only active on Android 28+ </p> 1071 1072</div> 1073</div> 1074<hr/>The documentation for this class was generated from the following file:<ul> 1075<li>include/oboe/<a class="el" href="_audio_stream_base_8h_source.html">AudioStreamBase.h</a></li> 1076</ul> 1077</div><!-- contents --> 1078<!-- start footer part --> 1079<hr class="footer"/><address class="footer"><small> 1080Generated by  <a href="http://www.doxygen.org/index.html"> 1081<img class="footer" src="doxygen.png" alt="doxygen"/> 1082</a> 1.8.15 1083</small></address> 1084</body> 1085</html> 1086
