Skip to content

Commit

Permalink
Deploy preview for PR 1040 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
@roby2014
roby2014 committed Feb 28, 2024
1 parent 832a440 commit 58daabc
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 15 deletions.
86 changes: 72 additions & 14 deletions docs-preview/pr-1040/classcubos_1_1core_1_1al_1_1AudioDevice.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,28 +56,47 @@ <h3>Contents</h3>
<li>
Reference
<ul>
<li><a href="#pub-types">Public types</a></li>
<li><a href="#pub-static-methods">Public static functions</a></li>
<li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
<li><a href="#pub-methods">Public functions</a></li>
</ul>
</li>
</ul>
</nav>
<section id="pub-types">
<h2><a href="#pub-types">Public types</a></h2>
<dl class="m-doc">
<dt id="ae435f931176bb346b14fa2cf71c55743">
using <a href="#ae435f931176bb346b14fa2cf71c55743" class="m-doc-self">PortAudioOutputCallbackFn</a> = <a href="classcubos_1_1core_1_1memory_1_1Function.html" class="m-doc">core::<wbr />memory::<wbr />Function</a>&lt;int(void*output, unsigned long frameCount, unsigned long statusFlags, void*userData)&gt;
</dt>
<dd>Type alias for a user output callback function.</dd>
</dl>
</section>
<section id="pub-static-methods">
<h2><a href="#pub-static-methods">Public static functions</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">static auto <a href="#a9b82c634f455dafe60821c16ac2443bb" class="m-doc">create</a>(</span><span class="m-doc-wrap">const std::string&amp; specifier = &quot;&quot;) -&gt; std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">AudioDevice</a>&gt;</span>
<span class="m-doc-wrap-bumper">static auto <a href="#a468d771883b8065185c959d99c9ea9d7" class="m-doc">create</a>(</span><span class="m-doc-wrap">int deviceIndex = -1) -&gt; std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">AudioDevice</a>&gt;</span>
</dt>
<dd>Creates an audio device from a given device <code>specifier</code>.</dd>
<dd>Creates an audio device from a given device id <code>deviceIndex</code>.</dd>
<dt>
<span class="m-doc-wrap-bumper">static auto <a href="#a11c9fa5b5614d83ea8f3920f712d7bf7" class="m-doc">getDeviceCount</a>(</span><span class="m-doc-wrap">) -&gt; int</span>
<span class="m-doc-wrap-bumper">static auto <a href="#a807c4c66d3c0e02bddc2d9921f8b915d" class="m-doc">deviceCount</a>(</span><span class="m-doc-wrap">) -&gt; int</span>
</dt>
<dd>Retrieve the number of available devices. The number of available devices may be zero.</dd>
<dt>
<span class="m-doc-wrap-bumper">static void <a href="#a1ea21473b8cf876a7381c0e80ee523fd" class="m-doc">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;std::string&gt;&amp; devices)</span>
<span class="m-doc-wrap-bumper">static void <a href="#aa8f54783fe814e71eaf816cd5e4f5c9b" class="m-doc">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;<a href="structcubos_1_1core_1_1al_1_1DeviceInfo.html" class="m-doc">DeviceInfo</a>&gt;&amp; devices,
bool debug = false)</span>
</dt>
<dd>Enumerates the available devices.</dd>
<dt id="abd7d12b8185c837507f419e192f007e0">
<span class="m-doc-wrap-bumper">static auto <a href="#abd7d12b8185c837507f419e192f007e0" class="m-doc-self">deviceInfo</a>(</span><span class="m-doc-wrap">int deviceIndex) -&gt; <a href="structcubos_1_1core_1_1al_1_1DeviceInfo.html" class="m-doc">DeviceInfo</a></span>
</dt>
<dd>Retrieve the device information by its index.</dd>
<dt id="a493cd787501af1175690af46ffd34495">
<span class="m-doc-wrap-bumper">static void <a href="#a493cd787501af1175690af46ffd34495" class="m-doc-self">printDeviceInformation</a>(</span><span class="m-doc-wrap">int deviceIndex)</span>
</dt>
<dd>Prints device information by its index.</dd>
</dl>
</section>
<section id="typeless-methods">
Expand All @@ -92,6 +111,18 @@ <h2><a href="#typeless-methods">Constructors, destructors, conversion operators<
<section id="pub-methods">
<h2><a href="#pub-methods">Public functions</a></h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#a0c8fd710e17f4211072d2413f64045df" class="m-doc">init</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1al_1_1AudioDevice.html#ae435f931176bb346b14fa2cf71c55743" class="m-doc">PortAudioOutputCallbackFn</a> callback) -&gt; bool <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>Creates the stream.</dd>
<dt id="adb63bf169f4fbcd05fd5bb6d1f6b67d8">
<span class="m-doc-wrap-bumper">void <a href="#adb63bf169f4fbcd05fd5bb6d1f6b67d8" class="m-doc-self">start</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>Starts the stream.</dd>
<dt id="a8a33d80b08a8e2605e1e7a86feaefb97">
<span class="m-doc-wrap-bumper">void <a href="#a8a33d80b08a8e2605e1e7a86feaefb97" class="m-doc-self">stop</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
<dd>Stops the stream.</dd>
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#aa62570280045b495cbc6440e82bdeed3" class="m-doc">createBuffer</a>(</span><span class="m-doc-wrap">) -&gt; <a href="group__core-al.html#gabf798aa0b180fc8bba2872789bab349e" class="m-doc">Buffer</a> <span class="m-label m-flat m-warning">pure virtual</span></span>
</dt>
Expand All @@ -117,19 +148,19 @@ <h2><a href="#pub-methods">Public functions</a></h2>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="a9b82c634f455dafe60821c16ac2443bb"><div>
<section class="m-doc-details" id="a468d771883b8065185c959d99c9ea9d7"><div>
<h3>
<span class="m-doc-wrap-bumper">static std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">AudioDevice</a>&gt; cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9b82c634f455dafe60821c16ac2443bb" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">const std::string&amp; specifier = &quot;&quot;)</span></span>
<span class="m-doc-wrap-bumper">static std::shared_ptr&lt;<a href="classcubos_1_1core_1_1al_1_1AudioDevice.html" class="m-doc">AudioDevice</a>&gt; cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a468d771883b8065185c959d99c9ea9d7" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">int deviceIndex = -1)</span></span>
</h3>
<p>Creates an audio device from a given device <code>specifier</code>.</p>
<p>Creates an audio device from a given device id <code>deviceIndex</code>.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">specifier</td>
<td>Device specifier (empty for default).</td>
<td style="width: 1%">deviceIndex</td>
<td>Device specifier id (empty for default).</td>
</tr>
</tbody>
<tfoot>
Expand All @@ -139,11 +170,10 @@ <h3>
</tr>
</tfoot>
</table>
<aside class="m-note m-default"><h4>See also</h4><p><a href="classcubos_1_1core_1_1al_1_1AudioDevice.html#a1ea21473b8cf876a7381c0e80ee523fd" class="m-doc">enumerateDevices()</a></p></aside>
</div></section>
<section class="m-doc-details" id="a11c9fa5b5614d83ea8f3920f712d7bf7"><div>
<section class="m-doc-details" id="a807c4c66d3c0e02bddc2d9921f8b915d"><div>
<h3>
<span class="m-doc-wrap-bumper">static int cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a11c9fa5b5614d83ea8f3920f712d7bf7" class="m-doc-self">getDeviceCount</a>(</span><span class="m-doc-wrap">)</span></span>
<span class="m-doc-wrap-bumper">static int cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a807c4c66d3c0e02bddc2d9921f8b915d" class="m-doc-self">deviceCount</a>(</span><span class="m-doc-wrap">)</span></span>
</h3>
<p>Retrieve the number of available devices. The number of available devices may be zero.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -155,9 +185,10 @@ <h3>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="a1ea21473b8cf876a7381c0e80ee523fd"><div>
<section class="m-doc-details" id="aa8f54783fe814e71eaf816cd5e4f5c9b"><div>
<h3>
<span class="m-doc-wrap-bumper">static void cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a1ea21473b8cf876a7381c0e80ee523fd" class="m-doc-self">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;std::string&gt;&amp; devices)</span></span>
<span class="m-doc-wrap-bumper">static void cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa8f54783fe814e71eaf816cd5e4f5c9b" class="m-doc-self">enumerateDevices</a>(</span><span class="m-doc-wrap">std::vector&lt;<a href="structcubos_1_1core_1_1al_1_1DeviceInfo.html" class="m-doc">DeviceInfo</a>&gt;&amp; devices,
bool debug = false)</span></span>
</h3>
<p>Enumerates the available devices.</p>
<table class="m-table m-fullwidth m-flat">
Expand All @@ -169,9 +200,36 @@ <h3>
<td style="width: 1%">devices&nbsp;<span class="m-label m-flat m-warning">out</span></td>
<td>Vector to fill with the available devices.</td>
</tr>
<tr>
<td>debug</td>
<td>If true, will print the devices using CUBOS_DEBUG.</td>
</tr>
</tbody>
</table>
</div></section>
<section class="m-doc-details" id="a0c8fd710e17f4211072d2413f64045df"><div>
<h3>
<span class="m-doc-wrap-bumper">bool cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0c8fd710e17f4211072d2413f64045df" class="m-doc-self">init</a>(</span><span class="m-doc-wrap"><a href="classcubos_1_1core_1_1al_1_1AudioDevice.html#ae435f931176bb346b14fa2cf71c55743" class="m-doc">PortAudioOutputCallbackFn</a> callback) <span class="m-label m-warning">pure virtual</span></span></span>
</h3>
<p>Creates the stream.</p>
<table class="m-table m-fullwidth m-flat">
<thead>
<tr><th colspan="2">Parameters</th></tr>
</thead>
<tbody>
<tr>
<td style="width: 1%">callback</td>
<td>Supplied function that is responsible for processing and filling input and output buffers.</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Returns</th>
<td>Whether the stream was successfully created.</td>
</tr>
</tfoot>
</table>
</div></section>
<section class="m-doc-details" id="aa62570280045b495cbc6440e82bdeed3"><div>
<h3>
<span class="m-doc-wrap-bumper"><a href="group__core-al.html#gabf798aa0b180fc8bba2872789bab349e" class="m-doc">Buffer</a> cubos::<wbr />core::<wbr />al::<wbr />AudioDevice::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa62570280045b495cbc6440e82bdeed3" class="m-doc-self">createBuffer</a>(</span><span class="m-doc-wrap">) <span class="m-label m-warning">pure virtual</span></span></span>
Expand Down
2 changes: 1 addition & 1 deletion docs-preview/pr-1040/searchdata-v2.js
View file

Large diffs are not rendered by default.

0 comments on commit 58daabc

Please sign in to comment.