README.rst
1.. zephyr:code-sample:: usb-audio-headset
2 :name: USB Audio headset
3 :relevant-api: _usb_device_core_api
4
5 Implement a USB Audio headset device with audio IN/OUT loopback.
6
7Overview
8********
9
10This sample app demonstrates use of a USB Audio driver by the Zephyr
11project. This very simple sample that performs loopback over IN/OUT
12ISO endpoints. The device will show up as single audio device.
13
14Building and Running
15********************
16
17In order to build the sample an overlay file with required options
18must be provided. By default app.overlay is added. An overlay contains
19software and hardware specific information which allow to fully
20describe the device.
21
22After you have built and flashed the sample app image to your board, plug the
23board into a host device.
24
25Testing
26*******
27
28Steps to test the sample:
29
30- Build and flash the sample as described above.
31- Connect to the HOST.
32- Chose default Audio IN/OUT.
33- Start streaming audio (for example by playing an audio file on the HOST).
34- Start recording audio stream (for example using Audacity).
35- Verify the recorded audio stream.
36
37This sample can be found under
38:zephyr_file:`samples/subsys/usb/audio/headset` in the Zephyr project tree.
39
