]> git.gir.st - tmk_keyboard.git/blob - tmk_core/protocol/lufa/LUFA-git/Demos/Host/ClassDriver/AudioOutputHost/AudioOutputHost.txt
Merge commit '22b6e15a179031afb7c3534cf7b109b0668b602c'
[tmk_keyboard.git] / tmk_core / protocol / lufa / LUFA-git / Demos / Host / ClassDriver / AudioOutputHost / AudioOutputHost.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 Output Host Demo
8 *
9 * \section Sec_Compat Demo Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this demo.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 *
15 * \section Sec_Info USB Information:
16 *
17 * The following table gives a rundown of the USB utilization of this demo.
18 *
19 * <table>
20 * <tr>
21 * <td><b>USB Mode:</b></td>
22 * <td>Host</td>
23 * </tr>
24 * <tr>
25 * <td><b>USB Class:</b></td>
26 * <td>Audio Class</td>
27 * </tr>
28 * <tr>
29 * <td><b>USB Subclass:</b></td>
30 * <td>Standard Audio Device</td>
31 * </tr>
32 * <tr>
33 * <td><b>Relevant Standards:</b></td>
34 * <td>USBIF Audio 1.0 Class Specification \n
35 * USBIF Audio 1.0 Class Terminal Types Specification \n
36 * USBIF Audio 1.0 Data Formats Specification</td>
37 * </tr>
38 * <tr>
39 * <td><b>Supported USB Speeds:</b></td>
40 * <td>Full Speed Mode</td>
41 * </tr>
42 * </table>
43 *
44 * \section Sec_Description Project Description:
45 *
46 * Audio Output host demonstration application. This gives a simple reference
47 * application for implementing a USB Audio host, for USB Audio devices using
48 * the USB Audio 1.0 class profile.
49 *
50 * By default, the demo will produce a square wave test tone when the board
51 * button is pressed. If USE_TEST_TONE is not defined in the project makefile,
52 * incoming audio from the ADC channel 1 will be sampled and sent to the attached
53 * USB audio device instead.
54 *
55 * \section Sec_Options Project Options
56 *
57 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
58 *
59 * <table>
60 * <tr>
61 * <th><b>Define Name:</b></th>
62 * <th><b>Location:</b></th>
63 * <th><b>Description:</b></th>
64 * </tr>
65 * <tr>
66 * <td>MIC_IN_ADC_CHANNEL</td>
67 * <td>AppConfig.h</td>
68 * <td>Sets the ADC channel used by the demo for the input audio samples from an attached microphone.</td>
69 * </tr>
70 * <tr>
71 * <td>USE_TEST_TONE</td>
72 * <td>AppConfig.h</td>
73 * <td>When defined, this alters the demo to produce a square wave test tone when the first board button is pressed
74 * instead of sampling the board microphone.</td>
75 * </tr>
76 * <tr>
77 * <td>MICROPHONE_BIASED_TO_HALF_RAIL</td>
78 * <td>AppConfig.h</td>
79 * <td>When defined, this alters the demo so that the half VCC bias of the microphone input is subtracted.</td>
80 * </tr>
81 * </table>
82 */
83
Imprint / Impressum