diff options
Diffstat (limited to 'Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt')
-rw-r--r-- | Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt b/Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt new file mode 100644 index 0000000000..0736e0df47 --- /dev/null +++ b/Demos/Host/ClassDriver/AudioInputHost/AudioInputHost.txt @@ -0,0 +1,66 @@ +/** \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 Host Demo + * + * \section Sec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * \li Series 7 USB AVRs (AT90USBxxx7) + * + * \section Sec_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>Host</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 1.0 Class Specification \n + * USBIF Audio 1.0 Class Terminal Types Specification \n + * USBIF Audio 1.0 Data Formats Specification</td> + * </tr> + * <tr> + * <td><b>Supported USB Speeds:</b></td> + * <td>Full Speed Mode</td> + * </tr> + * </table> + * + * \section Sec_Description Project Description: + * + * Audio Input host demonstration application. This gives a simple reference + * application for implementing a USB Audio host, for USB Audio devices using + * the USB Audio 1.0 class profile. + * + * Incoming audio will output in 8-bit PWM onto the timer 3 output compare + * channel A, and will also be indicated on the board LEDs. Decouple the PWM + * output with a capacitor and attach to a speaker to hear the audio. + * + * \section Sec_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> + * None + * </td> + * </tr> + * </table> + */ + |