79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| app.overlay | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _usb_audio_headphones_microphone: 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 two audio devices. One Input (Microphone) and one Output (Headphones) 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/headphones_microphone` in the Zephyr project tree.