README.rst
1.. zephyr:code-sample:: usb-audio-headset
2 :name: Legacy 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
14.. note::
15 This samples demonstrate deprecated :ref:`usb_device_stack`.
16
17Building and Running
18********************
19
20In order to build the sample an overlay file with required options
21must be provided. By default app.overlay is added. An overlay contains
22software and hardware specific information which allow to fully
23describe the device.
24
25After you have built and flashed the sample app image to your board, plug the
26board into a host device.
27
28Testing
29*******
30
31Steps to test the sample:
32
33- Build and flash the sample as described above.
34- Connect to the HOST.
35- Chose default Audio IN/OUT.
36- Start streaming audio (for example by playing an audio file on the HOST).
37- Start recording audio stream (for example using Audacity).
38- Verify the recorded audio stream.
39
40This sample can be found under
41:zephyr_file:`samples/subsys/usb/legacy/audio_headset` in the Zephyr project tree.
42