Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

esp_audio_codec Component Needs Examples, Not Test Code (AUD-5967) #1339

Open
gamename opened this issue Dec 31, 2024 · 1 comment
Open

esp_audio_codec Component Needs Examples, Not Test Code (AUD-5967) #1339

gamename opened this issue Dec 31, 2024 · 1 comment
Labels
Type: New Feature New feature or request

Comments

@gamename
Copy link

Is your feature request related to a problem? Please describe.
Yes, it is related to a problem. Was trying to create a simple audio playback of an embedded m4a file. So, I went to the component registry and downloaded the official codec.

There are no examples for correct use. There are only tests. After much struggle, I did manage to get working code. However, the test code is so tightly coupled with the application, it is extremely difficult to separate test code from application code.

It would have been much simpler if there were concrete examples instead of "just look at the tests". This was extremely frustrating and (more importantly) time consuming.

Describe the solution you'd like
It would be great if there were simple examples showing how to use the component. Again, not test code, example code.

Describe alternatives you've considered
I tried various other audio support facilities like minimp3, but I would rather use the "official" components.

Additional context

I would like to mention that @TempoTian was extremely helpful in getting my app to work. But again, the code is riddled with test scaffolding and therefore not very clean/concise.

@github-actions github-actions bot changed the title esp_audio_codec Component Needs Examples, Not Test Code esp_audio_codec Component Needs Examples, Not Test Code (AUD-5967) Dec 31, 2024
@jason-mao
Copy link
Collaborator

@gamename Yes, I found that it is not ideal for demonstrating the codec API. We will add some examples for it.

@jason-mao jason-mao added Type: New Feature New feature or request and removed Type: New Feature New feature or request labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: New Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants