X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/6a7c298c0f7119e44e18de15d714cd8b938e3bef..b9b03aadb219d06fbad9d110e508db93e45461af:/Demos/Device/ClassDriver/AudioInput/AudioInput.txt

diff --git a/Demos/Device/ClassDriver/AudioInput/AudioInput.txt b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
new file mode 100644
index 000000000..cf7125949
--- /dev/null
+++ b/Demos/Device/ClassDriver/AudioInput/AudioInput.txt
@@ -0,0 +1,75 @@
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+ 
+/** \mainpage Audio Input Device Demo
+ *
+ *  \section SSec_Info USB Information:
+ *
+ *  The following table gives a rundown of the USB utilization of this demo.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>USB Mode:</b></td>
+ *    <td>Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Class:</b></td>
+ *    <td>Audio Class</td>
+ *   </tr>
+ *   <tr> 
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Standard Audio Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF Audio Class Specification</td>
+ *    <td>USBIF Audio Class Terminal Types Specification</td>
+ *    <td>USBIF Audio Data Formats Specification</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section SSec_Description Project Description: 
+ *
+ *  Audio demonstration application. This gives a simple reference
+ *  application for implementing a USB Audio Input device using the
+ *  basic USB Audio drivers in all modern OSes (i.e. no special drivers
+ *  required).
+ *  
+ *  On start-up the system will automatically enumerate and function
+ *  as a USB microphone. Incoming audio from the ADC channel 1 will
+ *  be sampled and sent to the host computer.
+ *  
+ *  To use, connect a microphone to the ADC channel 2.
+ *  
+ *  Under Windows, if a driver request dialogue pops up, select the option
+ *  to automatically install the appropriate drivers.
+ *
+ *  \section SSec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>Define Name:</b></td>
+ *    <td><b>Location:</b></td>
+ *    <td><b>Description:</b></td>
+ *   </tr>
+ *   <tr>
+ *    <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
+ *    <td>Makefile CDEFS</td>
+ *    <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
+ *   </tr>
+ *   <tr>
+ *    <td>AUDIO_SAMPLE_FREQUENCY</td>
+ *    <td>Descriptors.h</td>
+ *    <td>Gives the audio sample rate per channel for the audio stream, in Hz.</td>
+ *   </tr>
+ *  </table>
+ */