1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Oboe: include/oboe/AudioStreamBase.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">Oboe
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">Audio library for Android</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_768f6301d9838e45d679001914ab2803.html">oboe</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">AudioStreamBase.h</div> </div>
</div><!--header-->
<div class="contents">
<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 2015 The Android Open Source Project</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">#ifndef OBOE_STREAM_BASE_H_</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define OBOE_STREAM_BASE_H_</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "oboe/AudioStreamCallback.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "oboe/Definitions.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="a00032.html">oboe</a> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="a00040.html"> 34</a></span> <span class="keyword">class </span><a class="code" href="a00040.html">AudioStreamBase</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">public</span>:</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>  <a class="code" href="a00040.html">AudioStreamBase</a>() {}</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">virtual</span> ~<a class="code" href="a00040.html">AudioStreamBase</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// This class only contains primitives so we can use default constructor and copy methods.</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="a00040.html">AudioStreamBase</a>(<span class="keyword">const</span> <a class="code" href="a00040.html">AudioStreamBase</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="a00040.html">AudioStreamBase</a>& operator=(<span class="keyword">const</span> <a class="code" href="a00040.html">AudioStreamBase</a>&) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00040.html#aa0b0a068097efaf967fb235c55383dd8"> 49</a></span>  <span class="keywordtype">int</span> <a class="code" href="a00040.html#aa0b0a068097efaf967fb235c55383dd8">getChannelCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mChannelCount; }</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1"> 54</a></span>  Direction <a class="code" href="a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1">getDirection</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDirection; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="a00040.html#ae9d32f3e09174bad69e74f147ee33087"> 59</a></span>  int32_t <a class="code" href="a00040.html#ae9d32f3e09174bad69e74f147ee33087">getSampleRate</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSampleRate; }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="a00040.html#a1c133e1949f0814f60bd8bb61346756b"> 64</a></span>  <span class="keywordtype">int</span> <a class="code" href="a00040.html#a1c133e1949f0814f60bd8bb61346756b">getFramesPerCallback</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFramesPerCallback; }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="a00040.html#ab1e640461d7bf9d596decb913da7ac86"> 70</a></span>  AudioFormat <a class="code" href="a00040.html#ab1e640461d7bf9d596decb913da7ac86">getFormat</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mFormat; }</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="a00040.html#af5217ab05bfde0d7637024b599302d0b"> 78</a></span>  <span class="keyword">virtual</span> int32_t <a class="code" href="a00040.html#af5217ab05bfde0d7637024b599302d0b">getBufferSizeInFrames</a>() { <span class="keywordflow">return</span> mBufferSizeInFrames; };</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="a00040.html#ab1531253e64aaebe9e9eddbafb9098fc"> 83</a></span>  <span class="keyword">virtual</span> int32_t <a class="code" href="a00040.html#ab1531253e64aaebe9e9eddbafb9098fc">getBufferCapacityInFrames</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mBufferCapacityInFrames; }</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="a00032.html#ae3a52556c58387e0cecba01f9abffdff">SharingMode</a> getSharingMode()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSharingMode; }</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  PerformanceMode getPerformanceMode()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mPerformanceMode; }</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  int32_t getDeviceId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDeviceId; }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  AudioStreamCallback* getCallback()<span class="keyword"> const </span>{</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordflow">return</span> mStreamCallback;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb">Usage</a> getUsage()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mUsage; }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <a class="code" href="a00032.html#a07eed38097ed944422063801f8f83406">ContentType</a> getContentType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mContentType; }</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <a class="code" href="a00032.html#a17f63a064de966efddd5d0335992bc04">InputPreset</a> getInputPreset()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mInputPreset; }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="a00032.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> getSessionId()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSessionId; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  AudioStreamCallback *mStreamCallback = <span class="keyword">nullptr</span>;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  int32_t mFramesPerCallback = kUnspecified;</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  int32_t mChannelCount = kUnspecified;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  int32_t mSampleRate = kUnspecified;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  int32_t mDeviceId = kUnspecified;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  int32_t mBufferCapacityInFrames = kUnspecified;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  int32_t mBufferSizeInFrames = kUnspecified;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  int32_t mFramesPerBurst = kUnspecified;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <a class="code" href="a00032.html#ae3a52556c58387e0cecba01f9abffdff">SharingMode</a> mSharingMode = <a class="code" href="a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca">SharingMode::Shared</a>;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  AudioFormat mFormat = AudioFormat::Unspecified;</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  Direction mDirection = Direction::Output;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  PerformanceMode mPerformanceMode = PerformanceMode::None;</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// Added in API 28</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <a class="code" href="a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb">Usage</a> mUsage = <a class="code" href="a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74">Usage::Media</a>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="a00032.html#a07eed38097ed944422063801f8f83406">ContentType</a> mContentType = ContentType::Music;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <a class="code" href="a00032.html#a17f63a064de966efddd5d0335992bc04">InputPreset</a> mInputPreset = InputPreset::VoiceRecognition;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <a class="code" href="a00032.html#a5752250c10e96179e3618d7f72937eaf">SessionId</a> mSessionId = SessionId::None;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> };</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> } <span class="comment">// namespace oboe</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> </div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="preprocessor">#endif </span><span class="comment">/* OBOE_STREAM_BASE_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="a00040_html_af5217ab05bfde0d7637024b599302d0b"><div class="ttname"><a href="a00040.html#af5217ab05bfde0d7637024b599302d0b">oboe::AudioStreamBase::getBufferSizeInFrames</a></div><div class="ttdeci">virtual int32_t getBufferSizeInFrames()</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:78</div></div>
<div class="ttc" id="a00032_html_a5752250c10e96179e3618d7f72937eaf"><div class="ttname"><a href="a00032.html#a5752250c10e96179e3618d7f72937eaf">oboe::SessionId</a></div><div class="ttdeci">SessionId</div><div class="ttdef"><b>Definition:</b> Definitions.h:314</div></div>
<div class="ttc" id="a00032_html_a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74"><div class="ttname"><a href="a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbba3b563524fdb17b4a86590470d40bef74">oboe::Usage::Media</a></div></div>
<div class="ttc" id="a00040_html_a6f86f2233a04c5a0b056f0c1c261f1b1"><div class="ttname"><a href="a00040.html#a6f86f2233a04c5a0b056f0c1c261f1b1">oboe::AudioStreamBase::getDirection</a></div><div class="ttdeci">Direction getDirection() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:54</div></div>
<div class="ttc" id="a00040_html_aa0b0a068097efaf967fb235c55383dd8"><div class="ttname"><a href="a00040.html#aa0b0a068097efaf967fb235c55383dd8">oboe::AudioStreamBase::getChannelCount</a></div><div class="ttdeci">int getChannelCount() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:49</div></div>
<div class="ttc" id="a00040_html_ab1e640461d7bf9d596decb913da7ac86"><div class="ttname"><a href="a00040.html#ab1e640461d7bf9d596decb913da7ac86">oboe::AudioStreamBase::getFormat</a></div><div class="ttdeci">AudioFormat getFormat() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:70</div></div>
<div class="ttc" id="a00032_html"><div class="ttname"><a href="a00032.html">oboe</a></div><div class="ttdef"><b>Definition:</b> AudioStream.h:29</div></div>
<div class="ttc" id="a00040_html_ab1531253e64aaebe9e9eddbafb9098fc"><div class="ttname"><a href="a00040.html#ab1531253e64aaebe9e9eddbafb9098fc">oboe::AudioStreamBase::getBufferCapacityInFrames</a></div><div class="ttdeci">virtual int32_t getBufferCapacityInFrames() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:83</div></div>
<div class="ttc" id="a00032_html_a07eed38097ed944422063801f8f83406"><div class="ttname"><a href="a00032.html#a07eed38097ed944422063801f8f83406">oboe::ContentType</a></div><div class="ttdeci">ContentType</div><div class="ttdef"><b>Definition:</b> Definitions.h:252</div></div>
<div class="ttc" id="a00032_html_ae3a52556c58387e0cecba01f9abffdff"><div class="ttname"><a href="a00032.html#ae3a52556c58387e0cecba01f9abffdff">oboe::SharingMode</a></div><div class="ttdeci">SharingMode</div><div class="ttdef"><b>Definition:</b> Definitions.h:113</div></div>
<div class="ttc" id="a00040_html"><div class="ttname"><a href="a00040.html">oboe::AudioStreamBase</a></div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:34</div></div>
<div class="ttc" id="a00040_html_ae9d32f3e09174bad69e74f147ee33087"><div class="ttname"><a href="a00040.html#ae9d32f3e09174bad69e74f147ee33087">oboe::AudioStreamBase::getSampleRate</a></div><div class="ttdeci">int32_t getSampleRate() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:59</div></div>
<div class="ttc" id="a00032_html_ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca"><div class="ttname"><a href="a00032.html#ae3a52556c58387e0cecba01f9abffdffaa6156ea9d66fef24e87e841fbabf7cca">oboe::SharingMode::Shared</a></div></div>
<div class="ttc" id="a00032_html_a17f63a064de966efddd5d0335992bc04"><div class="ttname"><a href="a00032.html#a17f63a064de966efddd5d0335992bc04">oboe::InputPreset</a></div><div class="ttdeci">InputPreset</div><div class="ttdef"><b>Definition:</b> Definitions.h:285</div></div>
<div class="ttc" id="a00040_html_a1c133e1949f0814f60bd8bb61346756b"><div class="ttname"><a href="a00040.html#a1c133e1949f0814f60bd8bb61346756b">oboe::AudioStreamBase::getFramesPerCallback</a></div><div class="ttdeci">int getFramesPerCallback() const</div><div class="ttdef"><b>Definition:</b> AudioStreamBase.h:64</div></div>
<div class="ttc" id="a00032_html_a1b2a1bdc891d640eb82724dcd9b7afbb"><div class="ttname"><a href="a00032.html#a1b2a1bdc891d640eb82724dcd9b7afbb">oboe::Usage</a></div><div class="ttdeci">Usage</div><div class="ttdef"><b>Definition:</b> Definitions.h:174</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.14
</small></address>
</body>
</html>
|
