2 lines
13 KiB
HTML
2 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Internals · PortAudio.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">PortAudio.jl</a></span></div><form class="docs-search" action="../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../">Public interface</a></li><li class="is-active"><a class="tocitem" href>Internals</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Internals</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Internals</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/JuliaAudio/PortAudio.jl/blob/master/docs/src/internals.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Internals"><a class="docs-heading-anchor" href="#Internals">Internals</a><a id="Internals-1"></a><a class="docs-heading-anchor-permalink" href="#Internals" title="Permalink"></a></h1><ul><li><a href="#PortAudio.Buffer"><code>PortAudio.Buffer</code></a></li><li><a href="#PortAudio.Messenger"><code>PortAudio.Messenger</code></a></li><li><a href="#PortAudio.SampledSignalsReader"><code>PortAudio.SampledSignalsReader</code></a></li><li><a href="#PortAudio.SampledSignalsWriter"><code>PortAudio.SampledSignalsWriter</code></a></li><li><a href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a></li><li><a href="#PortAudio.get_input_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_input_type</code></a></li><li><a href="#PortAudio.get_output_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_output_type</code></a></li><li><a href="#PortAudio.read_buffer!"><code>PortAudio.read_buffer!</code></a></li><li><a href="#PortAudio.write_buffer"><code>PortAudio.write_buffer</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="PortAudio.Buffer" href="#PortAudio.Buffer"><code>PortAudio.Buffer</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct PortAudio.Buffer{Sample}</code></pre><p>A <code>PortAudio.Buffer</code> contains everything you might need to read or write data from or to PortAudio. The <code>data</code> field contains the raw data in the buffer. Use <a href="#PortAudio.write_buffer"><code>PortAudio.write_buffer</code></a> to write data to PortAudio, and <a href="#PortAudio.read_buffer!"><code>PortAudio.read_buffer!</code></a> to read data from PortAudio.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L389-L395">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.Messenger" href="#PortAudio.Messenger"><code>PortAudio.Messenger</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">Messenger{Sample, Scribe, Input, Output}</code></pre><p>A <code>struct</code> with entries</p><ul><li><code>device_name::String</code></li><li><code>buffer::Buffer{Sample}</code></li><li><code>scribe::Scribe</code></li><li><code>input_channel::Channel{Input}</code></li><li><code>output_channel::Channel{Output}</code></li></ul><p>The messenger will send tasks to the scribe; the scribe will read/write from the buffer.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L448-L459">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.SampledSignalsReader" href="#PortAudio.SampledSignalsReader"><code>PortAudio.SampledSignalsReader</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct PortAudio.SampledSignalsReader</code></pre><p>A <a href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a> that will use the <code>SampledSignals</code> package to manage reading data from PortAudio.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L282-L286">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.SampledSignalsWriter" href="#PortAudio.SampledSignalsWriter"><code>PortAudio.SampledSignalsWriter</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">struct PortAudio.SampledSignalsReader</code></pre><p>A <a href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a> that will use the <code>SampledSignals</code> package to manage writing data to PortAudio.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L289-L293">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.Scribe" href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">abstract type PortAudio.Scribe end</code></pre><p>A scribe must implement the following:</p><ul><li>A method for <a href="#PortAudio.get_input_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_input_type</code></a></li><li>A method for <a href="#PortAudio.get_output_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_output_type</code></a></li><li>A method to call itself on two arguments: a <a href="#PortAudio.Buffer"><code>PortAudio.Buffer</code></a> and an input of the input type. This method must return an output of the output type. This method should make use of <a href="#PortAudio.read_buffer!"><code>PortAudio.read_buffer!</code></a> and <a href="#PortAudio.write_buffer"><code>PortAudio.write_buffer</code></a>.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L267-L277">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.get_input_type-Tuple{PortAudio.SampledSignalsScribe, Any}" href="#PortAudio.get_input_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_input_type</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">PortAudio.get_input_type(scribe::PortAudio.Scribe, Sample)</code></pre><p>Get the input type of a <a href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a> for samples of type <code>Sample</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L296-L300">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.get_output_type-Tuple{PortAudio.SampledSignalsScribe, Any}" href="#PortAudio.get_output_type-Tuple{PortAudio.SampledSignalsScribe, Any}"><code>PortAudio.get_output_type</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">PortAudio.get_input_type(scribe::PortAudio.Scribe, Sample)</code></pre><p>Get the output type of a <a href="#PortAudio.Scribe"><code>PortAudio.Scribe</code></a> for samples of type <code>Sample</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L307-L311">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.read_buffer!" href="#PortAudio.read_buffer!"><code>PortAudio.read_buffer!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">PortAudio.read_buffer!(buffer::Buffer, use_frames = buffer.frames_per_buffer; acquire_lock = true)</code></pre><p>Read a number of frames (<code>use_frames</code>) from PortAudio to a <a href="#PortAudio.Buffer"><code>PortAudio.Buffer</code></a>.</p><p>Set <code>acquire_lock = false</code> to skip acquiring the acquire_lock.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L437-L443">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PortAudio.write_buffer" href="#PortAudio.write_buffer"><code>PortAudio.write_buffer</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">PortAudio.write_buffer(buffer, use_frames = buffer.frames_per_buffer; acquire_lock = true)</code></pre><p>Write a number of frames (<code>use_frames</code>) from a <a href="#PortAudio.Buffer"><code>PortAudio.Buffer</code></a> to PortAudio.</p><p>Set <code>acquire_lock = false</code> to skip acquiring the lock.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaAudio/PortAudio.jl/blob/06c6fd04959975644e308b23138313bfcfde4765/src/PortAudio.jl#L426-L432">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Public interface</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.22 on <span class="colophon-date" title="Sunday 24 July 2022 15:58">Sunday 24 July 2022</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
|