pnmixer-rust/pnmixerlib/support_alsa/index.html
2017-07-15 01:30:16 +02:00

215 lines
10 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_alsa` mod in crate `pnmixerlib`.">
<meta name="keywords" content="rust, rustlang, rust-lang, support_alsa">
<title>pnmixerlib::support_alsa - 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_alsa</p><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>pnmixerlib</a></p><script>window.sidebarCurrent = {name: 'support_alsa', 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_alsa</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_alsa.rs.html#1-166' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Alsa audio helper functions.</p>
<p>This mod wraps around a few low-level alsa functions and abstracts
out the details we don&#39;t care about.</p>
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.alsa_card_has_playable_selem.html"
title='fn pnmixerlib::support_alsa::alsa_card_has_playable_selem'>alsa_card_has_playable_selem</a></td>
<td class='docblock-short'>
<p>Check whether the given alsa card as a playable <code>Selem</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_alsa_card_by_id.html"
title='fn pnmixerlib::support_alsa::get_alsa_card_by_id'>get_alsa_card_by_id</a></td>
<td class='docblock-short'>
<p>Get an alsa card corresponding to the given ID.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_alsa_card_by_name.html"
title='fn pnmixerlib::support_alsa::get_alsa_card_by_name'>get_alsa_card_by_name</a></td>
<td class='docblock-short'>
<p>Get an alsa card by the given name.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_alsa_cards.html"
title='fn pnmixerlib::support_alsa::get_alsa_cards'>get_alsa_cards</a></td>
<td class='docblock-short'>
<p>Get all available alsa cards.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_default_alsa_card.html"
title='fn pnmixerlib::support_alsa::get_default_alsa_card'>get_default_alsa_card</a></td>
<td class='docblock-short'>
<p>Get the default alsa card. This is the one with the ID <code>0</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_first_playable_alsa_card.html"
title='fn pnmixerlib::support_alsa::get_first_playable_alsa_card'>get_first_playable_alsa_card</a></td>
<td class='docblock-short'>
<p>Get the first playable alsa card.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_first_playable_selem.html"
title='fn pnmixerlib::support_alsa::get_first_playable_selem'>get_first_playable_selem</a></td>
<td class='docblock-short'>
<p>Get the first playable <code>Selem</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_mixer.html"
title='fn pnmixerlib::support_alsa::get_mixer'>get_mixer</a></td>
<td class='docblock-short'>
<p>Get the <code>Mixer</code> for the given alsa card.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_alsa_card_names.html"
title='fn pnmixerlib::support_alsa::get_playable_alsa_card_names'>get_playable_alsa_card_names</a></td>
<td class='docblock-short'>
<p>Get the names of all playable alsa cards.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_selem_by_name.html"
title='fn pnmixerlib::support_alsa::get_playable_selem_by_name'>get_playable_selem_by_name</a></td>
<td class='docblock-short'>
<p>Get a playable <code>Selem</code> by the given name.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_selem_names.html"
title='fn pnmixerlib::support_alsa::get_playable_selem_names'>get_playable_selem_names</a></td>
<td class='docblock-short'>
<p>Get the names from all playable <code>Selem</code>s.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_playable_selems.html"
title='fn pnmixerlib::support_alsa::get_playable_selems'>get_playable_selems</a></td>
<td class='docblock-short'>
<p>Get all playable <code>Selem</code>s.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.get_selem.html"
title='fn pnmixerlib::support_alsa::get_selem'>get_selem</a></td>
<td class='docblock-short'>
<p>Get the <code>Selem</code> from the given <code>Elem</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.selem_is_playable.html"
title='fn pnmixerlib::support_alsa::selem_is_playable'>selem_is_playable</a></td>
<td class='docblock-short'>
<p>Check whether the given <code>Selem</code> is playable.</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>