1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ANSI_X3.4-1968"><title>Control Names</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="Writing an ALSA Driver"><link rel="up" href="control-interface.html" title="Chapter&#160;6.&#160;Control Interface"><link rel="prev" href="control-interface-definition.html" title="Definition of Controls"><link rel="next" href="control-interface-access-flags.html" title="Access Flags"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Control Names</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="control-interface-definition.html">Prev</a>&#160;</td><th width="60%" align="center">Chapter&#160;6.&#160;Control Interface</th><td width="20%" align="right">&#160;<a accesskey="n" href="control-interface-access-flags.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="control-interface-control-names"></a>Control Names</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="section"><a href="control-interface-control-names.html#control-interface-control-names-global">Global capture and playback</a></span></dt><dt><span class="section"><a href="control-interface-control-names.html#control-interface-control-names-tone">Tone-controls</a></span></dt><dt><span class="section"><a href="control-interface-control-names.html#control-interface-control-names-3d">3D controls</a></span></dt><dt><span class="section"><a href="control-interface-control-names.html#control-interface-control-names-mic">Mic boost</a></span></dt></dl></div><p>
2        There are some standards to define the control names. A
3      control is usually defined from the three parts as
4      <span class="quote">&#8220;<span class="quote">SOURCE DIRECTION FUNCTION</span>&#8221;</span>. 
5      </p><p>
6        The first, <code class="constant">SOURCE</code>, specifies the source
7      of the control, and is a string such as <span class="quote">&#8220;<span class="quote">Master</span>&#8221;</span>,
8      <span class="quote">&#8220;<span class="quote">PCM</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">CD</span>&#8221;</span> and
9      <span class="quote">&#8220;<span class="quote">Line</span>&#8221;</span>. There are many pre-defined sources. 
10      </p><p>
11        The second, <code class="constant">DIRECTION</code>, is one of the
12      following strings according to the direction of the control:
13      <span class="quote">&#8220;<span class="quote">Playback</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">Capture</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">Bypass
14      Playback</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">Bypass Capture</span>&#8221;</span>. Or, it can
15      be omitted, meaning both playback and capture directions. 
16      </p><p>
17        The third, <code class="constant">FUNCTION</code>, is one of the
18      following strings according to the function of the control:
19      <span class="quote">&#8220;<span class="quote">Switch</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">Volume</span>&#8221;</span> and
20      <span class="quote">&#8220;<span class="quote">Route</span>&#8221;</span>. 
21      </p><p>
22        The example of control names are, thus, <span class="quote">&#8220;<span class="quote">Master Capture
23      Switch</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">PCM Playback Volume</span>&#8221;</span>. 
24      </p><p>
25        There are some exceptions:
26      </p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="control-interface-control-names-global"></a>Global capture and playback</h3></div></div></div><p>
27          <span class="quote">&#8220;<span class="quote">Capture Source</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">Capture Switch</span>&#8221;</span>
28        and <span class="quote">&#8220;<span class="quote">Capture Volume</span>&#8221;</span> are used for the global
29        capture (input) source, switch and volume. Similarly,
30        <span class="quote">&#8220;<span class="quote">Playback Switch</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">Playback
31        Volume</span>&#8221;</span> are used for the global output gain switch and
32        volume. 
33        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="control-interface-control-names-tone"></a>Tone-controls</h3></div></div></div><p>
34          tone-control switch and volumes are specified like
35        <span class="quote">&#8220;<span class="quote">Tone Control - XXX</span>&#8221;</span>, e.g. <span class="quote">&#8220;<span class="quote">Tone Control -
36        Switch</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">Tone Control - Bass</span>&#8221;</span>,
37        <span class="quote">&#8220;<span class="quote">Tone Control - Center</span>&#8221;</span>.  
38        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="control-interface-control-names-3d"></a>3D controls</h3></div></div></div><p>
39          3D-control switches and volumes are specified like <span class="quote">&#8220;<span class="quote">3D
40        Control - XXX</span>&#8221;</span>, e.g. <span class="quote">&#8220;<span class="quote">3D Control -
41        Switch</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">3D Control - Center</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">3D
42        Control - Space</span>&#8221;</span>. 
43        </p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="control-interface-control-names-mic"></a>Mic boost</h3></div></div></div><p>
44          Mic-boost switch is set as <span class="quote">&#8220;<span class="quote">Mic Boost</span>&#8221;</span> or
45        <span class="quote">&#8220;<span class="quote">Mic Boost (6dB)</span>&#8221;</span>. 
46        </p><p>
47          More precise information can be found in
48        <code class="filename">Documentation/sound/alsa/ControlNames.txt</code>.
49        </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="control-interface-definition.html">Prev</a>&#160;</td><td width="20%" align="center"><a accesskey="u" href="control-interface.html">Up</a></td><td width="40%" align="right">&#160;<a accesskey="n" href="control-interface-access-flags.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Definition of Controls&#160;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&#160;Access Flags</td></tr></table></div></body></html>
50