summaryrefslogtreecommitdiff
path: root/digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt
diff options
context:
space:
mode:
Diffstat (limited to 'digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt')
-rw-r--r--digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt48
1 files changed, 48 insertions, 0 deletions
diff --git a/digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt b/digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt
new file mode 100644
index 00000000..09b77f7e
--- /dev/null
+++ b/digital/avr/modules/usb/lufa/Demos/AudioInput/AudioInput.txt
@@ -0,0 +1,48 @@
+/** \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
+ *
+ * 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 startup the system will automatically enumerate and function
+ * as a USB microphone. Incomming 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.
+ *
+ *
+ * <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>
+ */ \ No newline at end of file