Documentation and API adjustments for I2S #309
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes a number of usability issues identified by https://github.com/kyrias around the I2S driver and fixes a bug in ESP-IDF around PDM mode stereo vs. mono mode on ESP-C3/-C6/-H2 devices.
I've added documentation around frame formats and adjusted the API around DMA buffering to reflect my now better understanding of what those parameters do.
This is #283 but rebased with the latest async fixes.