DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
libctru/mic_8h.html
WinterMute e52f3175e1 Deploying to gh-pages from @ 8cbcce773b 🚀
2024-11-03 20:36:34 +00:00

674 lines
38 KiB
HTML
Raw Permalink Blame History

<!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>libctru: include/3ds/services/mic.h File Reference</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">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</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&amp;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&amp;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><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">mic.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>MIC (Microphone) service.
<a href="#details">More...</a></p>
<p><a href="mic_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a3ead458d1aabf74550446b463b4fb54f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a> { <br />
&#160;&#160;<a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac">MICU_ENCODING_PCM8</a> = 0
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2">MICU_ENCODING_PCM16</a> = 1
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc">MICU_ENCODING_PCM8_SIGNED</a> = 2
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92">MICU_ENCODING_PCM16_SIGNED</a> = 3
<br />
}</td></tr>
<tr class="memdesc:a3ead458d1aabf74550446b463b4fb54f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Microphone audio encodings. <a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">More...</a><br /></td></tr>
<tr class="separator:a3ead458d1aabf74550446b463b4fb54f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae126d52922918356ed810bcc398ad62b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a> { <br />
&#160;&#160;<a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8">MICU_SAMPLE_RATE_32730</a> = 0
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf">MICU_SAMPLE_RATE_16360</a> = 1
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130">MICU_SAMPLE_RATE_10910</a> = 2
, <br />
&#160;&#160;<a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0">MICU_SAMPLE_RATE_8180</a> = 3
<br />
}</td></tr>
<tr class="memdesc:ae126d52922918356ed810bcc398ad62b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Microphone audio sampling rates. <a href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">More...</a><br /></td></tr>
<tr class="separator:ae126d52922918356ed810bcc398ad62b"><td class="memSeparator" colspan="2">&#160;</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:a01ab8a1440cd4d38855336e47e5ae380"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a01ab8a1440cd4d38855336e47e5ae380">micInit</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *buffer, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> bufferSize)</td></tr>
<tr class="memdesc:a01ab8a1440cd4d38855336e47e5ae380"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes MIC. <a href="mic_8h.html#a01ab8a1440cd4d38855336e47e5ae380">More...</a><br /></td></tr>
<tr class="separator:a01ab8a1440cd4d38855336e47e5ae380"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5de3831a1aa13b444a812ebfef218361"><td class="memItemLeft" align="right" valign="top"><a id="a5de3831a1aa13b444a812ebfef218361"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a5de3831a1aa13b444a812ebfef218361">micExit</a> (void)</td></tr>
<tr class="memdesc:a5de3831a1aa13b444a812ebfef218361"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits MIC. <br /></td></tr>
<tr class="separator:a5de3831a1aa13b444a812ebfef218361"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09361b33179e9ca5fd099161cf25d70a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a09361b33179e9ca5fd099161cf25d70a">micGetSampleDataSize</a> (void)</td></tr>
<tr class="memdesc:a09361b33179e9ca5fd099161cf25d70a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the sample data area within the shared memory buffer. <a href="mic_8h.html#a09361b33179e9ca5fd099161cf25d70a">More...</a><br /></td></tr>
<tr class="separator:a09361b33179e9ca5fd099161cf25d70a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2590afec7ac205e877ab94c9203a4c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#aa2590afec7ac205e877ab94c9203a4c9">micGetLastSampleOffset</a> (void)</td></tr>
<tr class="memdesc:aa2590afec7ac205e877ab94c9203a4c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the offset within the shared memory buffer of the last sample written. <a href="mic_8h.html#aa2590afec7ac205e877ab94c9203a4c9">More...</a><br /></td></tr>
<tr class="separator:aa2590afec7ac205e877ab94c9203a4c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3dd3e9152bbddcafe2babc371c210222"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a3dd3e9152bbddcafe2babc371c210222">MICU_MapSharedMem</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle)</td></tr>
<tr class="memdesc:a3dd3e9152bbddcafe2babc371c210222"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps MIC shared memory. <a href="mic_8h.html#a3dd3e9152bbddcafe2babc371c210222">More...</a><br /></td></tr>
<tr class="separator:a3dd3e9152bbddcafe2babc371c210222"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab728c230d454422b4fdc119eec7f0510"><td class="memItemLeft" align="right" valign="top"><a id="ab728c230d454422b4fdc119eec7f0510"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#ab728c230d454422b4fdc119eec7f0510">MICU_UnmapSharedMem</a> (void)</td></tr>
<tr class="memdesc:ab728c230d454422b4fdc119eec7f0510"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unmaps MIC shared memory. <br /></td></tr>
<tr class="separator:ab728c230d454422b4fdc119eec7f0510"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79266af4aa50d790fba3680d423f6ff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a79266af4aa50d790fba3680d423f6ff0">MICU_StartSampling</a> (<a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a> encoding, <a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a> sampleRate, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, bool loop)</td></tr>
<tr class="memdesc:a79266af4aa50d790fba3680d423f6ff0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begins sampling microphone input. <a href="mic_8h.html#a79266af4aa50d790fba3680d423f6ff0">More...</a><br /></td></tr>
<tr class="separator:a79266af4aa50d790fba3680d423f6ff0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afdc168c4f160192b7b3b04e49d15ec86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#afdc168c4f160192b7b3b04e49d15ec86">MICU_AdjustSampling</a> (<a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a> sampleRate)</td></tr>
<tr class="memdesc:afdc168c4f160192b7b3b04e49d15ec86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts the configuration of the current sampling session. <a href="mic_8h.html#afdc168c4f160192b7b3b04e49d15ec86">More...</a><br /></td></tr>
<tr class="separator:afdc168c4f160192b7b3b04e49d15ec86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ea7f514ee9e50db3bc49bd3106fa967"><td class="memItemLeft" align="right" valign="top"><a id="a7ea7f514ee9e50db3bc49bd3106fa967"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a7ea7f514ee9e50db3bc49bd3106fa967">MICU_StopSampling</a> (void)</td></tr>
<tr class="memdesc:a7ea7f514ee9e50db3bc49bd3106fa967"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops sampling microphone input. <br /></td></tr>
<tr class="separator:a7ea7f514ee9e50db3bc49bd3106fa967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42078893931d09a8b27f3306c7f13a29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a42078893931d09a8b27f3306c7f13a29">MICU_IsSampling</a> (bool *sampling)</td></tr>
<tr class="memdesc:a42078893931d09a8b27f3306c7f13a29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether microphone input is currently being sampled. <a href="mic_8h.html#a42078893931d09a8b27f3306c7f13a29">More...</a><br /></td></tr>
<tr class="separator:a42078893931d09a8b27f3306c7f13a29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f17c21f1420682eb699cf39adf537b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a8f17c21f1420682eb699cf39adf537b2">MICU_GetEventHandle</a> (<a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *handle)</td></tr>
<tr class="memdesc:a8f17c21f1420682eb699cf39adf537b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets an event handle triggered when the shared memory buffer is full. <a href="mic_8h.html#a8f17c21f1420682eb699cf39adf537b2">More...</a><br /></td></tr>
<tr class="separator:a8f17c21f1420682eb699cf39adf537b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c29ffb2d0addbaca328d8aad082e3bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a0c29ffb2d0addbaca328d8aad082e3bf">MICU_SetGain</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> gain)</td></tr>
<tr class="memdesc:a0c29ffb2d0addbaca328d8aad082e3bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the microphone's gain. <a href="mic_8h.html#a0c29ffb2d0addbaca328d8aad082e3bf">More...</a><br /></td></tr>
<tr class="separator:a0c29ffb2d0addbaca328d8aad082e3bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add912c11a5b5ff8dabe224e2f380be9b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#add912c11a5b5ff8dabe224e2f380be9b">MICU_GetGain</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *gain)</td></tr>
<tr class="memdesc:add912c11a5b5ff8dabe224e2f380be9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the microphone's gain. <a href="mic_8h.html#add912c11a5b5ff8dabe224e2f380be9b">More...</a><br /></td></tr>
<tr class="separator:add912c11a5b5ff8dabe224e2f380be9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a26bd2ff5eeaaf538df29230b3fda61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a3a26bd2ff5eeaaf538df29230b3fda61">MICU_SetPower</a> (bool power)</td></tr>
<tr class="memdesc:a3a26bd2ff5eeaaf538df29230b3fda61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether the microphone is powered on. <a href="mic_8h.html#a3a26bd2ff5eeaaf538df29230b3fda61">More...</a><br /></td></tr>
<tr class="separator:a3a26bd2ff5eeaaf538df29230b3fda61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a38f4599e0d974a89a4448b3a53360cc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a38f4599e0d974a89a4448b3a53360cc6">MICU_GetPower</a> (bool *power)</td></tr>
<tr class="memdesc:a38f4599e0d974a89a4448b3a53360cc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the microphone is powered on. <a href="mic_8h.html#a38f4599e0d974a89a4448b3a53360cc6">More...</a><br /></td></tr>
<tr class="separator:a38f4599e0d974a89a4448b3a53360cc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a156a0b69714f334c004c7137a7592c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a0a156a0b69714f334c004c7137a7592c">MICU_SetClamp</a> (bool clamp)</td></tr>
<tr class="memdesc:a0a156a0b69714f334c004c7137a7592c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether to clamp microphone input. <a href="mic_8h.html#a0a156a0b69714f334c004c7137a7592c">More...</a><br /></td></tr>
<tr class="separator:a0a156a0b69714f334c004c7137a7592c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed8b72fbff68362b9c6a047a0b0c7307"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#aed8b72fbff68362b9c6a047a0b0c7307">MICU_GetClamp</a> (bool *clamp)</td></tr>
<tr class="memdesc:aed8b72fbff68362b9c6a047a0b0c7307"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether to clamp microphone input. <a href="mic_8h.html#aed8b72fbff68362b9c6a047a0b0c7307">More...</a><br /></td></tr>
<tr class="separator:aed8b72fbff68362b9c6a047a0b0c7307"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913ee846ab9633883625e6477ae10cdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mic_8h.html#a913ee846ab9633883625e6477ae10cdf">MICU_SetAllowShellClosed</a> (bool allowShellClosed)</td></tr>
<tr class="memdesc:a913ee846ab9633883625e6477ae10cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets whether to allow sampling when the shell is closed. <a href="mic_8h.html#a913ee846ab9633883625e6477ae10cdf">More...</a><br /></td></tr>
<tr class="separator:a913ee846ab9633883625e6477ae10cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MIC (Microphone) service. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a3ead458d1aabf74550446b463b4fb54f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ead458d1aabf74550446b463b4fb54f">&#9670;&nbsp;</a></span>MICU_Encoding</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Microphone audio encodings. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac"></a>MICU_ENCODING_PCM8&#160;</td><td class="fielddoc"><p>Unsigned 8-bit PCM. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2"></a>MICU_ENCODING_PCM16&#160;</td><td class="fielddoc"><p>Unsigned 16-bit PCM. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc"></a>MICU_ENCODING_PCM8_SIGNED&#160;</td><td class="fielddoc"><p>Signed 8-bit PCM. </p>
</td></tr>
<tr><td class="fieldname"><a id="a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92"></a>MICU_ENCODING_PCM16_SIGNED&#160;</td><td class="fielddoc"><p>Signed 16-bit PCM. </p>
</td></tr>
</table>
</div>
</div>
<a id="ae126d52922918356ed810bcc398ad62b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae126d52922918356ed810bcc398ad62b">&#9670;&nbsp;</a></span>MICU_SampleRate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Microphone audio sampling rates. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8"></a>MICU_SAMPLE_RATE_32730&#160;</td><td class="fielddoc"><p>32728.498 Hz </p>
</td></tr>
<tr><td class="fieldname"><a id="ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf"></a>MICU_SAMPLE_RATE_16360&#160;</td><td class="fielddoc"><p>16364.479 Hz </p>
</td></tr>
<tr><td class="fieldname"><a id="ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130"></a>MICU_SAMPLE_RATE_10910&#160;</td><td class="fielddoc"><p>10909.499 Hz </p>
</td></tr>
<tr><td class="fieldname"><a id="ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0"></a>MICU_SAMPLE_RATE_8180&#160;</td><td class="fielddoc"><p>8182.1245 Hz </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa2590afec7ac205e877ab94c9203a4c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2590afec7ac205e877ab94c9203a4c9">&#9670;&nbsp;</a></span>micGetLastSampleOffset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> micGetLastSampleOffset </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the offset within the shared memory buffer of the last sample written. </p>
<dl class="section return"><dt>Returns</dt><dd>The last sample's offset. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2mic_2source_2main_8c-example.html#a21">audio/mic/source/main.c</a>.</dd>
</dl>
</div>
</div>
<a id="a09361b33179e9ca5fd099161cf25d70a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09361b33179e9ca5fd099161cf25d70a">&#9670;&nbsp;</a></span>micGetSampleDataSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> micGetSampleDataSize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the sample data area within the shared memory buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>The sample data's size. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2mic_2source_2main_8c-example.html#a6">audio/mic/source/main.c</a>.</dd>
</dl>
</div>
</div>
<a id="a01ab8a1440cd4d38855336e47e5ae380"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01ab8a1440cd4d38855336e47e5ae380">&#9670;&nbsp;</a></span>micInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> micInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>bufferSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes MIC. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Shared memory buffer to write audio data to. Must be aligned to 0x1000 bytes. </td></tr>
<tr><td class="paramname">handle</td><td>Size of the shared memory buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2mic_2source_2main_8c-example.html#a5">audio/mic/source/main.c</a>.</dd>
</dl>
</div>
</div>
<a id="afdc168c4f160192b7b3b04e49d15ec86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdc168c4f160192b7b3b04e49d15ec86">&#9670;&nbsp;</a></span>MICU_AdjustSampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_AdjustSampling </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a>&#160;</td>
<td class="paramname"><em>sampleRate</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adjusts the configuration of the current sampling session. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sampleRate</td><td>Sample rate of outputted audio. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aed8b72fbff68362b9c6a047a0b0c7307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed8b72fbff68362b9c6a047a0b0c7307">&#9670;&nbsp;</a></span>MICU_GetClamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_GetClamp </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>clamp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether to clamp microphone input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">clamp</td><td>Pointer to output the clamp state to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8f17c21f1420682eb699cf39adf537b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f17c21f1420682eb699cf39adf537b2">&#9670;&nbsp;</a></span>MICU_GetEventHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_GetEventHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an event handle triggered when the shared memory buffer is full. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>Pointer to output the event handle to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="add912c11a5b5ff8dabe224e2f380be9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add912c11a5b5ff8dabe224e2f380be9b">&#9670;&nbsp;</a></span>MICU_GetGain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_GetGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *&#160;</td>
<td class="paramname"><em>gain</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the microphone's gain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gain</td><td>Pointer to output the current gain to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a38f4599e0d974a89a4448b3a53360cc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38f4599e0d974a89a4448b3a53360cc6">&#9670;&nbsp;</a></span>MICU_GetPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_GetPower </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>power</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the microphone is powered on. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">power</td><td>Pointer to output the power state to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a42078893931d09a8b27f3306c7f13a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42078893931d09a8b27f3306c7f13a29">&#9670;&nbsp;</a></span>MICU_IsSampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_IsSampling </td>
<td>(</td>
<td class="paramtype">bool *&#160;</td>
<td class="paramname"><em>sampling</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether microphone input is currently being sampled. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sampling</td><td>Pointer to output the sampling state to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3dd3e9152bbddcafe2babc371c210222"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3dd3e9152bbddcafe2babc371c210222">&#9670;&nbsp;</a></span>MICU_MapSharedMem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_MapSharedMem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td>
<td class="paramname"><em>handle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Maps MIC shared memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>Size of the shared memory. </td></tr>
<tr><td class="paramname">handle</td><td>Handle of the shared memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a913ee846ab9633883625e6477ae10cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a913ee846ab9633883625e6477ae10cdf">&#9670;&nbsp;</a></span>MICU_SetAllowShellClosed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_SetAllowShellClosed </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>allowShellClosed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether to allow sampling when the shell is closed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allowShellClosed</td><td>Whether to allow sampling when the shell is closed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0a156a0b69714f334c004c7137a7592c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a156a0b69714f334c004c7137a7592c">&#9670;&nbsp;</a></span>MICU_SetClamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_SetClamp </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>clamp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether to clamp microphone input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">clamp</td><td>Whether to clamp microphone input. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0c29ffb2d0addbaca328d8aad082e3bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c29ffb2d0addbaca328d8aad082e3bf">&#9670;&nbsp;</a></span>MICU_SetGain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_SetGain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>gain</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the microphone's gain. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gain</td><td>Gain to set. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3a26bd2ff5eeaaf538df29230b3fda61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a26bd2ff5eeaaf538df29230b3fda61">&#9670;&nbsp;</a></span>MICU_SetPower()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_SetPower </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>power</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the microphone is powered on. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">power</td><td>Whether the microphone is powered on. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a79266af4aa50d790fba3680d423f6ff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79266af4aa50d790fba3680d423f6ff0">&#9670;&nbsp;</a></span>MICU_StartSampling()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> MICU_StartSampling </td>
<td>(</td>
<td class="paramtype"><a class="el" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a>&#160;</td>
<td class="paramname"><em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a>&#160;</td>
<td class="paramname"><em>sampleRate</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>loop</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Begins sampling microphone input. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">encoding</td><td>Encoding of outputted audio. </td></tr>
<tr><td class="paramname">sampleRate</td><td>Sample rate of outputted audio. </td></tr>
<tr><td class="paramname">sharedMemAudioOffset</td><td>Offset to write audio data to in the shared memory buffer. </td></tr>
<tr><td class="paramname">sharedMemAudioSize</td><td>Size of audio data to write to the shared memory buffer. This should be at most "bufferSize - 4". </td></tr>
<tr><td class="paramname">loop</td><td>Whether to loop back to the beginning of the buffer when the end is reached. </td></tr>
</table>
</dd>
</dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2mic_2source_2main_8c-example.html#a17">audio/mic/source/main.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink