deploy: 94ef6e7

Author: robertwu1

_audio_stream_8h_source.html

@@ -200,6 +200,12 @@
 <tr class="separator:a9fdffea9e3a3f693fcbbbca699a22c6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9cf8ce01c8db830f89b70c782fe18d90" id="r_a9cf8ce01c8db830f89b70c782fe18d90"><td class="memItemLeft" align="right" valign="top">virtual oboe::Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9cf8ce01c8db830f89b70c782fe18d90">reportWorkload</a> (int32_t appWorkload)</td></tr>
 <tr class="separator:a9cf8ce01c8db830f89b70c782fe18d90"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aab76b523480d65f25f7df3c99f2dce47" id="r_aab76b523480d65f25f7df3c99f2dce47"><td class="memItemLeft" align="right" valign="top">virtual oboe::Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aab76b523480d65f25f7df3c99f2dce47">notifyWorkloadIncrease</a> (bool cpu, bool gpu, const char *debugName)</td></tr>
+<tr class="separator:aab76b523480d65f25f7df3c99f2dce47"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3625762def846a6f4b3f48548bfa1b9c" id="r_a3625762def846a6f4b3f48548bfa1b9c"><td class="memItemLeft" align="right" valign="top">virtual oboe::Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3625762def846a6f4b3f48548bfa1b9c">notifyWorkloadReset</a> (bool cpu, bool gpu, const char *debugName)</td></tr>
+<tr class="separator:a3625762def846a6f4b3f48548bfa1b9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a5124210a3410ab9e36ea4c4b8b30e7b1" id="r_a5124210a3410ab9e36ea4c4b8b30e7b1"><td class="memItemLeft" align="right" valign="top">virtual oboe::Result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5124210a3410ab9e36ea4c4b8b30e7b1">notifyWorkloadSpike</a> (bool cpu, bool gpu, const char *debugName)</td></tr>
+<tr class="separator:a5124210a3410ab9e36ea4c4b8b30e7b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aac81c2a3fd1ce1bd19e7b738553d6390" id="r_aac81c2a3fd1ce1bd19e7b738553d6390"><td class="memItemLeft" align="right" valign="top"><a id="aac81c2a3fd1ce1bd19e7b738553d6390" name="aac81c2a3fd1ce1bd19e7b738553d6390"></a>
 virtual oboe::Result&#160;</td><td class="memItemRight" valign="bottom"><b>setOffloadDelayPadding</b> (int32_t delayInFrames, int32_t paddingInFrames)</td></tr>
 <tr class="separator:aac81c2a3fd1ce1bd19e7b738553d6390"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -1138,6 +1144,144 @@ <h2 class="memtitle"><span class="permalink"><a href="#a43d8a098440cde28f4ee8bed
 </div><div class="memdoc">
 <dl class="section return"><dt>Returns</dt><dd>true if XRun counts are supported on the stream </dd></dl>
 
