13 lines
8.7 KiB
HTML
13 lines
8.7 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="Thin but safe wrappers for ALSA."><title>alsa - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="alsa" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../alsa/index.html">alsa</a><span class="version">0.9.1</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>alsa</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/alsa/lib.rs.html#1-133">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Thin but safe wrappers for <a href="https://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="https://www.alsa-project.org/alsa-doc/alsa-lib/">alsa-lib documentation</a>
|
|
can be consulted for additional information.</p>
|
|
<p>Enjoy!</p>
|
|
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Card"><code>pub use crate::card::<a class="struct" href="card/struct.Card.html" title="struct alsa::card::Card">Card</a>;</code></div></li><li><div class="item-name" id="reexport.Ctl"><code>pub use crate::ctl::<a class="struct" href="ctl/struct.Ctl.html" title="struct alsa::ctl::Ctl">Ctl</a>;</code></div></li><li><div class="item-name" id="reexport.HCtl"><code>pub use crate::hctl::<a class="struct" href="hctl/struct.HCtl.html" title="struct alsa::hctl::HCtl">HCtl</a>;</code></div></li><li><div class="item-name" id="reexport.PCM"><code>pub use crate::pcm::<a class="struct" href="pcm/struct.PCM.html" title="struct alsa::pcm::PCM">PCM</a>;</code></div></li><li><div class="item-name" id="reexport.Rawmidi"><code>pub use crate::rawmidi::<a class="struct" href="rawmidi/struct.Rawmidi.html" title="struct alsa::rawmidi::Rawmidi">Rawmidi</a>;</code></div></li><li><div class="item-name" id="reexport.PollDescriptors"><code>pub use crate::poll::<a class="trait" href="poll/trait.Descriptors.html" title="trait alsa::poll::Descriptors">Descriptors</a> as PollDescriptors;</code></div></li><li><div class="item-name" id="reexport.Mixer"><code>pub use crate::mixer::<a class="struct" href="mixer/struct.Mixer.html" title="struct alsa::mixer::Mixer">Mixer</a>;</code></div></li><li><div class="item-name" id="reexport.Seq"><code>pub use crate::seq::<a class="struct" href="seq/struct.Seq.html" title="struct alsa::seq::Seq">Seq</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="card/index.html" title="mod alsa::card">card</a></div><div class="desc docblock-short">Sound card enumeration</div></li><li><div class="item-name"><a class="mod" href="ctl/index.html" title="mod alsa::ctl">ctl</a></div><div class="desc docblock-short">Control device API</div></li><li><div class="item-name"><a class="mod" href="device_name/index.html" title="mod alsa::device_name">device_<wbr>name</a></div><div class="desc docblock-short">Enumerate devices in the alsa library configuration</div></li><li><div class="item-name"><a class="mod" href="direct/index.html" title="mod alsa::direct">direct</a></div><div class="desc docblock-short">Functions that bypass alsa-lib and talk directly to the kernel.</div></li><li><div class="item-name"><a class="mod" href="hctl/index.html" title="mod alsa::hctl">hctl</a></div><div class="desc docblock-short">HCtl API - for mixer control and jack detection</div></li><li><div class="item-name"><a class="mod" href="mixer/index.html" title="mod alsa::mixer">mixer</a></div><div class="desc docblock-short">Mixer API - Simple Mixer API for mixer control</div></li><li><div class="item-name"><a class="mod" href="pcm/index.html" title="mod alsa::pcm">pcm</a></div><div class="desc docblock-short">Audio playback and capture</div></li><li><div class="item-name"><a class="mod" href="poll/index.html" title="mod alsa::poll">poll</a></div><div class="desc docblock-short">Tiny poll ffi</div></li><li><div class="item-name"><a class="mod" href="rawmidi/index.html" title="mod alsa::rawmidi">rawmidi</a></div><div class="desc docblock-short">MIDI devices I/O and enumeration</div></li><li><div class="item-name"><a class="mod" href="seq/index.html" title="mod alsa::seq">seq</a></div><div class="desc docblock-short">MIDI sequencer I/O and enumeration</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct alsa::Error">Error</a></div><div class="desc docblock-short">ALSA error</div></li><li><div class="item-name"><a class="struct" href="struct.Output.html" title="struct alsa::Output">Output</a></div><div class="desc docblock-short"><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___output.html">snd_output_t</a> wrapper</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Direction.html" title="enum alsa::Direction">Direction</a></div><div class="desc docblock-short">Replaces constants ending with PLAYBACK/CAPTURE as well as
|
|
INPUT/OUTPUT</div></li><li><div class="item-name"><a class="enum" href="enum.Round.html" title="enum alsa::Round">Round</a></div><div class="desc docblock-short">Rounding mode (used in some mixer related calls)</div></li><li><div class="item-name"><a class="enum" href="enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a></div><div class="desc docblock-short">Used to restrict hw parameters. In case the submitted
|
|
value is unavailable, in which direction should one search
|
|
for available values?</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Result.html" title="type alsa::Result">Result</a></div></li></ul></section></div></main></body></html> |