zephyr

History

Johann Fischer fca499100d samples: usb-audio: add app.overlay and remove board specific overlays USB audio class samples are generic and can be built for any board that supports USB device and isochronous endpoints. Add app.overlay that uses aliases and remove board specific overlays. Note: USB audio is still experimental and even though the sample can be built for specific platform, it does not mean that it can be run on it without issues. Fixes: #25313 Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>		2021-05-21 18:16:25 -04:00
..
src	samples: tests: Fix usb.audio.headset test	2021-02-11 13:57:31 -05:00
app.overlay	samples: usb-audio: add app.overlay and remove board specific overlays	2021-05-21 18:16:25 -04:00
CMakeLists.txt
prj.conf
README.rst
sample.yaml	samples: usb-audio: add app.overlay and remove board specific overlays	2021-05-21 18:16:25 -04:00

README.rst

.. _usb_audio_headset:

USB Audio Sample Application
############################

Overview
********

This sample app demonstrates use of a USB Audio driver by the Zephyr
project. This very simple sample that performs loopback over IN/OUT
ISO endpoints. The device will show up as single audio device.

Building and Running
********************

In order to build the sample an overlay file with required options
must be provided. By default app.overlay is added. An overlay contains
software and hardware specific information which allow to fully
describe the device.

After you have built and flashed the sample app image to your board, plug the
board into a host device.

Testing
*******

Steps to test the sample:
- Build and flash the sample as described above.
- Connect to the HOST.
- Chose default Audio IN/OUT.
- Start streaming audio (for example by playing an audio file on the HOST).
- Start recording audio stream (for example using Audacity).
- Verify the recorded audio stream.

This sample can be found under
:zephyr_file:`samples/subsys/usb/audio/headset` in the Zephyr project tree.