+</div>
+</div>
+<a id="aab76b523480d65f25f7df3c99f2dce47" name="aab76b523480d65f25f7df3c99f2dce47"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aab76b523480d65f25f7df3c99f2dce47">&#9670;&#160;</a></span>notifyWorkloadIncrease()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual oboe::Result oboe::AudioStream::notifyWorkloadIncrease </td>
+          <td>(</td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>cpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>gpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>debugName</em></span>&#160;)</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Informs the framework of an upcoming increase in the workload of an audio callback bound to this session. The user can specify whether the increase is expected to be on the CPU, GPU, or both.</p>
+<p>Sending hints for both CPU and GPU counts as two separate hints for the purposes of the rate limiter.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cpu</td><td>Indicates if the workload increase is expected to affect the CPU. </td></tr>
+    <tr><td class="paramname">gpu</td><td>Indicates if the workload increase is expected to affect the GPU. </td></tr>
+    <tr><td class="paramname">debugName</td><td>A required string used to identify this specific hint during tracing. This debug string will only be held for the duration of the method, and can be safely discarded after.</td></tr>
+  </table>
+  </dd>
+</dl>
+<p>This was introduced in Android API Level 36</p>
+<dl class="section return"><dt>Returns</dt><dd>Result::OK on success. Result::ErrorInvalidState if the PerformanceHint was not enabled. Result::ErrorClosed if AdpfWrapper::open() was not called. Result::ErrorUnimplemented if the API is not supported. Result::ErrorInvalidHandle if no hints were requested. Result::ErrorInvalidRate if the hint was rate limited. Result::ErrorNoService if communication with the system service has failed. Result::ErrorUnavailable if the hint is not supported. </dd></dl>
+
+</div>
+</div>
+<a id="a3625762def846a6f4b3f48548bfa1b9c" name="a3625762def846a6f4b3f48548bfa1b9c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3625762def846a6f4b3f48548bfa1b9c">&#9670;&#160;</a></span>notifyWorkloadReset()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual oboe::Result oboe::AudioStream::notifyWorkloadReset </td>
+          <td>(</td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>cpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>gpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>debugName</em></span>&#160;)</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Informs the framework of an upcoming reset in the workload of an audio callback bound to this session, or the imminent start of a new workload. The user can specify whether the reset is expected to affect the CPU, GPU, or both.</p>
+<p>Sending hints for both CPU and GPU counts as two separate hints for the purposes of the this load tracking.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cpu</td><td>Indicates if the workload reset is expected to affect the CPU. </td></tr>
+    <tr><td class="paramname">gpu</td><td>Indicates if the workload reset is expected to affect the GPU. </td></tr>
+    <tr><td class="paramname">debugName</td><td>A required string used to identify this specific hint during tracing. This debug string will only be held for the duration of the method, and can be safely discarded after.</td></tr>
+  </table>
+  </dd>
+</dl>
+<p>This was introduced in Android API Level 36</p>
+<dl class="section return"><dt>Returns</dt><dd>Result::OK on success. Result::ErrorInvalidState if the PerformanceHint was not enabled. Result::ErrorClosed if AdpfWrapper::open() was not called. Result::ErrorUnimplemented if the API is not supported. Result::ErrorInvalidHandle if no hints were requested. Result::ErrorInvalidRate if the hint was rate limited. Result::ErrorNoService if communication with the system service has failed. Result::ErrorUnavailable if the hint is not supported. </dd></dl>
+
+</div>
+</div>
+<a id="a5124210a3410ab9e36ea4c4b8b30e7b1" name="a5124210a3410ab9e36ea4c4b8b30e7b1"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a5124210a3410ab9e36ea4c4b8b30e7b1">&#9670;&#160;</a></span>notifyWorkloadSpike()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">virtual oboe::Result oboe::AudioStream::notifyWorkloadSpike </td>
+          <td>(</td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>cpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>gpu</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>debugName</em></span>&#160;)</td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+<p>Informs the framework of an upcoming one-off expensive frame for an audio callback bound to this session. This frame will be treated as not representative of the workload as a whole, and it will be discarded the purposes of load tracking. The user can specify whether the workload spike is expected to be on the CPU, GPU, or both.</p>
+<p>Sending hints for both CPU and GPU counts as two separate hints for the purposes of the rate limiter.</p>
+<p>This was introduced in Android API Level 36</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">cpu</td><td>Indicates if the workload spike is expected to affect the CPU. </td></tr>
+    <tr><td class="paramname">gpu</td><td>Indicates if the workload spike is expected to affect the GPU. </td></tr>
+    <tr><td class="paramname">debugName</td><td>A required string used to identify this specific hint during tracing. This debug string will only be held for the duration of the method, and can be safely discarded after.</td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Result::OK on success. Result::ErrorInvalidState if the PerformanceHint was not enabled. Result::ErrorClosed if AdpfWrapper::open() was not called. Result::ErrorUnimplemented if the API is not supported. Result::ErrorInvalidHandle if no hints were requested. Result::ErrorInvalidRate if the hint was rate limited. Result::ErrorNoService if communication with the system service has failed. Result::ErrorUnavailable if the hint is not supported. </dd></dl>
+
 </div>
 </div>
 <a id="a0ea79e60f5a3d29fc5a1a116aba11dfe" name="a0ea79e60f5a3d29fc5a1a116aba11dfe"></a>

classoboe_1_1_audio_stream-members.html

@@ -107,6 +107,7 @@
 <a href="functions_func.html"/>
 <a href="functions_func.html"/>
 <a href="functions_func.html"/>
+<a href="functions_func.html"/>
 <a href="functions_vars.html"/>
 <a href="functions_vars.html"/>
 <a href="functions_vars.html"/>
@@ -147,6 +148,7 @@
 <a href="classoboe_1_1_audio_stream.html#a2b7a3cee7444114843dbdd1fc705f6bb"/>
 <a href="classoboe_1_1_audio_stream.html#a2b9a90edb31c03fc034d1d79dac14d92"/>
 <a href="classoboe_1_1_audio_stream.html#a32c25c0333eab3d65ce02275ad4acb3d"/>
+<a href="classoboe_1_1_audio_stream.html#a3625762def846a6f4b3f48548bfa1b9c"/>
 <a href="classoboe_1_1_audio_stream.html#a3c484e314dee8dfed1d419f487b5d601"/>
 <a href="classoboe_1_1_audio_stream.html#a3caa2803064eafd217ef86b282d249da"/>
 <a href="classoboe_1_1_audio_stream.html#a42a645b6ad3dc89db751b7f55db72ded"/>
@@ -156,6 +158,7 @@
 <a href="classoboe_1_1_audio_stream.html#a462358ddab709c79d1a7968d6d55b727"/>
 <a href="classoboe_1_1_audio_stream.html#a47bb5798275f14d76444283a6b6f35eb"/>
 <a href="classoboe_1_1_audio_stream.html#a4eff89cae5bffa989e2413557e64c386"/>
+<a href="classoboe_1_1_audio_stream.html#a5124210a3410ab9e36ea4c4b8b30e7b1"/>
 <a href="classoboe_1_1_audio_stream.html#a524b17bc75564dd2910fae4feb853184"/>
 <a href="classoboe_1_1_audio_stream.html#a5c01907a59d5f89a5e4b819fe66b08bc"/>
 <a href="classoboe_1_1_audio_stream.html#a5f743b9ec83a31ce8b7edc7ed6bbca8b"/>
@@ -176,6 +179,7 @@
 <a href="classoboe_1_1_audio_stream.html#a9fdffea9e3a3f693fcbbbca699a22c6b"/>
 <a href="classoboe_1_1_audio_stream.html#aa48da7bf28026b7cccee73e6b054af28"/>
 <a href="classoboe_1_1_audio_stream.html#aa6ae9fc6ecc905571979c4df8f849a44"/>
+<a href="classoboe_1_1_audio_stream.html#aab76b523480d65f25f7df3c99f2dce47"/>
 <a href="classoboe_1_1_audio_stream.html#ab037b48b871b365b6b3e3f7155967912"/>
 <a href="classoboe_1_1_audio_stream.html#ab43dd4074e1de57bac1c3fd111430341"/>
 <a href="classoboe_1_1_audio_stream.html#ab7a8cfe5d6039386bc5850fd5ee9bd62"/>

classoboe_1_1_audio_stream.html

@@ -204,6 +204,13 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
 </ul>
 
 
+<h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
+<li>notifyWorkloadIncrease()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#aab76b523480d65f25f7df3c99f2dce47">oboe::AudioStream</a></li>
+<li>notifyWorkloadReset()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#a3625762def846a6f4b3f48548bfa1b9c">oboe::AudioStream</a></li>
+<li>notifyWorkloadSpike()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#a5124210a3410ab9e36ea4c4b8b30e7b1">oboe::AudioStream</a></li>
+</ul>
+
+
 <h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
 <li>onAudioReady()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream_data_callback.html#ad8a3a9f609df5fd3a5d885cbe1b2204d">oboe::AudioStreamDataCallback</a>, <a class="el" href="classoboe_1_1_full_duplex_stream.html#ab0cd2c67294a5a1b1080e2f265266b84">oboe::FullDuplexStream</a>, <a class="el" href="classoboe_1_1_stabilized_callback.html#ad447e12ebf732cf151655c1fbaf58a49">oboe::StabilizedCallback</a></li>
 <li>onBothStreamsReady()&#160;:&#160;<a class="el" href="classoboe_1_1_full_duplex_stream.html#a961f02bbfdd9821a0271e8895a5949b8">oboe::FullDuplexStream</a></li>

doxygen_crawl.html

@@ -88,6 +88,9 @@
 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
 
 <h3><a id="index_n" name="index_n"></a>- n -</h3><ul>
+<li>notifyWorkloadIncrease()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#aab76b523480d65f25f7df3c99f2dce47">oboe::AudioStream</a></li>
+<li>notifyWorkloadReset()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#a3625762def846a6f4b3f48548bfa1b9c">oboe::AudioStream</a></li>
+<li>notifyWorkloadSpike()&#160;:&#160;<a class="el" href="classoboe_1_1_audio_stream.html#a5124210a3410ab9e36ea4c4b8b30e7b1">oboe::AudioStream</a></li>
 <li>Number&#160;:&#160;<a class="el" href="structoboe_1_1_version.html#ac579661e79bcee45dc676d4647891de0">oboe::Version</a></li>
 </ul>
 </div><!-- contents -->

functions_func.html

@@ -58,6 +58,7 @@ var menudata={children:[
 {text:"g",url:"functions_func.html#index_g"},
 {text:"i",url:"functions_func.html#index_i"},
 {text:"l",url:"functions_func.html#index_l"},
+{text:"n",url:"functions_func.html#index_n"},
 {text:"o",url:"functions_func.html#index_o"},
 {text:"p",url:"functions_func.html#index_p"},
 {text:"r",url:"functions_func.html#index_r"},

functions_n.html

@@ -1,4 +1,7 @@
 var searchData=
 [
-  ['number_0',['Number',['../structoboe_1_1_version.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]]
+  ['notifyworkloadincrease_0',['notifyWorkloadIncrease',['../classoboe_1_1_audio_stream.html#aab76b523480d65f25f7df3c99f2dce47',1,'oboe::AudioStream']]],
+  ['notifyworkloadreset_1',['notifyWorkloadReset',['../classoboe_1_1_audio_stream.html#a3625762def846a6f4b3f48548bfa1b9c',1,'oboe::AudioStream']]],
+  ['notifyworkloadspike_2',['notifyWorkloadSpike',['../classoboe_1_1_audio_stream.html#a5124210a3410ab9e36ea4c4b8b30e7b1',1,'oboe::AudioStream']]],
+  ['number_3',['Number',['../structoboe_1_1_version.html#ac579661e79bcee45dc676d4647891de0',1,'oboe::Version']]]
 ];

menudata.js

@@ -0,0 +1,9 @@
+var searchData=
+[
+  ['waitforavailableframes_0',['waitForAvailableFrames',['../classoboe_1_1_audio_stream.html#ac0974b61c525d3b275dce342f75c208f',1,'oboe::AudioStream']]],
+  ['waitforstatechange_1',['waitForStateChange',['../classoboe_1_1_audio_stream.html#a0c865a5501f369d959c39d8ab8b46a07',1,'oboe::AudioStream']]],
+  ['waitforstatetransition_2',['waitForStateTransition',['../classoboe_1_1_audio_stream.html#a8adbacd6a55a94a532916ab037fba1d6',1,'oboe::AudioStream']]],
+  ['waserrorcallbackcalled_3',['wasErrorCallbackCalled',['../classoboe_1_1_audio_stream.html#aa48da7bf28026b7cccee73e6b054af28',1,'oboe::AudioStream']]],
+  ['willuseaaudio_4',['willUseAAudio',['../classoboe_1_1_audio_stream_builder.html#aa07ea100fcb107d9f7913f206c2214f4',1,'oboe::AudioStreamBuilder']]],
+  ['write_5',['write',['../classoboe_1_1_audio_stream.html#ad23cd8bf80d480ffb613c03d5e5d4512',1,'oboe::AudioStream::write()'],['../classoboe_1_1_fifo_buffer.html#a6a7cc7a1271ecf08a8eb08424703b459',1,'oboe::FifoBuffer::write()']]]
+];