zephyr

History

Jordan Yates 8e99db5801 Kconfig: net: deprecate `NET_BUF_USER_DATA_LEN` As user data sizes are now set on a per pool basis, this Kconfig option has no purpose. Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>		2021-11-24 16:04:50 +02:00
..
src
app.overlay	samples: usb-audio: add app.overlay and use zephyr_udc0	2021-08-19 16:56:54 +02:00
CMakeLists.txt	cmake: use find_package() instead of literal include in tests and samples	2021-11-01 10:33:09 -04:00
prj.conf	Kconfig: net: deprecate `NET_BUF_USER_DATA_LEN`	2021-11-24 16:04:50 +02:00
README.rst
sample.yaml	samples: usb-audio: add app.overlay and use zephyr_udc0	2021-08-19 16:56:54 +02: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.