doxygen

Author: pschatzmann

docs/html/_audio_board_8h_source.html

@@ -82,9 +82,9 @@
   <tr><td class="entry"><a class="el" href="structcodec__config__t.html#af1127704c2bde9a89bb0b092bfb13746">input_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="structcodec__config__t.html#a53991a860287c34f4e412af745d4bb66">output_device</a></td><td class="entry"><a class="el" href="structcodec__config__t.html">codec_config_t</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ac585b3449d271276f8b679e8ab01b2ec">sd_active</a></td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">setBitsNumeric</a>(int bits)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">setChannelsNumeric</a>(int channels)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">setRateNumeric</a>(int rateNum)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a2cf0779e606be31b752e7cec8c184a9e">setBitsNumeric</a>(int bits)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#a3c32c7aaa80dc2060c20dfcf11ba7204">setChannelsNumeric</a>(int channels)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html#af946880eb3f7403e06e3d1646acdad27">setRateNumeric</a>(int requestedRate)</td><td class="entry"><a class="el" href="classaudio__driver_1_1_codec_config.html">CodecConfig</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/_driver_8h_source.html

@@ -107,13 +107,14 @@
 <tr class="memitem:a5a8e72d47263001aff56c9f4aa976fa4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#a5a8e72d47263001aff56c9f4aa976fa4">getRateNumeric</a> ()</td></tr>
 <tr class="memdesc:a5a8e72d47263001aff56c9f4aa976fa4"><td class="mdescLeft">&#160;</td><td class="mdescRight">get the sample rate as number  <a href="classaudio__driver_1_1_codec_config.html#a5a8e72d47263001aff56c9f4aa976fa4">More...</a><br /></td></tr>
 <tr class="separator:a5a8e72d47263001aff56c9f4aa976fa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7755035109f6cf777b72e1d24af59ffc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">setBitsNumeric</a> (int bits)</td></tr>
-<tr class="separator:a7755035109f6cf777b72e1d24af59ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae392521121275dbe7f3d3e805a638793"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">setChannelsNumeric</a> (int channels)</td></tr>
-<tr class="separator:ae392521121275dbe7f3d3e805a638793"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ad7fff9aeffbd30c2bf93c8c597b2ede6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">setRateNumeric</a> (int rateNum)</td></tr>
-<tr class="memdesc:ad7fff9aeffbd30c2bf93c8c597b2ede6"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the sample rate as number  <a href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">More...</a><br /></td></tr>
-<tr class="separator:ad7fff9aeffbd30c2bf93c8c597b2ede6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a2cf0779e606be31b752e7cec8c184a9e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#a2cf0779e606be31b752e7cec8c184a9e">setBitsNumeric</a> (int bits)</td></tr>
+<tr class="memdesc:a2cf0779e606be31b752e7cec8c184a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the bits per sample with a numeric value.  <a href="classaudio__driver_1_1_codec_config.html#a2cf0779e606be31b752e7cec8c184a9e">More...</a><br /></td></tr>
+<tr class="separator:a2cf0779e606be31b752e7cec8c184a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a3c32c7aaa80dc2060c20dfcf11ba7204"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#a3c32c7aaa80dc2060c20dfcf11ba7204">setChannelsNumeric</a> (int channels)</td></tr>
+<tr class="separator:a3c32c7aaa80dc2060c20dfcf11ba7204"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:af946880eb3f7403e06e3d1646acdad27"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__driver_1_1_codec_config.html#af946880eb3f7403e06e3d1646acdad27">setRateNumeric</a> (int requestedRate)</td></tr>
+<tr class="memdesc:af946880eb3f7403e06e3d1646acdad27"><td class="mdescLeft">&#160;</td><td class="mdescRight">sets the sample rate as number: returns the effectively set rate  <a href="classaudio__driver_1_1_codec_config.html#af946880eb3f7403e06e3d1646acdad27">More...</a><br /></td></tr>
+<tr class="separator:af946880eb3f7403e06e3d1646acdad27"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 Public Attributes</h2></td></tr>
@@ -293,8 +294,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5a8e72d47263001aff56c9f4
 
 </div>
 </div>
-<a id="a7755035109f6cf777b72e1d24af59ffc"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a7755035109f6cf777b72e1d24af59ffc">&#9670;&nbsp;</a></span>setBitsNumeric()</h2>
+<a id="a2cf0779e606be31b752e7cec8c184a9e"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a2cf0779e606be31b752e7cec8c184a9e">&#9670;&nbsp;</a></span>setBitsNumeric()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -303,7 +304,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7755035109f6cf777b72e1d2
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">int setBitsNumeric </td>
+          <td class="memname">bool setBitsNumeric </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"><em>bits</em></td><td>)</td>
@@ -317,10 +318,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a7755035109f6cf777b72e1d2
 </table>
 </div><div class="memdoc">
 
