Demos/AudioInput/AudioInput.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Audio Input Device Demo
   8  *
   9  *  Audio demonstration application. This gives a simple reference
  10  *  application for implementing a USB Audio Input device using the
  11  *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
  12  *  required).
  13  *
  14  *  On startup the system will automatically enumerate and function
  15  *  as a USB microphone. Incomming audio from the ADC channel 1 will
  16  *  be sampled and sent to the host computer.
  17  *
  18  *  To use, connect a microphone to the ADC channel 2.
  19  *
  20  *  Under Windows, if a driver request dialogue pops up, select the option
  21  *  to automatically install the appropriate drivers.
  22  *
  23  *
  24  *  <table>
  25  *   <tr>
  26  *    <td><b>USB Mode:</b></td>
  27  *    <td>Device</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Class:</b></td>
  31  *    <td>Audio Class</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>USB Subclass:</b></td>
  35  *    <td>Standard Audio Device</td>
  36  *   </tr>
  37  *   <tr>
  38  *    <td><b>Relevant Standards:</b></td>
  39  *    <td>USBIF Audio Class Specification</td>
  40  *    <td>USBIF Audio Class Terminal Types Specification</td>
  41  *    <td>USBIF Audio Data Formats Specification</td>
  42  *   </tr>
  43  *   <tr>
  44  *    <td><b>Usable Speeds:</b></td>
  45  *    <td>Full Speed Mode</td>
  46  *   </tr>
  47  *  </table>
  48  */