| Current File : //proc/thread-self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/use-case_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ALSA project - the C library reference: /builddir/build/BUILD/alsa-lib-1.2.13/include/use-case.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ALSA project - the C library reference
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">use-case.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="use-case_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"><a class="line" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e"> 1</a></span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * published by the Free Software Foundation; either version 2.1 of</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * Copyright (C) 2008-2010 SlimLogic Ltd</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * Copyright (C) 2010 Wolfson Microelectronics PLC</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * Copyright (C) 2010 Texas Instruments Inc.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * Support for the verb/device/modifier core logic and API,</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * command line tool and file parser was kindly sponsored by</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * Texas Instruments Inc.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * Support for multiple active modifiers and devices,</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * transition sequences, multiple client access and user defined use</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * cases was kindly sponsored by Wolfson Microelectronics PLC.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifndef __ALSA_USE_CASE_H</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define __ALSA_USE_CASE_H</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <alsa/asoundlib.h></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * Use Case Verb.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * The use case verb is the main device audio action. e.g. the "HiFi" use</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * case verb will configure the audio hardware for HiFi Music playback</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * and capture.</span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="group__ucm.html#gaedcdfd09f499b753d8652772ef1a248f"> 100</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_INACTIVE "Inactive"</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="group__ucm.html#ga71b24a1fcc4ce2cee555520ca546b348"> 101</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_HIFI "HiFi"</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="group__ucm.html#ga9a0739ade4ac574b31b4728c22280861"> 102</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_HIFI_LOW_POWER "HiFi Low Power"</span> </div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="group__ucm.html#gae496d33ac019caffae8dca584b04d09f"> 103</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_VOICE "Voice"</span> </div>
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="group__ucm.html#ga64b61825903d5ce88d3f4cfb12c7bd00"> 104</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_VOICE_LOW_POWER "Voice Low Power"</span> </div>
<div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="group__ucm.html#gaaa4aed51667887d194caae91362e8428"> 105</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_VOICECALL "Voice Call"</span> </div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="group__ucm.html#ga938754af309628dfc8bafe28018b8aab"> 106</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_IP_VOICECALL "Voice Call IP"</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="group__ucm.html#gab08fad02c1e8641016be957fc5ce3705"> 107</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_ANALOG_RADIO "FM Analog Radio"</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="group__ucm.html#gac1fc6fc3c4f08b4de9e622d05b591cb2"> 108</a></span> <span class="preprocessor">#define SND_USE_CASE_VERB_DIGITAL_RADIO "FM Digital Radio"</span> </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/* add new verbs to end of list */</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * Use Case Device.</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * Physical system devices the render and capture audio. Devices can be OR'ed</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * together to support audio on simultaneous devices.</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * If multiple devices with the same name exists, the number suffixes should</span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * be added to these names like HDMI1,HDMI2,HDMI3 etc. No number gaps are</span></div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * allowed. The names with numbers must be continuous. It is allowed to put</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * a whitespace between name and index (like 'Line 1') for the better</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * readability. The device names 'Line 1' and 'Line1' are equal for</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * this purpose.</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * If EnableSequence/DisableSequence controls independent paths in the hardware</span></div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * it is also recommended to split playback and capture UCM devices and use</span></div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> * the number suffixes. Example use case: Use the integrated microphone</span></div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> * in the laptop instead the microphone in headphones.</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * The preference of the devices is determined by the priority value.</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="group__ucm.html#gaa7abb8ce3d21b584c621869f7ebed3e6"> 132</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_NONE "None"</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="group__ucm.html#ga515b2956d58485b27fb982965d067c55"> 133</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_SPEAKER "Speaker"</span> </div>
<div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="group__ucm.html#gaa5d03312d1990c0bd5c162f61fbfa4a0"> 134</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_LINE "Line"</span> </div>
<div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="group__ucm.html#gaec0f823989984e14fab7c8e2749d76ac"> 135</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_MIC "Mic"</span> </div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="group__ucm.html#gaf2c22989c5315abcee46713cde8693d2"> 136</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_HEADPHONES "Headphones"</span> </div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="group__ucm.html#ga72c3300fac357a2e22b52afc13547ce0"> 137</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_HEADSET "Headset"</span> </div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="group__ucm.html#ga315d29bfbdf84cff8b7a593c34f6393b"> 138</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_HANDSET "Handset"</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="group__ucm.html#ga4992d89d4ec8be51f19bec0a69ba1984"> 139</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_BLUETOOTH "Bluetooth"</span> </div>
<div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="group__ucm.html#ga6ca86620d080360f6e2a240efb334dec"> 140</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_EARPIECE "Earpiece"</span> </div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="group__ucm.html#ga7f7f45feb440a49be3be9e52da98b242"> 141</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_SPDIF "SPDIF"</span> </div>
<div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="group__ucm.html#gab4e4a2b3d44883b1ffb5406529746faf"> 142</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_HDMI "HDMI"</span> </div>
<div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="group__ucm.html#gae1b6c362013390117cf4d667bba88b3c"> 143</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_USB "USB"</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="group__ucm.html#ga75be5633c387b6b4b9067013f76e9969"> 144</a></span> <span class="preprocessor">#define SND_USE_CASE_DEV_DIRECT "Direct"</span> </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment">/* add new devices to end of list */</span></div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * Use Case Modifiers.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * The use case modifier allows runtime configuration changes to deal with</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * asynchronous events.</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * If multiple modifiers with the same name exists, the number suffixes should</span></div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * be added to these names like 'Echo Reference 1','Echo Reference 2' etc.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * No number gaps are allowed. The names with numbers must be continuous.</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * It is allowed to put a whitespace between name and index for the better</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * readability. The modifier names 'Something 1' and 'Something1' are equal</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * for this purpose.</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * e.g. to record a voice call :-</span></div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * 1. Set verb to SND_USE_CASE_VERB_VOICECALL (for voice call)</span></div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * 2. Set modifier SND_USE_CASE_MOD_CAPTURE_VOICE when capture required.</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * 3. Call snd_use_case_get("CapturePCM") to get ALSA source PCM name</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * with captured voice pcm data.</span></div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * e.g. to play a ring tone when listenin to MP3 Music :-</span></div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * 1. Set verb to SND_USE_CASE_VERB_HIFI (for MP3 playback)</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * 2. Set modifier to SND_USE_CASE_MOD_PLAY_TONE when incoming call happens.</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * 3. Call snd_use_case_get("PlaybackPCM") to get ALSA PCM sink name for</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * ringtone pcm data.</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="line" href="group__ucm.html#gaec6b78d147824af1474fc914770a834c"> 173</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_CAPTURE_VOICE "Capture Voice"</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"><a class="line" href="group__ucm.html#gad685f6b4dcb9e37f0b5a1160425aec23"> 174</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_CAPTURE_MUSIC "Capture Music"</span> </div>
<div class="line"><a name="l00175"></a><span class="lineno"><a class="line" href="group__ucm.html#gadee4d4dce15624e282ab1960113caf8b"> 175</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_PLAY_MUSIC "Play Music"</span> </div>
<div class="line"><a name="l00176"></a><span class="lineno"><a class="line" href="group__ucm.html#ga61c217f060e616d61a294ac5d5d2fac0"> 176</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_PLAY_VOICE "Play Voice"</span> </div>
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="group__ucm.html#gaacc8e06e0c8fc0de5e26df6f20462484"> 177</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_PLAY_TONE "Play Tone"</span> </div>
<div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="group__ucm.html#gae2a230a913142c17f30d7dc2ae416866"> 178</a></span> <span class="preprocessor">#define SND_USE_CASE_MOD_ECHO_REF "Echo Reference"</span> </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/* add new modifiers to end of list */</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  </div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div>
<div class="line"><a name="l00190"></a><span class="lineno"><a class="line" href="group__ucm.html#ga64dd2e9f8e4e800effc02d895e1bfdbb"> 190</a></span> <span class="preprocessor">#define SND_USE_CASE_TQ_MUSIC "Music"</span> </div>
<div class="line"><a name="l00191"></a><span class="lineno"><a class="line" href="group__ucm.html#gaa822e565021887e26c0eaec2cee97bbd"> 191</a></span> <span class="preprocessor">#define SND_USE_CASE_TQ_VOICE "Voice"</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"><a class="line" href="group__ucm.html#ga022328b4bb0b0b14d358cb2155e5d184"> 192</a></span> <span class="preprocessor">#define SND_USE_CASE_TQ_TONES "Tones"</span> </div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>snd_use_case_mgr <a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a>;</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keywordtype">char</span> *<a class="code" href="group__ucm.html#ga530159363360c3cae3c9816c034fbcc5">snd_use_case_identifier</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  </div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#ga003553ee6fd13119fc9e08ffcdd959f9">snd_use_case_free_list</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *list[], <span class="keywordtype">int</span> items);</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  </div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">snd_use_case_get_list</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr,</div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier,</div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **list[]);</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>  </div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div>
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#ga9c13ae514eeebf918adcec0e4534aca5">snd_use_case_get</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr,</div>
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier,</div>
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **value);</div>
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span>  </div>
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#ga66311429dfd62743089be3eb79f1d1f5">snd_use_case_geti</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr,</div>
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier,</div>
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span>  <span class="keywordtype">long</span> *value);</div>
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span>  </div>
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gae9ff2a06c955d40ad0204f21f8352831">snd_use_case_set</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr,</div>
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier,</div>
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  </div>
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#ga74f0ef0116590fe8eec1edeaf1d88847">snd_use_case_mgr_open</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> **uc_mgr,</div>
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *card_name);</div>
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span>  </div>
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span>  </div>
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gafedd1fc74ce9086033f6f668348321b4">snd_use_case_mgr_reload</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr);</div>
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span>  </div>
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gaac2bf25d233230d2d6a9e422795d716c">snd_use_case_mgr_close</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr);</div>
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span>  </div>
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#ga1364dba503c216b2e46085a3f4abd20a">snd_use_case_mgr_reset</a>(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr);</div>
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span>  </div>
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> * helper functions</span></div>
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span>  </div>
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="keyword">static</span> __inline__ <span class="keywordtype">int</span> snd_use_case_card_list(<span class="keyword">const</span> <span class="keywordtype">char</span> **list[])</div>
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> {</div>
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span>  <span class="keywordflow">return</span> <a class="code" href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">snd_use_case_get_list</a>(NULL, NULL, list);</div>
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> }</div>
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span>  </div>
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="keyword">static</span> __inline__ <span class="keywordtype">int</span> snd_use_case_verb_list(<a class="code" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr,</div>
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> **list[])</div>
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> {</div>
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span>  <span class="keywordflow">return</span> <a class="code" href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">snd_use_case_get_list</a>(uc_mgr, <span class="stringliteral">"_verbs"</span>, list);</div>
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> }</div>
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span>  </div>
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a">snd_use_case_parse_ctl_elem_id</a>(<a class="code" href="group___control.html#gad6c3746f1925bfec6a4fd0e913430e55">snd_ctl_elem_id_t</a> *dst,</div>
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *ucm_id,</div>
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span>  </div>
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="keywordtype">int</span> <a class="code" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075">snd_use_case_parse_selem_id</a>(<a class="code" href="group___simple_mixer.html#gac0bfc2b9efcbc308df2daad92983e2ee">snd_mixer_selem_id_t</a> *dst,</div>
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *ucm_id,</div>
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *value);</div>
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span>  </div>
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> }</div>
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span>  </div>
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="preprocessor">#endif </span><span class="comment">/* __ALSA_USE_CASE_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="agroup___control_html_gad6c3746f1925bfec6a4fd0e913430e55"><div class="ttname"><a href="group___control.html#gad6c3746f1925bfec6a4fd0e913430e55">snd_ctl_elem_id_t</a></div><div class="ttdeci">struct _snd_ctl_elem_id snd_ctl_elem_id_t</div><div class="ttdef"><b>Definition:</b> control.h:82</div></div>
<div class="ttc" id="agroup___simple_mixer_html_gac0bfc2b9efcbc308df2daad92983e2ee"><div class="ttname"><a href="group___simple_mixer.html#gac0bfc2b9efcbc308df2daad92983e2ee">snd_mixer_selem_id_t</a></div><div class="ttdeci">struct _snd_mixer_selem_id snd_mixer_selem_id_t</div><div class="ttdef"><b>Definition:</b> mixer.h:219</div></div>
<div class="ttc" id="agroup__ucm_html_ga003553ee6fd13119fc9e08ffcdd959f9"><div class="ttname"><a href="group__ucm.html#ga003553ee6fd13119fc9e08ffcdd959f9">snd_use_case_free_list</a></div><div class="ttdeci">int snd_use_case_free_list(const char *list[], int items)</div><div class="ttdoc">Free a string list.</div><div class="ttdef"><b>Definition:</b> main.c:153</div></div>
<div class="ttc" id="agroup__ucm_html_ga1364dba503c216b2e46085a3f4abd20a"><div class="ttname"><a href="group__ucm.html#ga1364dba503c216b2e46085a3f4abd20a">snd_use_case_mgr_reset</a></div><div class="ttdeci">int snd_use_case_mgr_reset(snd_use_case_mgr_t *uc_mgr)</div><div class="ttdoc">Reset use case manager verb, device, modifier to deafult settings.</div><div class="ttdef"><b>Definition:</b> main.c:1646</div></div>
<div class="ttc" id="agroup__ucm_html_ga530159363360c3cae3c9816c034fbcc5"><div class="ttname"><a href="group__ucm.html#ga530159363360c3cae3c9816c034fbcc5">snd_use_case_identifier</a></div><div class="ttdeci">char * snd_use_case_identifier(const char *fmt,...)</div><div class="ttdoc">Create an identifier.</div><div class="ttdef"><b>Definition:</b> main.c:128</div></div>
<div class="ttc" id="agroup__ucm_html_ga66311429dfd62743089be3eb79f1d1f5"><div class="ttname"><a href="group__ucm.html#ga66311429dfd62743089be3eb79f1d1f5">snd_use_case_geti</a></div><div class="ttdeci">int snd_use_case_geti(snd_use_case_mgr_t *uc_mgr, const char *identifier, long *value)</div><div class="ttdoc">Get current - integer.</div><div class="ttdef"><b>Definition:</b> main.c:2399</div></div>
<div class="ttc" id="agroup__ucm_html_ga74f0ef0116590fe8eec1edeaf1d88847"><div class="ttname"><a href="group__ucm.html#ga74f0ef0116590fe8eec1edeaf1d88847">snd_use_case_mgr_open</a></div><div class="ttdeci">int snd_use_case_mgr_open(snd_use_case_mgr_t **uc_mgr, const char *card_name)</div><div class="ttdoc">Open and initialise use case core for sound card.</div><div class="ttdef"><b>Definition:</b> main.c:1508</div></div>
<div class="ttc" id="agroup__ucm_html_ga9c13ae514eeebf918adcec0e4534aca5"><div class="ttname"><a href="group__ucm.html#ga9c13ae514eeebf918adcec0e4534aca5">snd_use_case_get</a></div><div class="ttdeci">int snd_use_case_get(snd_use_case_mgr_t *uc_mgr, const char *identifier, const char **value)</div><div class="ttdoc">Get current - string.</div><div class="ttdef"><b>Definition:</b> main.c:2287</div></div>
<div class="ttc" id="agroup__ucm_html_gaa128bcb412f42247e561b81ec342c2e1"><div class="ttname"><a href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">snd_use_case_get_list</a></div><div class="ttdeci">int snd_use_case_get_list(snd_use_case_mgr_t *uc_mgr, const char *identifier, const char **list[])</div><div class="ttdoc">Obtain a list of entries.</div><div class="ttdef"><b>Definition:</b> main.c:2077</div></div>
<div class="ttc" id="agroup__ucm_html_gaac2bf25d233230d2d6a9e422795d716c"><div class="ttname"><a href="group__ucm.html#gaac2bf25d233230d2d6a9e422795d716c">snd_use_case_mgr_close</a></div><div class="ttdeci">int snd_use_case_mgr_close(snd_use_case_mgr_t *uc_mgr)</div><div class="ttdoc">Close use case manager.</div><div class="ttdef"><b>Definition:</b> main.c:1598</div></div>
<div class="ttc" id="agroup__ucm_html_gab0d67afb18ff0b1e155f5a762762aa6a"><div class="ttname"><a href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a">snd_use_case_parse_ctl_elem_id</a></div><div class="ttdeci">int snd_use_case_parse_ctl_elem_id(snd_ctl_elem_id_t *dst, const char *ucm_id, const char *value)</div><div class="ttdoc">Parse control element identifier.</div><div class="ttdef"><b>Definition:</b> main.c:2748</div></div>
<div class="ttc" id="agroup__ucm_html_gace35ebd33e632cba9441762f6633a20e"><div class="ttname"><a href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a></div><div class="ttdeci">struct snd_use_case_mgr snd_use_case_mgr_t</div><div class="ttdef"><b>Definition:</b> use-case.h:195</div></div>
<div class="ttc" id="agroup__ucm_html_gae9ff2a06c955d40ad0204f21f8352831"><div class="ttname"><a href="group__ucm.html#gae9ff2a06c955d40ad0204f21f8352831">snd_use_case_set</a></div><div class="ttdeci">int snd_use_case_set(snd_use_case_mgr_t *uc_mgr, const char *identifier, const char *value)</div><div class="ttdoc">Set new.</div><div class="ttdef"><b>Definition:</b> main.c:2691</div></div>
<div class="ttc" id="agroup__ucm_html_gaee0ad3020f0b3737f449f9f2a078e075"><div class="ttname"><a href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075">snd_use_case_parse_selem_id</a></div><div class="ttdeci">int snd_use_case_parse_selem_id(snd_mixer_selem_id_t *dst, const char *ucm_id, const char *value)</div><div class="ttdoc">Parse mixer element identifier.</div><div class="ttdef"><b>Definition:</b> main.c:2780</div></div>
<div class="ttc" id="agroup__ucm_html_gafedd1fc74ce9086033f6f668348321b4"><div class="ttname"><a href="group__ucm.html#gafedd1fc74ce9086033f6f668348321b4">snd_use_case_mgr_reload</a></div><div class="ttdeci">int snd_use_case_mgr_reload(snd_use_case_mgr_t *uc_mgr)</div><div class="ttdoc">Reload and re-parse use case configuration files for sound card.</div><div class="ttdef"><b>Definition:</b> main.c:1574</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>