Files
phy/alsa/hctl/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

24 lines
5.8 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="HCtl API - for mixer control and jack detection"><title>alsa::hctl - 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="../sidebar-items.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"><!--[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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module hctl</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate alsa</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">alsa</a></span><h1>Module <span>hctl</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/hctl.rs.html#1-168">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>HCtl API - for mixer control and jack detection</p>
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
<p>Print all jacks and their status</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">for </span>a <span class="kw">in </span>::alsa::card::Iter::new().map(|x| x.unwrap()) {
<span class="kw">use </span>std::ffi::CString;
<span class="kw">use </span>alsa::hctl::HCtl;
<span class="kw">let </span>h = HCtl::open(<span class="kw-2">&amp;</span>CString::new(<span class="macro">format!</span>(<span class="string">"hw:{}"</span>, a.get_index())).unwrap(), <span class="bool-val">false</span>).unwrap();
h.load().unwrap();
<span class="kw">for </span>b <span class="kw">in </span>h.elem_iter() {
<span class="kw">use </span>alsa::ctl::ElemIface;
<span class="kw">let </span>id = b.get_id().unwrap();
<span class="kw">if </span>id.get_interface() != ElemIface::Card { <span class="kw">continue</span>; }
<span class="kw">let </span>name = id.get_name().unwrap();
<span class="kw">if </span>!name.ends_with(<span class="string">" Jack"</span>) { <span class="kw">continue</span>; }
<span class="kw">if </span>name.ends_with(<span class="string">" Phantom Jack"</span>) {
<span class="macro">println!</span>(<span class="string">"{} is always present"</span>, <span class="kw-2">&amp;</span>name[..name.len()-<span class="number">13</span>])
}
<span class="kw">else </span>{ <span class="macro">println!</span>(<span class="string">"{} is {}"</span>, <span class="kw-2">&amp;</span>name[..name.len()-<span class="number">5</span>],
<span class="kw">if </span>b.read().unwrap().get_boolean(<span class="number">0</span>).unwrap() { <span class="string">"plugged in" </span>} <span class="kw">else </span>{ <span class="string">"unplugged" </span>})
}
}
}</code></pre></div>
</div></details><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.Elem.html" title="struct alsa::hctl::Elem">Elem</a></div><div class="desc docblock-short"><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___h_control.html">snd_hctl_elem_t</a> wrapper</div></li><li><div class="item-name"><a class="struct" href="struct.ElemIter.html" title="struct alsa::hctl::ElemIter">Elem<wbr>Iter</a></div><div class="desc docblock-short">Iterates over elements for a <code>HCtl</code></div></li><li><div class="item-name"><a class="struct" href="struct.HCtl.html" title="struct alsa::hctl::HCtl">HCtl</a></div><div class="desc docblock-short"><a href="http://www.alsa-project.org/alsa-doc/alsa-lib/group___h_control.html">snd_hctl_t</a> wrapper</div></li></ul></section></div></main></body></html>