+<p>Sets the bits per sample with a numeric value. </p>
+
 </div>
 </div>
-<a id="ae392521121275dbe7f3d3e805a638793"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ae392521121275dbe7f3d3e805a638793">&#9670;&nbsp;</a></span>setChannelsNumeric()</h2>
+<a id="a3c32c7aaa80dc2060c20dfcf11ba7204"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a3c32c7aaa80dc2060c20dfcf11ba7204">&#9670;&nbsp;</a></span>setChannelsNumeric()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -329,7 +332,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae392521121275dbe7f3d3e80
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">void setChannelsNumeric </td>
+          <td class="memname">bool setChannelsNumeric </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"><em>channels</em></td><td>)</td>
@@ -345,8 +348,8 @@ <h2 class="memtitle"><span class="permalink"><a href="#ae392521121275dbe7f3d3e80
 
 </div>
 </div>
-<a id="ad7fff9aeffbd30c2bf93c8c597b2ede6"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ad7fff9aeffbd30c2bf93c8c597b2ede6">&#9670;&nbsp;</a></span>setRateNumeric()</h2>
+<a id="af946880eb3f7403e06e3d1646acdad27"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af946880eb3f7403e06e3d1646acdad27">&#9670;&nbsp;</a></span>setRateNumeric()</h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -358,7 +361,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad7fff9aeffbd30c2bf93c8c5
           <td class="memname">int setRateNumeric </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
-          <td class="paramname"><em>rateNum</em></td><td>)</td>
+          <td class="paramname"><em>requestedRate</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
@@ -369,7 +372,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ad7fff9aeffbd30c2bf93c8c5
 </table>
 </div><div class="memdoc">
 
-<p>sets the sample rate as number </p>
+<p>sets the sample rate as number: returns the effectively set rate </p>
 
 </div>
 </div>

docs/html/classaudio__driver_1_1_codec_config-members.html

@@ -71,10 +71,10 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 : <a class="el" href="classaudio__driver_1_1_driver_pins.html#acb8bdb3920517d33a7556b621c2a3ee6">DriverPins</a>
 </li>
 <li>setBitsNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#a2cf0779e606be31b752e7cec8c184a9e">CodecConfig</a>
 </li>
 <li>setChannelsNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#a3c32c7aaa80dc2060c20dfcf11ba7204">CodecConfig</a>
 </li>
 <li>setConfig()
 : <a class="el" href="classaudio__driver_1_1_audio_board.html#aca4a2167d50991b8142ba909d65cb42d">AudioBoard</a>
@@ -141,7 +141,7 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 , <a class="el" href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">AudioDriver</a>
 </li>
 <li>setRateNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#af946880eb3f7403e06e3d1646acdad27">CodecConfig</a>
 </li>
 <li>setSPI()
 : <a class="el" href="classaudio__driver_1_1_driver_pins.html#ab33faa4563eb42152aad851515ab71c6">DriverPins</a>

docs/html/classaudio__driver_1_1_codec_config.html

@@ -85,10 +85,10 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 , <a class="el" href="structaudio__driver_1_1_pins_s_p_i.html#afcc542ba9c5c0e2fbba65a0feab74508">PinsSPI</a>
 </li>
 <li>setBitsNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#a7755035109f6cf777b72e1d24af59ffc">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#a2cf0779e606be31b752e7cec8c184a9e">CodecConfig</a>
 </li>
 <li>setChannelsNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#ae392521121275dbe7f3d3e805a638793">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#a3c32c7aaa80dc2060c20dfcf11ba7204">CodecConfig</a>
 </li>
 <li>setConfig()
 : <a class="el" href="classaudio__driver_1_1_audio_board.html#aca4a2167d50991b8142ba909d65cb42d">AudioBoard</a>
@@ -155,7 +155,7 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 , <a class="el" href="classaudio__driver_1_1_audio_driver.html#a1b3ee72f65915dcb4c875835d6e08aa1">AudioDriver</a>
 </li>
 <li>setRateNumeric()
-: <a class="el" href="classaudio__driver_1_1_codec_config.html#ad7fff9aeffbd30c2bf93c8c597b2ede6">CodecConfig</a>
+: <a class="el" href="classaudio__driver_1_1_codec_config.html#af946880eb3f7403e06e3d1646acdad27">CodecConfig</a>
 </li>
 <li>setSPI()
 : <a class="el" href="classaudio__driver_1_1_driver_pins.html#ab33faa4563eb42152aad851515ab71c6">DriverPins</a>