mirror of
https://github.com/felis/USB_Host_Shield_2.0.git
synced 2024-03-22 11:31:26 +01:00
662 lines
56 KiB
HTML
662 lines
56 KiB
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.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>USB Host Shield 2.0: MiniDSP Class 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" />
|
|
<link href="imageStyle.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">USB Host Shield 2.0
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<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');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_mini_d_s_p-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">MiniDSP Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for MiniDSP:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_mini_d_s_p__inherit__graph.png" border="0" usemap="#_mini_d_s_p_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_mini_d_s_p_inherit__map" id="_mini_d_s_p_inherit__map">
|
|
<area shape="rect" title=" " alt="" coords="115,304,191,331"/>
|
|
<area shape="rect" href="class_h_i_d_universal.html" title=" " alt="" coords="99,229,207,256"/>
|
|
<area shape="rect" href="class_h_i_d_composite.html" title=" " alt="" coords="95,155,211,181"/>
|
|
<area shape="rect" href="class_u_s_b_h_i_d.html" title=" " alt="" coords="116,80,189,107"/>
|
|
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="5,5,140,32"/>
|
|
<area shape="rect" href="class_usb_config_xtracter.html" title=" " alt="" coords="164,5,304,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for MiniDSP:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_mini_d_s_p__coll__graph.png" border="0" usemap="#_mini_d_s_p_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="_mini_d_s_p_coll__map" id="_mini_d_s_p_coll__map">
|
|
<area shape="rect" title=" " alt="" coords="1064,195,1140,221"/>
|
|
<area shape="rect" href="class_h_i_d_universal.html" title=" " alt="" coords="907,195,1015,221"/>
|
|
<area shape="rect" href="class_h_i_d_composite.html" title=" " alt="" coords="741,195,857,221"/>
|
|
<area shape="rect" href="class_u_s_b_h_i_d.html" title=" " alt="" coords="464,68,537,95"/>
|
|
<area shape="rect" href="class_u_s_b_device_config.html" title=" " alt="" coords="149,5,284,32"/>
|
|
<area shape="rect" href="class_usb_config_xtracter.html" title=" " alt="" coords="147,56,287,83"/>
|
|
<area shape="rect" href="class_u_s_b.html" title=" " alt="" coords="192,107,241,133"/>
|
|
<area shape="rect" href="class_m_a_x3421e.html" title=" " alt="" coords="5,107,97,133"/>
|
|
<area shape="rect" href="struct_h_i_d_composite_1_1_report_parser.html" title=" " alt="" coords="397,144,604,171"/>
|
|
<area shape="rect" href="class_h_i_d_report_parser.html" title=" " alt="" coords="152,157,281,184"/>
|
|
<area shape="rect" href="struct_ep_info.html" title=" " alt="" coords="469,195,532,221"/>
|
|
<area shape="rect" href="struct_h_i_d___c_l_a_s_s___d_e_s_c_r_i_p_t_o_r___l_e_n___a_n_d___t_y_p_e.html" title=" " alt="" coords="408,246,593,287"/>
|
|
<area shape="rect" href="struct_h_i_d_composite_1_1_h_i_d_interface.html" title=" " alt="" coords="397,312,604,339"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a61ddb80aeaa012d96fccf1515a584ff0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a61ddb80aeaa012d96fccf1515a584ff0">MiniDSP</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:a61ddb80aeaa012d96fccf1515a584ff0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae6ec3cef4ed8aee5bcc4083f4f55451a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#ae6ec3cef4ed8aee5bcc4083f4f55451a">connected</a> ()</td></tr>
|
|
<tr class="separator:ae6ec3cef4ed8aee5bcc4083f4f55451a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e27e9ed52e1532a3287af49793361a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a5e27e9ed52e1532a3287af49793361a1">attachOnInit</a> (void(*funcOnInit)(void))</td></tr>
|
|
<tr class="separator:a5e27e9ed52e1532a3287af49793361a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a753f2095feda60f5ec1680f8245ce5c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a753f2095feda60f5ec1680f8245ce5c3">attachOnVolumeChange</a> (void(*funcOnVolumeChange)(uint8_t))</td></tr>
|
|
<tr class="separator:a753f2095feda60f5ec1680f8245ce5c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8de93d377f046a4fdf766461c5080d75"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a8de93d377f046a4fdf766461c5080d75">attachOnMutedChange</a> (void(*funcOnMutedChange)(bool))</td></tr>
|
|
<tr class="separator:a8de93d377f046a4fdf766461c5080d75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e10731a50bdce381611f2fbd9ec0dd3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a2e10731a50bdce381611f2fbd9ec0dd3">getVolume</a> () const</td></tr>
|
|
<tr class="separator:a2e10731a50bdce381611f2fbd9ec0dd3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a922a9d11f8dd313d865dc2f56f96e9bb"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a922a9d11f8dd313d865dc2f56f96e9bb">getVolumeDB</a> () const</td></tr>
|
|
<tr class="separator:a922a9d11f8dd313d865dc2f56f96e9bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21dc0080de9d16a1c612bc23896f958a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a21dc0080de9d16a1c612bc23896f958a">isMuted</a> () const</td></tr>
|
|
<tr class="separator:a21dc0080de9d16a1c612bc23896f958a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_h_i_d_universal"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h_i_d_universal')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a></td></tr>
|
|
<tr class="memitem:abdbac688c7e4b682055cebd82e13a595 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#abdbac688c7e4b682055cebd82e13a595">HIDUniversal</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:abdbac688c7e4b682055cebd82e13a595 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71b7d8e31a4331071bbc0e3b678cdd3f inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a71b7d8e31a4331071bbc0e3b678cdd3f">Poll</a> () override</td></tr>
|
|
<tr class="separator:a71b7d8e31a4331071bbc0e3b678cdd3f inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a230339bc00784715ba1ef9496b033d20 inherit pub_methods_class_h_i_d_universal"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_universal.html#a230339bc00784715ba1ef9496b033d20">EndpointXtract</a> (uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep) override</td></tr>
|
|
<tr class="separator:a230339bc00784715ba1ef9496b033d20 inherit pub_methods_class_h_i_d_universal"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_h_i_d_composite"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_h_i_d_composite')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_h_i_d_composite.html">HIDComposite</a></td></tr>
|
|
<tr class="memitem:ab95d41d88cdcbb8c7e988f411c0ce860 inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#ab95d41d88cdcbb8c7e988f411c0ce860">HIDComposite</a> (<a class="el" href="class_u_s_b.html">USB</a> *p)</td></tr>
|
|
<tr class="separator:ab95d41d88cdcbb8c7e988f411c0ce860 inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94136774d685b89c5a149c4e4df78087 inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a94136774d685b89c5a149c4e4df78087">SetReportParser</a> (uint8_t id, <a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> *prs)</td></tr>
|
|
<tr class="separator:a94136774d685b89c5a149c4e4df78087 inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5d02f2915f83817f2121acdefc7f573 inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#ac5d02f2915f83817f2121acdefc7f573">Init</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:ac5d02f2915f83817f2121acdefc7f573 inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32e00e1018a5d54096f5146139cbdcba inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a32e00e1018a5d54096f5146139cbdcba">Release</a> ()</td></tr>
|
|
<tr class="separator:a32e00e1018a5d54096f5146139cbdcba inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78e132d91e9ed557260955d5426f3442 inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a78e132d91e9ed557260955d5426f3442">GetAddress</a> ()</td></tr>
|
|
<tr class="separator:a78e132d91e9ed557260955d5426f3442 inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d12bc7e852944029b1314a95b84d6ce inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a3d12bc7e852944029b1314a95b84d6ce">isReady</a> ()</td></tr>
|
|
<tr class="separator:a3d12bc7e852944029b1314a95b84d6ce inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a64f21aff7c40daf988a7a2d568c69d5d inherit pub_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a64f21aff7c40daf988a7a2d568c69d5d">SndRpt</a> (uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a64f21aff7c40daf988a7a2d568c69d5d inherit pub_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
|
|
<tr class="memitem:a2d8aa4af4c7d0470d6643fa94e9b39dd inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a2d8aa4af4c7d0470d6643fa94e9b39dd">USBHID</a> (<a class="el" href="class_u_s_b.html">USB</a> *pusb)</td></tr>
|
|
<tr class="separator:a2d8aa4af4c7d0470d6643fa94e9b39dd inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad90bc410a083495a4ddefc2000f67dbd inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#ad90bc410a083495a4ddefc2000f67dbd">GetUsb</a> ()</td></tr>
|
|
<tr class="separator:ad90bc410a083495a4ddefc2000f67dbd inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0af861b780529c51c97c00dc89d56149 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a0af861b780529c51c97c00dc89d56149">SetProtocol</a> (uint8_t iface, uint8_t protocol)</td></tr>
|
|
<tr class="separator:a0af861b780529c51c97c00dc89d56149 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93f4eec0d75b7abcac5f92164e588cb3 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a93f4eec0d75b7abcac5f92164e588cb3">GetProtocol</a> (uint8_t iface, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a93f4eec0d75b7abcac5f92164e588cb3 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a564e27e86247c8e45bc2b2b037921d04 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a564e27e86247c8e45bc2b2b037921d04">GetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a564e27e86247c8e45bc2b2b037921d04 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefe5089655e55bd8f32c796818778d75 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#aefe5089655e55bd8f32c796818778d75">SetIdle</a> (uint8_t iface, uint8_t reportID, uint8_t duration)</td></tr>
|
|
<tr class="separator:aefe5089655e55bd8f32c796818778d75 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69812b5f7d3b28446826d9d5ca4a62d7 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a69812b5f7d3b28446826d9d5ca4a62d7">GetReportDescr</a> (uint16_t wIndex, <a class="el" href="class_u_s_b_read_parser.html">USBReadParser</a> *parser=NULL)</td></tr>
|
|
<tr class="separator:a69812b5f7d3b28446826d9d5ca4a62d7 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7536f1ee5de5645c6df5140ca9f345a inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#af7536f1ee5de5645c6df5140ca9f345a">GetHidDescr</a> (uint8_t ep, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:af7536f1ee5de5645c6df5140ca9f345a inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1dab89b069f2cae6a63a151b2ffdd35a inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a1dab89b069f2cae6a63a151b2ffdd35a">GetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a1dab89b069f2cae6a63a151b2ffdd35a inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66e217a1d1237239514ce6149e46cc56 inherit pub_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a66e217a1d1237239514ce6149e46cc56">SetReport</a> (uint8_t ep, uint8_t iface, uint8_t report_type, uint8_t report_id, uint16_t nbytes, uint8_t *dataptr)</td></tr>
|
|
<tr class="separator:a66e217a1d1237239514ce6149e46cc56 inherit pub_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_class_u_s_b_device_config"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_u_s_b_device_config')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_u_s_b_device_config.html">USBDeviceConfig</a></td></tr>
|
|
<tr class="memitem:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#aef77a1e62f78c04a1aad53e8795ec89e">ConfigureDevice</a> (uint8_t parent, uint8_t port, bool lowspeed)</td></tr>
|
|
<tr class="separator:aef77a1e62f78c04a1aad53e8795ec89e inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a12bb63558ded5bb6661bb173b07ff391">ResetHubPort</a> (uint8_t port)</td></tr>
|
|
<tr class="separator:a12bb63558ded5bb6661bb173b07ff391 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#a2bb3e09cf128c8ecd04ea0dfce2126e1">DEVCLASSOK</a> (uint8_t klass)</td></tr>
|
|
<tr class="separator:a2bb3e09cf128c8ecd04ea0dfce2126e1 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_device_config.html#ad2d535af92d0b97e4445a6bd51d35c57">DEVSUBCLASSOK</a> (uint8_t subklass)</td></tr>
|
|
<tr class="separator:ad2d535af92d0b97e4445a6bd51d35c57 inherit pub_methods_class_u_s_b_device_config"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">HIDUniversal implementation</div></td></tr>
|
|
<tr class="memitem:aa40ffa6a5d2ec8c49748aeb22cbb8a15"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#aa40ffa6a5d2ec8c49748aeb22cbb8a15">ParseHIDData</a> (<a class="el" href="class_u_s_b_h_i_d.html">USBHID</a> *hid, bool is_rpt_id, uint8_t len, uint8_t *buf)</td></tr>
|
|
<tr class="separator:aa40ffa6a5d2ec8c49748aeb22cbb8a15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a631361040f3014292b44ffa8cdc254e5"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#a631361040f3014292b44ffa8cdc254e5">OnInitSuccessful</a> ()</td></tr>
|
|
<tr class="separator:a631361040f3014292b44ffa8cdc254e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">USBDeviceConfig implementation</div></td></tr>
|
|
<tr class="memitem:ab0f36efa8eb39bf4df08f0dee5ce352c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_mini_d_s_p.html#ab0f36efa8eb39bf4df08f0dee5ce352c">VIDPIDOK</a> (uint16_t vid, uint16_t pid)</td></tr>
|
|
<tr class="separator:ab0f36efa8eb39bf4df08f0dee5ce352c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_class_h_i_d_composite"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_h_i_d_composite')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_h_i_d_composite.html">HIDComposite</a></td></tr>
|
|
<tr class="memitem:aa14d5499c5a4de50fba72ee5a8024e80 inherit pro_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#aa14d5499c5a4de50fba72ee5a8024e80">GetHidClassDescrLen</a> (uint8_t type, uint8_t num)</td></tr>
|
|
<tr class="separator:aa14d5499c5a4de50fba72ee5a8024e80 inherit pro_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38cf93412d960797f0877e675aff9dd1 inherit pro_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a38cf93412d960797f0877e675aff9dd1">Initialize</a> ()</td></tr>
|
|
<tr class="separator:a38cf93412d960797f0877e675aff9dd1 inherit pro_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53e1bd38eb71173f38429f5b8aa3c8c1 inherit pro_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_h_i_d_composite_1_1_h_i_d_interface.html">HIDInterface</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a53e1bd38eb71173f38429f5b8aa3c8c1">FindInterface</a> (uint8_t iface, uint8_t alt, uint8_t proto)</td></tr>
|
|
<tr class="separator:a53e1bd38eb71173f38429f5b8aa3c8c1 inherit pro_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a968d81013f2fe7b3f44953fbe0d3a822 inherit pro_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a968d81013f2fe7b3f44953fbe0d3a822">ZeroMemory</a> (uint8_t len, uint8_t *buf)</td></tr>
|
|
<tr class="separator:a968d81013f2fe7b3f44953fbe0d3a822 inherit pro_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2def47200c98f97f3a3171d50e38f2d0 inherit pro_methods_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_h_i_d_report_parser.html">HIDReportParser</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a2def47200c98f97f3a3171d50e38f2d0">GetReportParser</a> (uint8_t id)</td></tr>
|
|
<tr class="separator:a2def47200c98f97f3a3171d50e38f2d0 inherit pro_methods_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
|
|
<tr class="memitem:a046f84af88dab2e9063db0bf36308cd4 inherit pro_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a046f84af88dab2e9063db0bf36308cd4">PrintEndpointDescriptor</a> (const <a class="el" href="struct_u_s_b___e_n_d_p_o_i_n_t___d_e_s_c_r_i_p_t_o_r.html">USB_ENDPOINT_DESCRIPTOR</a> *ep_ptr)</td></tr>
|
|
<tr class="separator:a046f84af88dab2e9063db0bf36308cd4 inherit pro_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa44154dd3ee08a39ea4c70d984ff7d9f inherit pro_methods_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#aa44154dd3ee08a39ea4c70d984ff7d9f">PrintHidDescriptor</a> (const <a class="el" href="struct_u_s_b___h_i_d___d_e_s_c_r_i_p_t_o_r.html">USB_HID_DESCRIPTOR</a> *pDesc)</td></tr>
|
|
<tr class="separator:aa44154dd3ee08a39ea4c70d984ff7d9f inherit pro_methods_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pro_attribs_class_h_i_d_composite"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_h_i_d_composite')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_h_i_d_composite.html">HIDComposite</a></td></tr>
|
|
<tr class="memitem:a5b7158c8cca54dd151bf1eaf2f6b49bb inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="struct_h_i_d_composite_1_1_report_parser.html">HIDComposite::ReportParser</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a5b7158c8cca54dd151bf1eaf2f6b49bb">rptParsers</a> [<a class="el" href="usbhid_8h.html#aeeb08a8b14bc04296f1c839872abc8af">MAX_REPORT_PARSERS</a>]</td></tr>
|
|
<tr class="separator:a5b7158c8cca54dd151bf1eaf2f6b49bb inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76798078fef95b6a500cf23fd8844a1b inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_h_i_d___c_l_a_s_s___d_e_s_c_r_i_p_t_o_r___l_e_n___a_n_d___t_y_p_e.html">HID_CLASS_DESCRIPTOR_LEN_AND_TYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a76798078fef95b6a500cf23fd8844a1b">descrInfo</a> [<a class="el" href="usbhid_8h.html#a9901c86718db1fefe5d116aa254361cf">HID_MAX_HID_CLASS_DESCRIPTORS</a>]</td></tr>
|
|
<tr class="separator:a76798078fef95b6a500cf23fd8844a1b inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83cf05744c9ebc0090a17727b5a2ce05 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a83cf05744c9ebc0090a17727b5a2ce05">bConfNum</a></td></tr>
|
|
<tr class="separator:a83cf05744c9ebc0090a17727b5a2ce05 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac42fb3b1c0ad8019bebbde5e623cf0a1 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#ac42fb3b1c0ad8019bebbde5e623cf0a1">bNumIface</a></td></tr>
|
|
<tr class="separator:ac42fb3b1c0ad8019bebbde5e623cf0a1 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af96da3ba2b0fb46acb2bffb776ac2bf8 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#af96da3ba2b0fb46acb2bffb776ac2bf8">bNumEP</a></td></tr>
|
|
<tr class="separator:af96da3ba2b0fb46acb2bffb776ac2bf8 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2321ef1ab62deccdc4c0294dad333b54 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a2321ef1ab62deccdc4c0294dad333b54">qNextPollTime</a></td></tr>
|
|
<tr class="separator:a2321ef1ab62deccdc4c0294dad333b54 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1cd12f8f2dc3f6a585f6c90bde24f2b inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#ae1cd12f8f2dc3f6a585f6c90bde24f2b">pollInterval</a></td></tr>
|
|
<tr class="separator:ae1cd12f8f2dc3f6a585f6c90bde24f2b inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4e1f64150affa87b1b813a988e4f78c8 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a4e1f64150affa87b1b813a988e4f78c8">bPollEnable</a></td></tr>
|
|
<tr class="separator:a4e1f64150affa87b1b813a988e4f78c8 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4101c34c5079bd827953368450140a9a inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_ep_info.html">EpInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a4101c34c5079bd827953368450140a9a">epInfo</a> [<a class="el" href="class_u_s_b_h_i_d.html#a17c4235f411847c34c77977bbd3e3324">totalEndpoints</a>]</td></tr>
|
|
<tr class="separator:a4101c34c5079bd827953368450140a9a inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a374a34b7f7f94aa1dfb73ca48a5231ce inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_h_i_d_composite_1_1_h_i_d_interface.html">HIDInterface</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a374a34b7f7f94aa1dfb73ca48a5231ce">hidInterfaces</a> [<a class="el" href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">maxHidInterfaces</a>]</td></tr>
|
|
<tr class="separator:a374a34b7f7f94aa1dfb73ca48a5231ce inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd584015be45fe945f9062c2c5b2a867 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#abd584015be45fe945f9062c2c5b2a867">bHasReportId</a></td></tr>
|
|
<tr class="separator:abd584015be45fe945f9062c2c5b2a867 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1402689fc7e633723fca2b6b175c2a18 inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a1402689fc7e633723fca2b6b175c2a18">PID</a></td></tr>
|
|
<tr class="separator:a1402689fc7e633723fca2b6b175c2a18 inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf516cb6242d1659c9bc77fe475c973e inherit pro_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#acf516cb6242d1659c9bc77fe475c973e">VID</a></td></tr>
|
|
<tr class="separator:acf516cb6242d1659c9bc77fe475c973e inherit pro_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
|
|
<tr class="memitem:abb120ee1258c49b4af0fbd59ae6903f5 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_u_s_b.html">USB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#abb120ee1258c49b4af0fbd59ae6903f5">pUsb</a></td></tr>
|
|
<tr class="separator:abb120ee1258c49b4af0fbd59ae6903f5 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a35fe591ddd550b290d1e88c321617ab6 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a35fe591ddd550b290d1e88c321617ab6">bAddress</a></td></tr>
|
|
<tr class="separator:a35fe591ddd550b290d1e88c321617ab6 inherit pro_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_static_attribs_class_h_i_d_composite"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_h_i_d_composite')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_h_i_d_composite.html">HIDComposite</a></td></tr>
|
|
<tr class="memitem:a33882712ebd600a16e7e62c87853cea7 inherit pro_static_attribs_class_h_i_d_composite"><td class="memItemLeft" align="right" valign="top">static const uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_h_i_d_composite.html#a33882712ebd600a16e7e62c87853cea7">constBuffLen</a> = 64</td></tr>
|
|
<tr class="separator:a33882712ebd600a16e7e62c87853cea7 inherit pro_static_attribs_class_h_i_d_composite"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_static_attribs_class_u_s_b_h_i_d"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_u_s_b_h_i_d')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_u_s_b_h_i_d.html">USBHID</a></td></tr>
|
|
<tr class="memitem:a722462978813b2154698516b729e834d inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a722462978813b2154698516b729e834d">epInterruptInIndex</a> = 1</td></tr>
|
|
<tr class="separator:a722462978813b2154698516b729e834d inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9ae556d2a7a03309db403e45eab96e8 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#af9ae556d2a7a03309db403e45eab96e8">epInterruptOutIndex</a> = 2</td></tr>
|
|
<tr class="separator:af9ae556d2a7a03309db403e45eab96e8 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a47b8c02d90076852e079acfb62ae46 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">maxHidInterfaces</a> = 5</td></tr>
|
|
<tr class="separator:a6a47b8c02d90076852e079acfb62ae46 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cd9a3226f72cc965dcac27c3bd25ed9 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a7cd9a3226f72cc965dcac27c3bd25ed9">maxEpPerInterface</a> = 2</td></tr>
|
|
<tr class="separator:a7cd9a3226f72cc965dcac27c3bd25ed9 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17c4235f411847c34c77977bbd3e3324 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memItemLeft" align="right" valign="top">static const uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_s_b_h_i_d.html#a17c4235f411847c34c77977bbd3e3324">totalEndpoints</a> = (<a class="el" href="class_u_s_b_h_i_d.html#a6a47b8c02d90076852e079acfb62ae46">maxHidInterfaces</a> * <a class="el" href="class_u_s_b_h_i_d.html#a7cd9a3226f72cc965dcac27c3bd25ed9">maxEpPerInterface</a> + 1)</td></tr>
|
|
<tr class="separator:a17c4235f411847c34c77977bbd3e3324 inherit pro_static_attribs_class_u_s_b_h_i_d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Arduino <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> 2x4HD <a class="el" href="class_u_s_b.html">USB</a> Host Driver by Dennis Frett.</p>
|
|
<p>This class implements support for the <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> 2x4HD via <a class="el" href="class_u_s_b.html">USB</a>. Based on NodeJS implementation by Mathieu Rene: <a href="https://github.com/mrene/node-minidsp">https://github.com/mrene/node-minidsp</a> and the Python implementation by Mark Kubiak: <a href="https://github.com/markubiak/python3-minidsp">https://github.com/markubiak/python3-minidsp</a>.</p>
|
|
<p>It uses the <a class="el" href="class_h_i_d_universal.html">HIDUniversal</a> class for all the <a class="el" href="class_u_s_b.html">USB</a> communication. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00039">39</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a61ddb80aeaa012d96fccf1515a584ff0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61ddb80aeaa012d96fccf1515a584ff0">◆ </a></span>MiniDSP()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MiniDSP::MiniDSP </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_u_s_b.html">USB</a> * </td>
|
|
<td class="paramname"><em>p</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructor for the <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> class. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">p</td><td>Pointer to the <a class="el" href="class_u_s_b.html">USB</a> class instance. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00046">46</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae6ec3cef4ed8aee5bcc4083f4f55451a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae6ec3cef4ed8aee5bcc4083f4f55451a">◆ </a></span>connected()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MiniDSP::connected </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to check if a <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> 2x4HD is connected. </p><dl class="section return"><dt>Returns</dt><dd>Returns true if it is connected. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00053">53</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e27e9ed52e1532a3287af49793361a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e27e9ed52e1532a3287af49793361a1">◆ </a></span>attachOnInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MiniDSP::attachOnInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(void) </td>
|
|
<td class="paramname"><em>funcOnInit</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to call your own function when the device is successfully initialized. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">funcOnInit</td><td>Function to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00062">62</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a753f2095feda60f5ec1680f8245ce5c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a753f2095feda60f5ec1680f8245ce5c3">◆ </a></span>attachOnVolumeChange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MiniDSP::attachOnVolumeChange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(uint8_t) </td>
|
|
<td class="paramname"><em>funcOnVolumeChange</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to call your own function when the volume has changed. The volume is passed as an unsigned integer that represents twice the -dB value. Example: 19 represents -9.5dB. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">funcOnVolumeChange</td><td>Function to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00072">72</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8de93d377f046a4fdf766461c5080d75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8de93d377f046a4fdf766461c5080d75">◆ </a></span>attachOnMutedChange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MiniDSP::attachOnMutedChange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void(*)(bool) </td>
|
|
<td class="paramname"><em>funcOnMutedChange</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to call your own function when the muted status has changed. The muted status is passed as a boolean. True means muted, false means unmuted. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">funcOnMutedChange</td><td>Function to call. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00082">82</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e10731a50bdce381611f2fbd9ec0dd3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e10731a50bdce381611f2fbd9ec0dd3">◆ </a></span>getVolume()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int MiniDSP::getVolume </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieve the current volume of the <a class="el" href="class_mini_d_s_p.html">MiniDSP</a>. The volume is passed as an unsigned integer that represents twice the -dB value. Example: 19 represents -9.5dB. </p><dl class="section return"><dt>Returns</dt><dd>Current volume. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00092">92</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a922a9d11f8dd313d865dc2f56f96e9bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a922a9d11f8dd313d865dc2f56f96e9bb">◆ </a></span>getVolumeDB()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float MiniDSP::getVolumeDB </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieve the current volume of the <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> in -dB. </p><dl class="section return"><dt>Returns</dt><dd>Current volume. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00100">100</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21dc0080de9d16a1c612bc23896f958a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21dc0080de9d16a1c612bc23896f958a">◆ </a></span>isMuted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MiniDSP::isMuted </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieve the current muted status of the <a class="el" href="class_mini_d_s_p.html">MiniDSP</a> </p><dl class="section return"><dt>Returns</dt><dd><code>true</code> if the device is muted, <code>false</code> otherwise. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00108">108</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa40ffa6a5d2ec8c49748aeb22cbb8a15"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa40ffa6a5d2ec8c49748aeb22cbb8a15">◆ </a></span>ParseHIDData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MiniDSP::ParseHIDData </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_u_s_b_h_i_d.html">USBHID</a> * </td>
|
|
<td class="paramname"><em>hid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>is_rpt_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>len</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used to parse <a class="el" href="class_u_s_b.html">USB</a> HID data. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hid</td><td>Pointer to the HID class. </td></tr>
|
|
<tr><td class="paramname">is_rpt_id</td><td>Only used for Hubs. </td></tr>
|
|
<tr><td class="paramname">len</td><td>The length of the incoming data. </td></tr>
|
|
<tr><td class="paramname">buf</td><td>Pointer to the data buffer. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_h_i_d_universal.html#a5d6e27f817d6d2c67692783a02872939">HIDUniversal</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8cpp_source.html#l00024">24</a> of file <a class="el" href="_mini_d_s_p_8cpp_source.html">MiniDSP.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a631361040f3014292b44ffa8cdc254e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a631361040f3014292b44ffa8cdc254e5">◆ </a></span>OnInitSuccessful()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t MiniDSP::OnInitSuccessful </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Called when a device is successfully initialized. Use attachOnInit(void (*funcOnInit)(void)) to call your own function. This is useful for instance if you want to set the LEDs in a specific way. </p>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_h_i_d_composite.html#a019b44e0f9b4849362ab86fa85fdc826">HIDComposite</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8cpp_source.html#l00057">57</a> of file <a class="el" href="_mini_d_s_p_8cpp_source.html">MiniDSP.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0f36efa8eb39bf4df08f0dee5ce352c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0f36efa8eb39bf4df08f0dee5ce352c">◆ </a></span>VIDPIDOK()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool MiniDSP::VIDPIDOK </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>vid</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pid</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Used by the <a class="el" href="class_u_s_b.html">USB</a> core to check what this driver support. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vid</td><td>The device's VID. </td></tr>
|
|
<tr><td class="paramname">pid</td><td>The device's PID. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns true if the device's VID and PID matches this driver. </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="class_u_s_b_device_config.html#af920743379d8c133dda4335d11601141">USBDeviceConfig</a>.</p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="_mini_d_s_p_8h_source.html#l00141">141</a> of file <a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="_mini_d_s_p_8h_source.html">MiniDSP.h</a></li>
|
|
<li><a class="el" href="_mini_d_s_p_8cpp_source.html">MiniDSP.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|