249 lines
12 KiB
HTML
249 lines
12 KiB
HTML
|
<!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 `alsa` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, alsa">
|
|||
|
|
|
|||
|
|
<title>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'>Crate alsa</p><div class="block items"><ul><li><a href="#reexports">Reexports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'alsa', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>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'>−</span>]
|
|||
|
|
</a>
|
|||
|
|
</span><a class='srclink' href='../src/alsa/lib.rs.html#1-123' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Thin but safe wrappers for <a href="http://http://alsa-project.org">ALSA</a>.</p>
|
|||
|
|
|
|||
|
|
<p><a href="https://github.com/diwic/alsa-rs">Github repo</a></p>
|
|||
|
|
|
|||
|
|
<p><a href="https://crates.io/crates/alsa">Crates.io</a></p>
|
|||
|
|
|
|||
|
|
<p>This ALSA API wrapper/binding is WIP - the ALSA API is huge, and new
|
|||
|
|
functions and structs might be added as requested.</p>
|
|||
|
|
|
|||
|
|
<p>Most functions map 1-to-1 to alsa-lib functions, e g, <code>ctl::CardInfo::get_id()</code> is a wrapper around
|
|||
|
|
<code>snd_ctl_card_info_get_id</code> and the <a href="http://www.alsa-project.org/alsa-doc/alsa-lib/">alsa-lib documentation</a>
|
|||
|
|
can be consulted for additional information. </p>
|
|||
|
|
|
|||
|
|
<p>Enjoy!</p>
|
|||
|
|
</div><h2 id='reexports' class='section-header'><a href="#reexports">Reexports</a></h2>
|
|||
|
|
<table><tr><td><code>pub use card::<a class="struct" href="../alsa/card/struct.Card.html" title="struct alsa::card::Card">Card</a>;</code></td></tr><tr><td><code>pub use hctl::<a class="struct" href="../alsa/hctl/struct.HCtl.html" title="struct alsa::hctl::HCtl">HCtl</a>;</code></td></tr><tr><td><code>pub use pcm::<a class="struct" href="../alsa/pcm/struct.PCM.html" title="struct alsa::pcm::PCM">PCM</a>;</code></td></tr><tr><td><code>pub use rawmidi::<a class="struct" href="../alsa/rawmidi/struct.Rawmidi.html" title="struct alsa::rawmidi::Rawmidi">Rawmidi</a>;</code></td></tr><tr><td><code>pub use poll::<a class="trait" href="../alsa/poll/trait.PollDescriptors.html" title="trait alsa::poll::PollDescriptors">PollDescriptors</a>;</code></td></tr><tr><td><code>pub use mixer::<a class="struct" href="../alsa/mixer/struct.Mixer.html" title="struct alsa::mixer::Mixer">Mixer</a>;</code></td></tr><tr><td><code>pub use seq::<a class="struct" href="../alsa/seq/struct.Seq.html" title="struct alsa::seq::Seq">Seq</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="card/index.html"
|
|||
|
|
title='mod alsa::card'>card</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Sound card enumeration</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="ctl/index.html"
|
|||
|
|
title='mod alsa::ctl'>ctl</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Control device API</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="device_name/index.html"
|
|||
|
|
title='mod alsa::device_name'>device_name</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Enumerate devices in the alsa library configuration</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="hctl/index.html"
|
|||
|
|
title='mod alsa::hctl'>hctl</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>HCtl API - for mixer control and jack detection</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="mixer/index.html"
|
|||
|
|
title='mod alsa::mixer'>mixer</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Mixer API - Simple Mixer API for mixer control</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="pcm/index.html"
|
|||
|
|
title='mod alsa::pcm'>pcm</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Audio playback and capture</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="poll/index.html"
|
|||
|
|
title='mod alsa::poll'>poll</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Tiny poll ffi</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="rawmidi/index.html"
|
|||
|
|
title='mod alsa::rawmidi'>rawmidi</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>MIDI devices I/O and enumeration</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="mod" href="seq/index.html"
|
|||
|
|
title='mod alsa::seq'>seq</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>MIDI sequencer I/O and enumeration</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Ctl.html"
|
|||
|
|
title='struct alsa::Ctl'>Ctl</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___control.html">snd_ctl_t</a> wrapper</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Error.html"
|
|||
|
|
title='struct alsa::Error'>Error</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Most ALSA functions can return a negative error code.
|
|||
|
|
If so, then that error code is wrapped into this <code>Error</code> struct.
|
|||
|
|
An Error is also returned in case ALSA returns a string that
|
|||
|
|
cannot be translated into Rust's UTF-8 strings.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Output.html"
|
|||
|
|
title='struct alsa::Output'>Output</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___output.html">snd_output_t</a> wrapper</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.Direction.html"
|
|||
|
|
title='enum alsa::Direction'>Direction</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Replaces constants ending with PLAYBACK/CAPTURE as well as
|
|||
|
|
INPUT/OUTPUT</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.Round.html"
|
|||
|
|
title='enum alsa::Round'>Round</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Rounding mode (used in some mixer related calls)</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="enum" href="enum.ValueOr.html"
|
|||
|
|
title='enum alsa::ValueOr'>ValueOr</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Used to restrict hw parameters. In case the submitted
|
|||
|
|
value is unavailable, in which direction should one search
|
|||
|
|
for available values?</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="type" href="type.Result.html"
|
|||
|
|
title='type alsa::Result'>Result</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
|
|||
|
|
</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>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</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 = "alsa";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|