pnmixer-rust/alsa/ctl/struct.Ctl.html
2017-07-15 01:30:16 +02:00

132 lines
13 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 `Ctl` struct in crate `alsa`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Ctl">
<title>alsa::ctl::Ctl - 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 struct">
<!--[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'>Struct Ctl</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>alsa</a>::<wbr><a href='index.html'>ctl</a></p><script>window.sidebarCurrent = {name: 'Ctl', ty: 'struct', 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'>Struct <a href='../index.html'>alsa</a>::<wbr><a href='index.html'>ctl</a>::<wbr><a class="struct" href=''>Ctl</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/alsa/ctl_int.rs.html#21' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Ctl(_);</pre><div class='docblock'><p><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___control.html">snd_ctl_t</a> wrapper</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/ctl_int.rs.html#25-62' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.open' class="method"><span id='open.v' class='invisible'><code>fn <a href='#method.open' class='fnname'>open</a>(c: &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/std/ffi/c_str/struct.CStr.html" title="struct std::ffi::c_str::CStr">CStr</a>, nonblock: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a>&gt;</code></span></h4>
<div class='docblock'><p>Open does not support async mode (it&#39;s not very Rustic anyway)</p>
</div><h4 id='method.from_card' class="method"><span id='from_card.v' class='invisible'><code>fn <a href='#method.from_card' class='fnname'>from_card</a>(c: &amp;<a class="struct" href="../../alsa/card/struct.Card.html" title="struct alsa::card::Card">Card</a>, nonblock: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a>&gt;</code></span></h4>
<h4 id='method.card_info' class="method"><span id='card_info.v' class='invisible'><code>fn <a href='#method.card_info' class='fnname'>card_info</a>(&amp;self) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/ctl/struct.CardInfo.html" title="struct alsa::ctl::CardInfo">CardInfo</a>&gt;</code></span></h4>
<h4 id='method.wait' class="method"><span id='wait.v' class='invisible'><code>fn <a href='#method.wait' class='fnname'>wait</a>(&amp;self, timeout_ms: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>&gt;) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>&gt;</code></span></h4>
<h4 id='method.get_db_range' class="method"><span id='get_db_range.v' class='invisible'><code>fn <a href='#method.get_db_range' class='fnname'>get_db_range</a>(&amp;self, id: &amp;<a class="struct" href="../../alsa/ctl/struct.ElemId.html" title="struct alsa::ctl::ElemId">ElemId</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../../alsa/mixer/struct.MilliBel.html" title="struct alsa::mixer::MilliBel">MilliBel</a>, <a class="struct" href="../../alsa/mixer/struct.MilliBel.html" title="struct alsa::mixer::MilliBel">MilliBel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>&gt;</code></span></h4>
<h4 id='method.convert_to_db' class="method"><span id='convert_to_db.v' class='invisible'><code>fn <a href='#method.convert_to_db' class='fnname'>convert_to_db</a>(&amp;self, id: &amp;<a class="struct" href="../../alsa/ctl/struct.ElemId.html" title="struct alsa::ctl::ElemId">ElemId</a>, volume: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/mixer/struct.MilliBel.html" title="struct alsa::mixer::MilliBel">MilliBel</a>&gt;</code></span></h4>
<h4 id='method.convert_from_db' class="method"><span id='convert_from_db.v' class='invisible'><code>fn <a href='#method.convert_from_db' class='fnname'>convert_from_db</a>(&amp;self, id: &amp;<a class="struct" href="../../alsa/ctl/struct.ElemId.html" title="struct alsa::ctl::ElemId">ElemId</a>, mb: <a class="struct" href="../../alsa/mixer/struct.MilliBel.html" title="struct alsa::mixer::MilliBel">MilliBel</a>, dir: <a class="enum" href="../../alsa/enum.Round.html" title="enum alsa::Round">Round</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.i64.html">i64</a>&gt;</code></span></h4>
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/ctl_int.rs.html#23' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/ctl_int.rs.html#64-66' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.drop' class="method"><span id='drop.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&amp;mut self)</code></span></h4>
<div class='docblock'><p>A method called when the value goes out of scope. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class="trait" href="../../alsa/poll/trait.PollDescriptors.html" title="trait alsa::poll::PollDescriptors">PollDescriptors</a> for <a class="struct" href="../../alsa/struct.Ctl.html" title="struct alsa::Ctl">Ctl</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/ctl_int.rs.html#68-81' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.count' class="method"><span id='count.v' class='invisible'><code>fn <a href='../../alsa/poll/trait.PollDescriptors.html#tymethod.count' class='fnname'>count</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
<h4 id='method.fill' class="method"><span id='fill.v' class='invisible'><code>fn <a href='../../alsa/poll/trait.PollDescriptors.html#tymethod.fill' class='fnname'>fill</a>(&amp;self, p: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>&gt;</code></span></h4>
<h4 id='method.revents' class="method"><span id='revents.v' class='invisible'><code>fn <a href='../../alsa/poll/trait.PollDescriptors.html#tymethod.revents' class='fnname'>revents</a>(&amp;self, p: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;[</a><a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="../../alsa/poll/struct.PollFlags.html" title="struct alsa::poll::PollFlags">PollFlags</a>&gt;</code></span></h4>
<h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>fn <a href='../../alsa/poll/trait.PollDescriptors.html#method.get' class='fnname'>get</a>(&amp;self) -&gt; <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a>&lt;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a>&lt;<a class="struct" href="../../libc/unix/struct.pollfd.html" title="struct libc::unix::pollfd">pollfd</a>&gt;&gt;</code></span></h4>
<div class='docblock'><p>Wrapper around count and fill - returns an array of pollfds</p>
</div></div></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 = "alsa";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>