pnmixer-rust/support_audio/index.html

180 lines
8.2 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 `support_audio` mod in crate `pnmixerlib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, support_audio">
<title>pnmixerlib::support_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 support_audio</p><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a></p><script>window.sidebarCurrent = {name: 'support_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=''>support_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/support_audio.rs.html#1-109' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Helper functions of the audio subsystem.</p>
<p>These functions are not directly connected to the <code>Audio</code> struct,
but are important helpers.</p>
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.VolDir.html"
title='enum pnmixerlib::support_audio::VolDir'>VolDir</a></td>
<td class='docblock-short'>
<p>The direction of a volume change.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.audio_reload.html"
title='fn pnmixerlib::support_audio::audio_reload'>audio_reload</a></td>
<td class='docblock-short'>
<p>Reload the audio system.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_card_names.html"
title='fn pnmixerlib::support_audio::get_playable_card_names'>get_playable_card_names</a></td>
<td class='docblock-short'>
<p>Get all playable card names.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_chan_names.html"
title='fn pnmixerlib::support_audio::get_playable_chan_names'>get_playable_chan_names</a></td>
<td class='docblock-short'>
<p>Get all playable channel names.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.lrint.html"
title='fn pnmixerlib::support_audio::lrint'>lrint</a></td>
<td class='docblock-short'>
<p>Kinda mimics <code>lrint</code> from libm. If the direction of the volume change
is <code>Up</code> then calls <code>ceil()</code>, if it&#39;s <code>Down</code>, then calls <code>floor()</code>, otherwise
returns the value unchanged.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.percent_to_vol.html"
title='fn pnmixerlib::support_audio::percent_to_vol'>percent_to_vol</a></td>
<td class='docblock-short'>
<p>Converts the percentage of the volume level (0-100) back to the actual
low-level representation of the volume, which depends on the volume
range.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.vol_change_to_voldir.html"
title='fn pnmixerlib::support_audio::vol_change_to_voldir'>vol_change_to_voldir</a></td>
<td class='docblock-short'>
<p>Convert a volume change to the <code>VolDir</code> type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.vol_to_percent.html"
title='fn pnmixerlib::support_audio::vol_to_percent'>vol_to_percent</a></td>
<td class='docblock-short'>
<p>Converts the actual volume of the audio configuration, which depends
on the volume range, to a scale of 0-100, reprenting the percentage
of the volume level.</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>