| Current File : //proc/self/root/kunden/usr/share/doc/alsa-lib-devel/doxygen/html/group__ucm.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: Use Case Interface</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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Use Case Interface</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaedcdfd09f499b753d8652772ef1a248f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaedcdfd09f499b753d8652772ef1a248f">SND_USE_CASE_VERB_INACTIVE</a>   "Inactive"</td></tr>
<tr class="separator:gaedcdfd09f499b753d8652772ef1a248f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga71b24a1fcc4ce2cee555520ca546b348"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga71b24a1fcc4ce2cee555520ca546b348">SND_USE_CASE_VERB_HIFI</a>   "HiFi"</td></tr>
<tr class="separator:ga71b24a1fcc4ce2cee555520ca546b348"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a0739ade4ac574b31b4728c22280861"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga9a0739ade4ac574b31b4728c22280861">SND_USE_CASE_VERB_HIFI_LOW_POWER</a>   "HiFi Low Power"</td></tr>
<tr class="separator:ga9a0739ade4ac574b31b4728c22280861"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae496d33ac019caffae8dca584b04d09f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gae496d33ac019caffae8dca584b04d09f">SND_USE_CASE_VERB_VOICE</a>   "Voice"</td></tr>
<tr class="separator:gae496d33ac019caffae8dca584b04d09f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64b61825903d5ce88d3f4cfb12c7bd00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga64b61825903d5ce88d3f4cfb12c7bd00">SND_USE_CASE_VERB_VOICE_LOW_POWER</a>   "Voice Low Power"</td></tr>
<tr class="separator:ga64b61825903d5ce88d3f4cfb12c7bd00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaaa4aed51667887d194caae91362e8428"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaaa4aed51667887d194caae91362e8428">SND_USE_CASE_VERB_VOICECALL</a>   "Voice Call"</td></tr>
<tr class="separator:gaaa4aed51667887d194caae91362e8428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga938754af309628dfc8bafe28018b8aab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga938754af309628dfc8bafe28018b8aab">SND_USE_CASE_VERB_IP_VOICECALL</a>   "Voice Call IP"</td></tr>
<tr class="separator:ga938754af309628dfc8bafe28018b8aab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab08fad02c1e8641016be957fc5ce3705"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gab08fad02c1e8641016be957fc5ce3705">SND_USE_CASE_VERB_ANALOG_RADIO</a>   "FM Analog Radio"</td></tr>
<tr class="separator:gab08fad02c1e8641016be957fc5ce3705"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac1fc6fc3c4f08b4de9e622d05b591cb2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gac1fc6fc3c4f08b4de9e622d05b591cb2">SND_USE_CASE_VERB_DIGITAL_RADIO</a>   "FM Digital Radio"</td></tr>
<tr class="separator:gac1fc6fc3c4f08b4de9e622d05b591cb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa7abb8ce3d21b584c621869f7ebed3e6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaa7abb8ce3d21b584c621869f7ebed3e6">SND_USE_CASE_DEV_NONE</a>   "None"</td></tr>
<tr class="separator:gaa7abb8ce3d21b584c621869f7ebed3e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga515b2956d58485b27fb982965d067c55"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga515b2956d58485b27fb982965d067c55">SND_USE_CASE_DEV_SPEAKER</a>   "Speaker"</td></tr>
<tr class="separator:ga515b2956d58485b27fb982965d067c55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa5d03312d1990c0bd5c162f61fbfa4a0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaa5d03312d1990c0bd5c162f61fbfa4a0">SND_USE_CASE_DEV_LINE</a>   "Line"</td></tr>
<tr class="separator:gaa5d03312d1990c0bd5c162f61fbfa4a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec0f823989984e14fab7c8e2749d76ac"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaec0f823989984e14fab7c8e2749d76ac">SND_USE_CASE_DEV_MIC</a>   "Mic"</td></tr>
<tr class="separator:gaec0f823989984e14fab7c8e2749d76ac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf2c22989c5315abcee46713cde8693d2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaf2c22989c5315abcee46713cde8693d2">SND_USE_CASE_DEV_HEADPHONES</a>   "Headphones"</td></tr>
<tr class="separator:gaf2c22989c5315abcee46713cde8693d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga72c3300fac357a2e22b52afc13547ce0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga72c3300fac357a2e22b52afc13547ce0">SND_USE_CASE_DEV_HEADSET</a>   "Headset"</td></tr>
<tr class="separator:ga72c3300fac357a2e22b52afc13547ce0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga315d29bfbdf84cff8b7a593c34f6393b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga315d29bfbdf84cff8b7a593c34f6393b">SND_USE_CASE_DEV_HANDSET</a>   "Handset"</td></tr>
<tr class="separator:ga315d29bfbdf84cff8b7a593c34f6393b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4992d89d4ec8be51f19bec0a69ba1984"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga4992d89d4ec8be51f19bec0a69ba1984">SND_USE_CASE_DEV_BLUETOOTH</a>   "Bluetooth"</td></tr>
<tr class="separator:ga4992d89d4ec8be51f19bec0a69ba1984"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6ca86620d080360f6e2a240efb334dec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga6ca86620d080360f6e2a240efb334dec">SND_USE_CASE_DEV_EARPIECE</a>   "Earpiece"</td></tr>
<tr class="separator:ga6ca86620d080360f6e2a240efb334dec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f7f45feb440a49be3be9e52da98b242"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga7f7f45feb440a49be3be9e52da98b242">SND_USE_CASE_DEV_SPDIF</a>   "SPDIF"</td></tr>
<tr class="separator:ga7f7f45feb440a49be3be9e52da98b242"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab4e4a2b3d44883b1ffb5406529746faf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gab4e4a2b3d44883b1ffb5406529746faf">SND_USE_CASE_DEV_HDMI</a>   "HDMI"</td></tr>
<tr class="separator:gab4e4a2b3d44883b1ffb5406529746faf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae1b6c362013390117cf4d667bba88b3c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gae1b6c362013390117cf4d667bba88b3c">SND_USE_CASE_DEV_USB</a>   "USB"</td></tr>
<tr class="separator:gae1b6c362013390117cf4d667bba88b3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75be5633c387b6b4b9067013f76e9969"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga75be5633c387b6b4b9067013f76e9969">SND_USE_CASE_DEV_DIRECT</a>   "Direct"</td></tr>
<tr class="separator:ga75be5633c387b6b4b9067013f76e9969"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaec6b78d147824af1474fc914770a834c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaec6b78d147824af1474fc914770a834c">SND_USE_CASE_MOD_CAPTURE_VOICE</a>   "Capture Voice"</td></tr>
<tr class="separator:gaec6b78d147824af1474fc914770a834c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad685f6b4dcb9e37f0b5a1160425aec23"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gad685f6b4dcb9e37f0b5a1160425aec23">SND_USE_CASE_MOD_CAPTURE_MUSIC</a>   "Capture Music"</td></tr>
<tr class="separator:gad685f6b4dcb9e37f0b5a1160425aec23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadee4d4dce15624e282ab1960113caf8b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gadee4d4dce15624e282ab1960113caf8b">SND_USE_CASE_MOD_PLAY_MUSIC</a>   "Play Music"</td></tr>
<tr class="separator:gadee4d4dce15624e282ab1960113caf8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga61c217f060e616d61a294ac5d5d2fac0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga61c217f060e616d61a294ac5d5d2fac0">SND_USE_CASE_MOD_PLAY_VOICE</a>   "Play Voice"</td></tr>
<tr class="separator:ga61c217f060e616d61a294ac5d5d2fac0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaacc8e06e0c8fc0de5e26df6f20462484"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaacc8e06e0c8fc0de5e26df6f20462484">SND_USE_CASE_MOD_PLAY_TONE</a>   "Play Tone"</td></tr>
<tr class="separator:gaacc8e06e0c8fc0de5e26df6f20462484"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae2a230a913142c17f30d7dc2ae416866"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gae2a230a913142c17f30d7dc2ae416866">SND_USE_CASE_MOD_ECHO_REF</a>   "Echo Reference"</td></tr>
<tr class="separator:gae2a230a913142c17f30d7dc2ae416866"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga64dd2e9f8e4e800effc02d895e1bfdbb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga64dd2e9f8e4e800effc02d895e1bfdbb">SND_USE_CASE_TQ_MUSIC</a>   "Music"</td></tr>
<tr class="separator:ga64dd2e9f8e4e800effc02d895e1bfdbb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa822e565021887e26c0eaec2cee97bbd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaa822e565021887e26c0eaec2cee97bbd">SND_USE_CASE_TQ_VOICE</a>   "Voice"</td></tr>
<tr class="separator:gaa822e565021887e26c0eaec2cee97bbd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga022328b4bb0b0b14d358cb2155e5d184"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga022328b4bb0b0b14d358cb2155e5d184">SND_USE_CASE_TQ_TONES</a>   "Tones"</td></tr>
<tr class="separator:ga022328b4bb0b0b14d358cb2155e5d184"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gace35ebd33e632cba9441762f6633a20e"><td class="memItemLeft" align="right" valign="top">typedef struct snd_use_case_mgr </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a></td></tr>
<tr class="separator:gace35ebd33e632cba9441762f6633a20e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga530159363360c3cae3c9816c034fbcc5"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga530159363360c3cae3c9816c034fbcc5">snd_use_case_identifier</a> (const char *fmt,...)</td></tr>
<tr class="memdesc:ga530159363360c3cae3c9816c034fbcc5"><td class="mdescLeft"> </td><td class="mdescRight">Create an identifier. <a href="group__ucm.html#ga530159363360c3cae3c9816c034fbcc5">More...</a><br /></td></tr>
<tr class="separator:ga530159363360c3cae3c9816c034fbcc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga003553ee6fd13119fc9e08ffcdd959f9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga003553ee6fd13119fc9e08ffcdd959f9">snd_use_case_free_list</a> (const char *list[], int items)</td></tr>
<tr class="memdesc:ga003553ee6fd13119fc9e08ffcdd959f9"><td class="mdescLeft"> </td><td class="mdescRight">Free a string list. <a href="group__ucm.html#ga003553ee6fd13119fc9e08ffcdd959f9">More...</a><br /></td></tr>
<tr class="separator:ga003553ee6fd13119fc9e08ffcdd959f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa128bcb412f42247e561b81ec342c2e1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">snd_use_case_get_list</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr, const char *identifier, const char **list[])</td></tr>
<tr class="memdesc:gaa128bcb412f42247e561b81ec342c2e1"><td class="mdescLeft"> </td><td class="mdescRight">Obtain a list of entries. <a href="group__ucm.html#gaa128bcb412f42247e561b81ec342c2e1">More...</a><br /></td></tr>
<tr class="separator:gaa128bcb412f42247e561b81ec342c2e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9c13ae514eeebf918adcec0e4534aca5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga9c13ae514eeebf918adcec0e4534aca5">snd_use_case_get</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr, const char *identifier, const char **value)</td></tr>
<tr class="memdesc:ga9c13ae514eeebf918adcec0e4534aca5"><td class="mdescLeft"> </td><td class="mdescRight">Get current - string. <a href="group__ucm.html#ga9c13ae514eeebf918adcec0e4534aca5">More...</a><br /></td></tr>
<tr class="separator:ga9c13ae514eeebf918adcec0e4534aca5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66311429dfd62743089be3eb79f1d1f5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga66311429dfd62743089be3eb79f1d1f5">snd_use_case_geti</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr, const char *identifier, long *value)</td></tr>
<tr class="memdesc:ga66311429dfd62743089be3eb79f1d1f5"><td class="mdescLeft"> </td><td class="mdescRight">Get current - integer. <a href="group__ucm.html#ga66311429dfd62743089be3eb79f1d1f5">More...</a><br /></td></tr>
<tr class="separator:ga66311429dfd62743089be3eb79f1d1f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae9ff2a06c955d40ad0204f21f8352831"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gae9ff2a06c955d40ad0204f21f8352831">snd_use_case_set</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr, const char *identifier, const char *value)</td></tr>
<tr class="memdesc:gae9ff2a06c955d40ad0204f21f8352831"><td class="mdescLeft"> </td><td class="mdescRight">Set new. <a href="group__ucm.html#gae9ff2a06c955d40ad0204f21f8352831">More...</a><br /></td></tr>
<tr class="separator:gae9ff2a06c955d40ad0204f21f8352831"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga74f0ef0116590fe8eec1edeaf1d88847"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga74f0ef0116590fe8eec1edeaf1d88847">snd_use_case_mgr_open</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> **uc_mgr, const char *card_name)</td></tr>
<tr class="memdesc:ga74f0ef0116590fe8eec1edeaf1d88847"><td class="mdescLeft"> </td><td class="mdescRight">Open and initialise use case core for sound card. <a href="group__ucm.html#ga74f0ef0116590fe8eec1edeaf1d88847">More...</a><br /></td></tr>
<tr class="separator:ga74f0ef0116590fe8eec1edeaf1d88847"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafedd1fc74ce9086033f6f668348321b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gafedd1fc74ce9086033f6f668348321b4">snd_use_case_mgr_reload</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr)</td></tr>
<tr class="memdesc:gafedd1fc74ce9086033f6f668348321b4"><td class="mdescLeft"> </td><td class="mdescRight">Reload and re-parse use case configuration files for sound card. <a href="group__ucm.html#gafedd1fc74ce9086033f6f668348321b4">More...</a><br /></td></tr>
<tr class="separator:gafedd1fc74ce9086033f6f668348321b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac2bf25d233230d2d6a9e422795d716c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaac2bf25d233230d2d6a9e422795d716c">snd_use_case_mgr_close</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr)</td></tr>
<tr class="memdesc:gaac2bf25d233230d2d6a9e422795d716c"><td class="mdescLeft"> </td><td class="mdescRight">Close use case manager. <a href="group__ucm.html#gaac2bf25d233230d2d6a9e422795d716c">More...</a><br /></td></tr>
<tr class="separator:gaac2bf25d233230d2d6a9e422795d716c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1364dba503c216b2e46085a3f4abd20a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#ga1364dba503c216b2e46085a3f4abd20a">snd_use_case_mgr_reset</a> (<a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> *uc_mgr)</td></tr>
<tr class="memdesc:ga1364dba503c216b2e46085a3f4abd20a"><td class="mdescLeft"> </td><td class="mdescRight">Reset use case manager verb, device, modifier to deafult settings. <a href="group__ucm.html#ga1364dba503c216b2e46085a3f4abd20a">More...</a><br /></td></tr>
<tr class="separator:ga1364dba503c216b2e46085a3f4abd20a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0d67afb18ff0b1e155f5a762762aa6a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a">snd_use_case_parse_ctl_elem_id</a> (<a class="el" href="group___control.html#gad6c3746f1925bfec6a4fd0e913430e55">snd_ctl_elem_id_t</a> *dst, const char *ucm_id, const char *value)</td></tr>
<tr class="memdesc:gab0d67afb18ff0b1e155f5a762762aa6a"><td class="mdescLeft"> </td><td class="mdescRight">Parse control element identifier. <a href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a">More...</a><br /></td></tr>
<tr class="separator:gab0d67afb18ff0b1e155f5a762762aa6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee0ad3020f0b3737f449f9f2a078e075"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075">snd_use_case_parse_selem_id</a> (<a class="el" href="group___simple_mixer.html#gac0bfc2b9efcbc308df2daad92983e2ee">snd_mixer_selem_id_t</a> *dst, const char *ucm_id, const char *value)</td></tr>
<tr class="memdesc:gaee0ad3020f0b3737f449f9f2a078e075"><td class="mdescLeft"> </td><td class="mdescRight">Parse mixer element identifier. <a href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075">More...</a><br /></td></tr>
<tr class="separator:gaee0ad3020f0b3737f449f9f2a078e075"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The ALSA Use Case manager interface. See <a class="el" href="group__ucm.html">ALSA Use Case Interface</a> page for more details. </p>
<h3><a id="Usecase"></a>ALSA Use Case Interface</h3><div class="textblock">The use case manager works by configuring the sound card ALSA kcontrols to change the hardware digital and analog audio routing to match the requested device use case. The use case manager kcontrol configurations are stored in easy to modify text files.An audio use case can be defined by a verb and device parameter. The verb describes the use case action i.e. a phone call, listening to music, recording a conversation etc. The device describes the physical audio capture and playback hardware i.e. headphones, phone handset, bluetooth headset, etc.It's intended clients will mostly only need to set the use case verb and device for each system use case change (as the verb and device parameters cover most audio use cases).However there are times when a use case has to be modified at runtime. e.g.<ul>
<li>Incoming phone call when the device is playing music</li>
<li>Recording sections of a phone call</li>
<li>Playing tones during a call.</li>
</ul>
In order to allow asynchronous runtime use case adaptations, we have a third optional modifier parameter that can be used to further configure the use case during live audio runtime.This interface allows clients to :-<ul>
<li>Query the supported use case verbs, devices and modifiers for the machine.</li>
<li>Set and Get use case verbs, devices and modifiers for the machine.</li>
<li>Get the ALSA PCM playback and capture device PCMs for use case verb, use case device and modifier.</li>
<li>Get the TQ parameter for each use case verb, use case device and modifier.</li>
<li>Get the ALSA master playback and capture volume/switch kcontrols or mixer elements for each use case. </li>
</ul>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga4992d89d4ec8be51f19bec0a69ba1984"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4992d89d4ec8be51f19bec0a69ba1984">◆ </a></span>SND_USE_CASE_DEV_BLUETOOTH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_BLUETOOTH   "Bluetooth"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bluetooth Device </p>
</div>
</div>
<a id="ga75be5633c387b6b4b9067013f76e9969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga75be5633c387b6b4b9067013f76e9969">◆ </a></span>SND_USE_CASE_DEV_DIRECT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_DIRECT   "Direct"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Direct Device (no channel remapping), (e.g. ProAudio usage) </p>
</div>
</div>
<a id="ga6ca86620d080360f6e2a240efb334dec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6ca86620d080360f6e2a240efb334dec">◆ </a></span>SND_USE_CASE_DEV_EARPIECE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_EARPIECE   "Earpiece"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Earpiece Device </p>
</div>
</div>
<a id="ga315d29bfbdf84cff8b7a593c34f6393b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga315d29bfbdf84cff8b7a593c34f6393b">◆ </a></span>SND_USE_CASE_DEV_HANDSET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_HANDSET   "Handset"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Handset Device </p>
</div>
</div>
<a id="gab4e4a2b3d44883b1ffb5406529746faf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4e4a2b3d44883b1ffb5406529746faf">◆ </a></span>SND_USE_CASE_DEV_HDMI</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_HDMI   "HDMI"</td>
</tr>
</table>
</div><div class="memdoc">
<p>HDMI / DisplayPort Device </p>
</div>
</div>
<a id="gaf2c22989c5315abcee46713cde8693d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf2c22989c5315abcee46713cde8693d2">◆ </a></span>SND_USE_CASE_DEV_HEADPHONES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_HEADPHONES   "Headphones"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Headphones Device </p>
</div>
</div>
<a id="ga72c3300fac357a2e22b52afc13547ce0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga72c3300fac357a2e22b52afc13547ce0">◆ </a></span>SND_USE_CASE_DEV_HEADSET</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_HEADSET   "Headset"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Headset Device </p>
</div>
</div>
<a id="gaa5d03312d1990c0bd5c162f61fbfa4a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5d03312d1990c0bd5c162f61fbfa4a0">◆ </a></span>SND_USE_CASE_DEV_LINE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_LINE   "Line"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Line Device </p>
</div>
</div>
<a id="gaec0f823989984e14fab7c8e2749d76ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec0f823989984e14fab7c8e2749d76ac">◆ </a></span>SND_USE_CASE_DEV_MIC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_MIC   "Mic"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Microphone Device </p>
</div>
</div>
<a id="gaa7abb8ce3d21b584c621869f7ebed3e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7abb8ce3d21b584c621869f7ebed3e6">◆ </a></span>SND_USE_CASE_DEV_NONE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_NONE   "None"</td>
</tr>
</table>
</div><div class="memdoc">
<p>None Device </p>
</div>
</div>
<a id="ga7f7f45feb440a49be3be9e52da98b242"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f7f45feb440a49be3be9e52da98b242">◆ </a></span>SND_USE_CASE_DEV_SPDIF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_SPDIF   "SPDIF"</td>
</tr>
</table>
</div><div class="memdoc">
<p>SPDIF Device </p>
</div>
</div>
<a id="ga515b2956d58485b27fb982965d067c55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga515b2956d58485b27fb982965d067c55">◆ </a></span>SND_USE_CASE_DEV_SPEAKER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_SPEAKER   "Speaker"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Speaker Device </p>
</div>
</div>
<a id="gae1b6c362013390117cf4d667bba88b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae1b6c362013390117cf4d667bba88b3c">◆ </a></span>SND_USE_CASE_DEV_USB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_DEV_USB   "USB"</td>
</tr>
</table>
</div><div class="memdoc">
<p>USB Device (multifunctional) </p>
</div>
</div>
<a id="gad685f6b4dcb9e37f0b5a1160425aec23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad685f6b4dcb9e37f0b5a1160425aec23">◆ </a></span>SND_USE_CASE_MOD_CAPTURE_MUSIC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_CAPTURE_MUSIC   "Capture Music"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Capture Music Modifier </p>
</div>
</div>
<a id="gaec6b78d147824af1474fc914770a834c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaec6b78d147824af1474fc914770a834c">◆ </a></span>SND_USE_CASE_MOD_CAPTURE_VOICE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_CAPTURE_VOICE   "Capture Voice"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Capture Voice Modifier </p>
</div>
</div>
<a id="gae2a230a913142c17f30d7dc2ae416866"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae2a230a913142c17f30d7dc2ae416866">◆ </a></span>SND_USE_CASE_MOD_ECHO_REF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_ECHO_REF   "Echo Reference"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Echo Reference Modifier </p>
</div>
</div>
<a id="gadee4d4dce15624e282ab1960113caf8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadee4d4dce15624e282ab1960113caf8b">◆ </a></span>SND_USE_CASE_MOD_PLAY_MUSIC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_PLAY_MUSIC   "Play Music"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Play Music Modifier </p>
</div>
</div>
<a id="gaacc8e06e0c8fc0de5e26df6f20462484"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaacc8e06e0c8fc0de5e26df6f20462484">◆ </a></span>SND_USE_CASE_MOD_PLAY_TONE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_PLAY_TONE   "Play Tone"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Play Tone Modifier </p>
</div>
</div>
<a id="ga61c217f060e616d61a294ac5d5d2fac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga61c217f060e616d61a294ac5d5d2fac0">◆ </a></span>SND_USE_CASE_MOD_PLAY_VOICE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_MOD_PLAY_VOICE   "Play Voice"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Play Voice Modifier </p>
</div>
</div>
<a id="ga64dd2e9f8e4e800effc02d895e1bfdbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64dd2e9f8e4e800effc02d895e1bfdbb">◆ </a></span>SND_USE_CASE_TQ_MUSIC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_TQ_MUSIC   "Music"</td>
</tr>
</table>
</div><div class="memdoc">
<p>TQ - Tone Quality</p>
<p>The interface allows clients to determine the audio TQ required for each use case verb and modifier. It's intended as an optional hint to the audio driver in order to lower power consumption. Music Tone Quality </p>
</div>
</div>
<a id="ga022328b4bb0b0b14d358cb2155e5d184"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga022328b4bb0b0b14d358cb2155e5d184">◆ </a></span>SND_USE_CASE_TQ_TONES</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_TQ_TONES   "Tones"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tones Tone Quality </p>
</div>
</div>
<a id="gaa822e565021887e26c0eaec2cee97bbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa822e565021887e26c0eaec2cee97bbd">◆ </a></span>SND_USE_CASE_TQ_VOICE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_TQ_VOICE   "Voice"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Voice Tone Quality </p>
</div>
</div>
<a id="gab08fad02c1e8641016be957fc5ce3705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab08fad02c1e8641016be957fc5ce3705">◆ </a></span>SND_USE_CASE_VERB_ANALOG_RADIO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_ANALOG_RADIO   "FM Analog Radio"</td>
</tr>
</table>
</div><div class="memdoc">
<p>FM Analog Radio Verb </p>
</div>
</div>
<a id="gac1fc6fc3c4f08b4de9e622d05b591cb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1fc6fc3c4f08b4de9e622d05b591cb2">◆ </a></span>SND_USE_CASE_VERB_DIGITAL_RADIO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_DIGITAL_RADIO   "FM Digital Radio"</td>
</tr>
</table>
</div><div class="memdoc">
<p>FM Digital Radio Verb </p>
</div>
</div>
<a id="ga71b24a1fcc4ce2cee555520ca546b348"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga71b24a1fcc4ce2cee555520ca546b348">◆ </a></span>SND_USE_CASE_VERB_HIFI</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_HIFI   "HiFi"</td>
</tr>
</table>
</div><div class="memdoc">
<p>HiFi Verb </p>
</div>
</div>
<a id="ga9a0739ade4ac574b31b4728c22280861"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a0739ade4ac574b31b4728c22280861">◆ </a></span>SND_USE_CASE_VERB_HIFI_LOW_POWER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_HIFI_LOW_POWER   "HiFi Low Power"</td>
</tr>
</table>
</div><div class="memdoc">
<p>HiFi Low Power Verb </p>
</div>
</div>
<a id="gaedcdfd09f499b753d8652772ef1a248f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaedcdfd09f499b753d8652772ef1a248f">◆ </a></span>SND_USE_CASE_VERB_INACTIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_INACTIVE   "Inactive"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Inactive Verb </p>
</div>
</div>
<a id="ga938754af309628dfc8bafe28018b8aab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga938754af309628dfc8bafe28018b8aab">◆ </a></span>SND_USE_CASE_VERB_IP_VOICECALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_IP_VOICECALL   "Voice Call IP"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Voice Call IP Verb </p>
</div>
</div>
<a id="gae496d33ac019caffae8dca584b04d09f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae496d33ac019caffae8dca584b04d09f">◆ </a></span>SND_USE_CASE_VERB_VOICE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_VOICE   "Voice"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Voice Verb </p>
</div>
</div>
<a id="ga64b61825903d5ce88d3f4cfb12c7bd00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64b61825903d5ce88d3f4cfb12c7bd00">◆ </a></span>SND_USE_CASE_VERB_VOICE_LOW_POWER</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_VOICE_LOW_POWER   "Voice Low Power"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Voice Low Power Verb </p>
</div>
</div>
<a id="gaaa4aed51667887d194caae91362e8428"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa4aed51667887d194caae91362e8428">◆ </a></span>SND_USE_CASE_VERB_VOICECALL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SND_USE_CASE_VERB_VOICECALL   "Voice Call"</td>
</tr>
</table>
</div><div class="memdoc">
<p>Voice Call Verb </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gace35ebd33e632cba9441762f6633a20e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gace35ebd33e632cba9441762f6633a20e">◆ </a></span>snd_use_case_mgr_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct snd_use_case_mgr <a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>use case container </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga003553ee6fd13119fc9e08ffcdd959f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga003553ee6fd13119fc9e08ffcdd959f9">◆ </a></span>snd_use_case_free_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_free_list </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>list</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>items</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a string list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">list</td><td>The string list to free </td></tr>
<tr><td class="paramname">items</td><td>Count of strings </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="ga9c13ae514eeebf918adcec0e4534aca5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9c13ae514eeebf918adcec0e4534aca5">◆ </a></span>snd_use_case_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>identifier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current - string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
<tr><td class="paramname">identifier</td><td></td></tr>
<tr><td class="paramname">value</td><td>Value pointer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code</dd></dl>
<p>Note: The returned string is dynamically allocated, use free() to deallocate this string. (Yes, the value parameter shouldn't be marked as "const", but it's too late to fix it, sorry about that.)</p>
<p>Known identifiers:</p><ul>
<li>NULL - return current card</li>
<li>_verb - return current verb</li>
<li>_file - return configuration file loaded for current card</li>
<li>_alibcfg - return private alsa-lib's configuration for current card</li>
<li>_alibpref - return private alsa-lib's configuration device prefix for current card</li>
<li>[=]{NAME}[/[{modifier}|{/device}][/{verb}]]<ul>
<li>value identifier {NAME}</li>
<li>Search starts at given modifier or device if any, else at a verb</li>
<li>Search starts at given verb if any, else current verb</li>
<li>Searches modifier/device, then verb, then defaults</li>
<li>Specify a leading "=" to search only the exact device/modifier/verb specified, and not search through each object in turn.</li>
<li>Examples:<ul>
<li>"PlaybackPCM/Play Music"</li>
<li>"CapturePCM/SPDIF"</li>
<li>From ValueDefaults only: "=Variable"</li>
<li>From current active verb: "=Variable//"</li>
<li>From verb "Verb": "=Variable//Verb"</li>
<li>From "Modifier" in current active verb: "=Variable/Modifier/"</li>
<li>From "Modifier" in "Verb": "=Variable/Modifier/Verb"</li>
</ul>
</li>
</ul>
</li>
</ul>
<p>Recommended names for values:</p><ul>
<li>Linked<ul>
<li>value "True" or "1" (case insensitive)</li>
<li>this is a linked UCM card</li>
<li>don't use this UCM card, because the other UCM card refers devices</li>
<li>valid only in the ValueDefaults section (query '=Linked')</li>
</ul>
</li>
<li>TQ<ul>
<li>Tone Quality</li>
</ul>
</li>
<li>Priority<ul>
<li>priority value (1-10000), higher value means higher priority</li>
<li>valid only for verbs</li>
<li>for devices - PlaybackPriority and CapturePriority</li>
</ul>
</li>
<li>PlaybackPCM<ul>
<li>full PCM playback device name</li>
</ul>
</li>
<li>PlaybackPCMIsDummy<ul>
<li>Valid values: "yes" and "no". If set to "yes", the PCM named by the PlaybackPCM value is a dummy device, meaning that opening it enables an audio path in the hardware, but writing to the PCM device has no effect.</li>
</ul>
</li>
<li>CapturePCM<ul>
<li>full PCM capture device name</li>
</ul>
</li>
<li>CapturePCMIsDummy<ul>
<li>Valid values: "yes" and "no". If set to "yes", the PCM named by the CapturePCM value is a dummy device, meaning that opening it enables an audio path in the hardware, but reading from the PCM device has no effect.</li>
</ul>
</li>
<li>PlaybackRate<ul>
<li>playback device sample rate</li>
</ul>
</li>
<li>PlaybackChannels<ul>
<li>playback device channel count</li>
</ul>
</li>
<li>PlaybackChannel#<ul>
<li>describe index of the logical channel in the PCM stream</li>
<li>e.g. "PlaybackChannel0 2" - logical channel 0 is third channel in the PCM stream</li>
</ul>
</li>
<li>PlaybackChannelPos#<ul>
<li>describe sound position of the logical channel (ALSA chmap names)</li>
<li>e.g. "PlaybackChannel0 FR" - logical channel 0 is at front left</li>
</ul>
</li>
<li>PlaybackCTL<ul>
<li>playback control device name</li>
</ul>
</li>
<li>PlaybackVolume<ul>
<li>playback control volume identifier string</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a" title="Parse control element identifier.">snd_use_case_parse_ctl_elem_id()</a></li>
</ul>
</li>
<li>PlaybackSwitch<ul>
<li>playback control switch identifier string</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a" title="Parse control element identifier.">snd_use_case_parse_ctl_elem_id()</a></li>
</ul>
</li>
<li>PlaybackPriority<ul>
<li>priority value (1-10000), higher value means higher priority</li>
</ul>
</li>
<li>CaptureRate<ul>
<li>capture device sample rate</li>
</ul>
</li>
<li>CaptureChannels<ul>
<li>capture device channel count</li>
</ul>
</li>
<li>CaptureChannel#<ul>
<li>describe index of the logical channel in the PCM stream</li>
<li>e.g. "CaptureChannel0 2" - logical channel 0 is third channel in the PCM stream</li>
</ul>
</li>
<li>CaptureChannelPos#<ul>
<li>describe sound position of the logical channel (ALSA chmap names)</li>
<li>e.g. "CaptureChannel0 FR" - logical channel 0 is at front left</li>
</ul>
</li>
<li>CaptureCTL<ul>
<li>capture control device name</li>
</ul>
</li>
<li>CaptureVolume<ul>
<li>capture control volume identifier string</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a" title="Parse control element identifier.">snd_use_case_parse_ctl_elem_id()</a></li>
</ul>
</li>
<li>CaptureSwitch<ul>
<li>capture control switch identifier string</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a" title="Parse control element identifier.">snd_use_case_parse_ctl_elem_id()</a></li>
</ul>
</li>
<li>CapturePriority<ul>
<li>priority value (1-10000), higher value means higher priority</li>
</ul>
</li>
<li>PlaybackMixer<ul>
<li>name of playback mixer</li>
</ul>
</li>
<li>PlaybackMixerElem<ul>
<li>mixer element playback identifier</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075" title="Parse mixer element identifier.">snd_use_case_parse_selem_id()</a></li>
</ul>
</li>
<li>PlaybackMasterElem<ul>
<li>mixer element playback identifier for the master control</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075" title="Parse mixer element identifier.">snd_use_case_parse_selem_id()</a></li>
</ul>
</li>
<li>PlaybackMasterType<ul>
<li>type of the master volume control</li>
<li>Valid values: "soft" (software attenuation)</li>
</ul>
</li>
<li>CaptureMixer<ul>
<li>name of capture mixer</li>
</ul>
</li>
<li>CaptureMixerElem<ul>
<li>mixer element capture identifier</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075" title="Parse mixer element identifier.">snd_use_case_parse_selem_id()</a></li>
</ul>
</li>
<li>CaptureMasterElem<ul>
<li>mixer element playback identifier for the master control</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gaee0ad3020f0b3737f449f9f2a078e075" title="Parse mixer element identifier.">snd_use_case_parse_selem_id()</a></li>
</ul>
</li>
<li>CaptureMasterType<ul>
<li>type of the master volume control</li>
<li>Valid values: "soft" (software attenuation)</li>
</ul>
</li>
<li>CaptureMicInfoFile<ul>
<li>json file with the microphone array placement and type description (e.g. output from nhlt-dmic-info)</li>
</ul>
</li>
<li>EDIDFile<ul>
<li>Path to EDID file for HDMI devices</li>
</ul>
</li>
<li>JackCTL<ul>
<li>jack control device name</li>
</ul>
</li>
<li>JackControl<ul>
<li>jack control identificator</li>
<li>can be parsed using <a class="el" href="group__ucm.html#gab0d67afb18ff0b1e155f5a762762aa6a" title="Parse control element identifier.">snd_use_case_parse_ctl_elem_id()</a></li>
<li>UCM configuration files should contain both JackControl and JackDev when possible, because applications are likely to support only one or the other</li>
</ul>
</li>
<li>JackDev<ul>
<li>the input device id of the jack (if the full input device path is /dev/input/by-id/foo, the JackDev value should be "foo")</li>
<li>UCM configuration files should contain both JackControl and JackDev when possible, because applications are likely to support only one or the other</li>
</ul>
</li>
<li>JackHWMute If this value is set, it indicates that when the jack is plugged in, the hardware automatically mutes some other device(s). The value is a space-separated list of device names. If the device name contains space, it must be enclosed to ' or ", e.g.:
JackHWMute "'Dock Headphone' Headphone" Note that JackHWMute should be used only when the hardware enforces the automatic muting. If the hardware doesn't enforce any muting, it may still be tempting to set JackHWMute to trick upper software layers to e.g. automatically mute speakers when headphones are plugged in, but that's application policy configuration that doesn't belong to UCM configuration files.</li>
<li>MinBufferLevel</li>
<li>This is used on platform where reported buffer level is not accurate. E.g. "512", which holds 512 samples in device buffer. Note: this will increase latency. </li>
</ul>
</div>
</div>
<a id="gaa128bcb412f42247e561b81ec342c2e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa128bcb412f42247e561b81ec342c2e1">◆ </a></span>snd_use_case_get_list()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_get_list </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>identifier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>list</em>[] </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Obtain a list of entries. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager (may be NULL - card list) </td></tr>
<tr><td class="paramname">identifier</td><td>(may be NULL - card list) </td></tr>
<tr><td class="paramname">list</td><td>Returned allocated list </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of list entries if success, otherwise a negative error code</dd></dl>
<p>Defined identifiers:</p><ul>
<li>NULL - get card list (in pair cardname+comment)</li>
<li>_verbs - get verb list (in pair verb+comment)</li>
<li>_devices[/{verb}] - get list of supported devices (in pair device+comment)</li>
<li>_modifiers[/{verb}] - get list of supported modifiers (in pair modifier+comment)</li>
<li>TQ[/{verb}] - get list of TQ identifiers</li>
<li>_enadevs - get list of enabled devices</li>
<li>_enamods - get list of enabled modifiers</li>
<li>_identifiers/{modifier}|{device}[/{verb}] - list of value identifiers</li>
<li>_supporteddevs/{modifier}|{device}[/{verb}] - list of supported devices</li>
<li>_conflictingdevs/{modifier}|{device}[/{verb}] - list of conflicting devices</li>
</ul>
<p>Note that at most one of the supported/conflicting devs lists has any entries, and when neither is present, all devices are supported. </p>
</div>
</div>
<a id="ga66311429dfd62743089be3eb79f1d1f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66311429dfd62743089be3eb79f1d1f5">◆ </a></span>snd_use_case_geti()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_geti </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>identifier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current - integer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
<tr><td class="paramname">identifier</td><td></td></tr>
<tr><td class="paramname">value</td><td>result </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code</dd></dl>
<p>Known identifiers:</p><ul>
<li>_devstatus/{device} - return status for given device</li>
<li>_modstatus/{modifier} - return status for given modifier </li>
</ul>
</div>
</div>
<a id="ga530159363360c3cae3c9816c034fbcc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga530159363360c3cae3c9816c034fbcc5">◆ </a></span>snd_use_case_identifier()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* snd_use_case_identifier </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an identifier. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fmt</td><td>Format (sprintf like) </td></tr>
<tr><td class="paramname">...</td><td>Optional arguments for sprintf like format </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Allocated string identifier or NULL on error </dd></dl>
</div>
</div>
<a id="gaac2bf25d233230d2d6a9e422795d716c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac2bf25d233230d2d6a9e422795d716c">◆ </a></span>snd_use_case_mgr_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_mgr_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close use case manager. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="ga74f0ef0116590fe8eec1edeaf1d88847"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga74f0ef0116590fe8eec1edeaf1d88847">◆ </a></span>snd_use_case_mgr_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_mgr_open </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> ** </td>
<td class="paramname"><em>uc_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>card_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Open and initialise use case core for sound card. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Returned use case manager pointer </td></tr>
<tr><td class="paramname">card_name</td><td>Sound card name. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code</dd></dl>
<p>By default only first card is used when the driver card name or long name is passed in the card_name argument.</p>
<p>The "strict:" prefix in the card_name defines that there is no driver name / long name matching. The straight configuration is used.</p>
<p>The "hw:" prefix in the card_name will load the configuration for the ALSA card specified by the card index (value) or the card string identificator.</p>
<p>The sound card might be also composed from several physical sound cards (for the default and strict card_name). The application cannot expect that the device names will refer only one ALSA sound card in this case. </p>
</div>
</div>
<a id="gafedd1fc74ce9086033f6f668348321b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafedd1fc74ce9086033f6f668348321b4">◆ </a></span>snd_use_case_mgr_reload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_mgr_reload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reload and re-parse use case configuration files for sound card. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="ga1364dba503c216b2e46085a3f4abd20a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1364dba503c216b2e46085a3f4abd20a">◆ </a></span>snd_use_case_mgr_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_mgr_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset use case manager verb, device, modifier to deafult settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="gab0d67afb18ff0b1e155f5a762762aa6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0d67afb18ff0b1e155f5a762762aa6a">◆ </a></span>snd_use_case_parse_ctl_elem_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_parse_ctl_elem_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___control.html#gad6c3746f1925bfec6a4fd0e913430e55">snd_ctl_elem_id_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ucm_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse control element identifier. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Element identifier </td></tr>
<tr><td class="paramname">ucm_id</td><td>Use case identifier </td></tr>
<tr><td class="paramname">value</td><td>String value to be parsed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="gaee0ad3020f0b3737f449f9f2a078e075"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee0ad3020f0b3737f449f9f2a078e075">◆ </a></span>snd_use_case_parse_selem_id()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_parse_selem_id </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___simple_mixer.html#gac0bfc2b9efcbc308df2daad92983e2ee">snd_mixer_selem_id_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ucm_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse mixer element identifier. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Simple mixer element identifier </td></tr>
<tr><td class="paramname">ucm_id</td><td>Use case identifier </td></tr>
<tr><td class="paramname">value</td><td>String value to be parsed </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code </dd></dl>
</div>
</div>
<a id="gae9ff2a06c955d40ad0204f21f8352831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae9ff2a06c955d40ad0204f21f8352831">◆ </a></span>snd_use_case_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int snd_use_case_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__ucm.html#gace35ebd33e632cba9441762f6633a20e">snd_use_case_mgr_t</a> * </td>
<td class="paramname"><em>uc_mgr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>identifier</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set new. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uc_mgr</td><td>Use case manager </td></tr>
<tr><td class="paramname">identifier</td><td></td></tr>
<tr><td class="paramname">value</td><td>Value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Zero if success, otherwise a negative error code</dd></dl>
<p>Known identifiers:</p><ul>
<li>_fboot - execute the fixed boot sequence (value = NULL)</li>
<li>_boot - execute the boot sequence (value = NULL)<ul>
<li>only when driver controls identifiers are changed (otherwise the old control values are restored)</li>
</ul>
</li>
<li>_defaults - execute the 'defaults' sequence (value = NULL)</li>
<li>_verb - set current verb = value</li>
<li>_enadev - enable given device = value</li>
<li>_disdev - disable given device = value</li>
<li>_swdev/{old_device} - new_device = value<ul>
<li>disable old_device and then enable new_device</li>
<li>if old_device is not enabled just return</li>
<li>check transmit sequence firstly</li>
</ul>
</li>
<li>_enamod - enable given modifier = value</li>
<li>_dismod - disable given modifier = value</li>
<li>_swmod/{old_modifier} - new_modifier = value<ul>
<li>disable old_modifier and then enable new_modifier</li>
<li>if old_modifier is not enabled just return</li>
<li>check transmit sequence firstly </li>
</ul>
</li>
</ul>
</div>
</div>
</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>