148 lines
19 KiB
HTML
148 lines
19 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 `HwParams` struct in crate `alsa`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, HwParams">
|
|||
|
|
|
|||
|
|
<title>alsa::pcm::HwParams - 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 HwParams</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'>pcm</a></p><script>window.sidebarCurrent = {name: 'HwParams', 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'>pcm</a>::<wbr><a class="struct" href=''>HwParams</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/pcm.rs.html#445' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct HwParams<'a>(_, _);</pre><div class='docblock'><p><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___p_c_m___h_w___params.html">snd_pcm_hw_params_t</a> wrapper</p>
|
|||
|
|
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/pcm.rs.html#451-565' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.any' class="method"><span id='any.v' class='invisible'><code>fn <a href='#method.any' class='fnname'>any</a>(a: &'a <a class="struct" href="../../alsa/pcm/struct.PCM.html" title="struct alsa::pcm::PCM">PCM</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_rate_resample' class="method"><span id='get_rate_resample.v' class='invisible'><code>fn <a href='#method.get_rate_resample' class='fnname'>get_rate_resample</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_rate_resample' class="method"><span id='set_rate_resample.v' class='invisible'><code>fn <a href='#method.set_rate_resample' class='fnname'>set_rate_resample</a>(&self, resample: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_channels_near' class="method"><span id='set_channels_near.v' class='invisible'><code>fn <a href='#method.set_channels_near' class='fnname'>set_channels_near</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_channels' class="method"><span id='set_channels.v' class='invisible'><code>fn <a href='#method.set_channels' class='fnname'>set_channels</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_channels' class="method"><span id='get_channels.v' class='invisible'><code>fn <a href='#method.get_channels' class='fnname'>get_channels</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_rate_near' class="method"><span id='set_rate_near.v' class='invisible'><code>fn <a href='#method.set_rate_near' class='fnname'>set_rate_near</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, dir: <a class="enum" href="../../alsa/enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_rate' class="method"><span id='set_rate.v' class='invisible'><code>fn <a href='#method.set_rate' class='fnname'>set_rate</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, dir: <a class="enum" href="../../alsa/enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_rate' class="method"><span id='get_rate.v' class='invisible'><code>fn <a href='#method.get_rate' class='fnname'>get_rate</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_format' class="method"><span id='set_format.v' class='invisible'><code>fn <a href='#method.set_format' class='fnname'>set_format</a>(&self, v: <a class="enum" href="../../alsa/pcm/enum.Format.html" title="enum alsa::pcm::Format">Format</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_format' class="method"><span id='get_format.v' class='invisible'><code>fn <a href='#method.get_format' class='fnname'>get_format</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="enum" href="../../alsa/pcm/enum.Format.html" title="enum alsa::pcm::Format">Format</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_access' class="method"><span id='set_access.v' class='invisible'><code>fn <a href='#method.set_access' class='fnname'>set_access</a>(&self, v: <a class="enum" href="../../alsa/pcm/enum.Access.html" title="enum alsa::pcm::Access">Access</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_access' class="method"><span id='get_access.v' class='invisible'><code>fn <a href='#method.get_access' class='fnname'>get_access</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="enum" href="../../alsa/pcm/enum.Access.html" title="enum alsa::pcm::Access">Access</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_period_size_near' class="method"><span id='set_period_size_near.v' class='invisible'><code>fn <a href='#method.set_period_size_near' class='fnname'>set_period_size_near</a>(&self, v: <a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>, dir: <a class="enum" href="../../alsa/enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_period_size' class="method"><span id='set_period_size.v' class='invisible'><code>fn <a href='#method.set_period_size' class='fnname'>set_period_size</a>(&self, v: <a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>, dir: <a class="enum" href="../../alsa/enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_period_size' class="method"><span id='get_period_size.v' class='invisible'><code>fn <a href='#method.get_period_size' class='fnname'>get_period_size</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_periods' class="method"><span id='set_periods.v' class='invisible'><code>fn <a href='#method.set_periods' class='fnname'>set_periods</a>(&self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, dir: <a class="enum" href="../../alsa/enum.ValueOr.html" title="enum alsa::ValueOr">ValueOr</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_periods' class="method"><span id='get_periods.v' class='invisible'><code>fn <a href='#method.get_periods' class='fnname'>get_periods</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_buffer_size_near' class="method"><span id='set_buffer_size_near.v' class='invisible'><code>fn <a href='#method.set_buffer_size_near' class='fnname'>set_buffer_size_near</a>(&self, v: <a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>></code></span></h4>
|
|||
|
|
<h4 id='method.set_buffer_size' class="method"><span id='set_buffer_size.v' class='invisible'><code>fn <a href='#method.set_buffer_size' class='fnname'>set_buffer_size</a>(&self, v: <a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.get_buffer_size' class="method"><span id='get_buffer_size.v' class='invisible'><code>fn <a href='#method.get_buffer_size' class='fnname'>get_buffer_size</a>(&self) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="type" href="../../alsa/pcm/type.Frames.html" title="type alsa::pcm::Frames">Frames</a>></code></span></h4>
|
|||
|
|
<h4 id='method.dump' class="method"><span id='dump.v' class='invisible'><code>fn <a href='#method.dump' class='fnname'>dump</a>(&self, o: &mut <a class="struct" href="../../alsa/struct.Output.html" title="struct alsa::Output">Output</a>) -> <a class="type" href="../../alsa/type.Result.html" title="type alsa::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">()</a>></code></span></h4>
|
|||
|
|
<h4 id='method.copy_from' class="method"><span id='copy_from.v' class='invisible'><code>fn <a href='#method.copy_from' class='fnname'>copy_from</a>(&mut self, other: &<a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a>)</code></span></h4>
|
|||
|
|
</div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<'a> <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/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/pcm.rs.html#447-449' 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>(&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> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/pcm.rs.html#567-573' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: &Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div><h3 class='impl'><span class='in-band'><code>impl<'a> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../alsa/pcm/struct.HwParams.html" title="struct alsa::pcm::HwParams">HwParams</a><'a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/alsa/pcm.rs.html#575-581' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter.</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>⇤</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>
|