pnmixer-rust/audio/index.html

157 lines
6.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `audio` mod in crate `pnmixerlib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, audio">
<title>pnmixerlib::audio - Rust</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
</head>
<body class="rustdoc mod">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'>Module audio</p><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a></p><script>window.sidebarCurrent = {name: 'audio', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>pnmixerlib</a>::<wbr><a class="mod" href=''>audio</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/pnmixerlib/audio.rs.html#1-448' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>High-level audio subsystem.</p>
<p>This is the middleman between the low-level audio backend (alsa),
and the high-level ui code.
This abstraction layer allows the high-level code to be completely unaware
of the underlying audio implementation, may it be alsa or whatever.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.Audio.html"
title='struct pnmixerlib::audio::Audio'>Audio</a></td>
<td class='docblock-short'>
<p>High-level Audio struct, which could theoretically be backend
agnostic.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Handlers.html"
title='struct pnmixerlib::audio::Handlers'>Handlers</a></td>
<td class='docblock-short'>
<p>Convenience struct to make handling this madness easier.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.AudioSignal.html"
title='enum pnmixerlib::audio::AudioSignal'>AudioSignal</a></td>
<td class='docblock-short'>
<p>An audio signal. This will be used to connect callbacks to the
audio system and react appropriately.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.AudioUser.html"
title='enum pnmixerlib::audio::AudioUser'>AudioUser</a></td>
<td class='docblock-short'>
<p>An audio user, used to determine from where a signal originated.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="enum" href="enum.VolLevel.html"
title='enum pnmixerlib::audio::VolLevel'>VolLevel</a></td>
<td class='docblock-short'>
<p>The volume level of the current audio configuration.</p>
</td>
</tr></table></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "pnmixerlib";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>