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

docs: more descriptive codes and information in Getting Started tutorial for AudioCache #1256

Closed
1 task done
Hallcoder opened this issue Aug 28, 2022 · 6 comments · Fixed by #1457
Closed
1 task done
Labels

Comments

@Hallcoder
Copy link

Hallcoder commented Aug 28, 2022

Checklist

  • I made sure that the feature I am proposing doesn't already exist

Use case / Problem

Proposal / Solution

Example Code
void main() {
}

Platforms

Affected Platforms:

Audio Files/URLs/Sources (optional)

Mockups (optional)

More information (optional)

@spydon
Copy link
Member

spydon commented Sep 5, 2022

Can you be a bit more descriptive, what is it that you think is missing from the getting started page? And does that information exist in the example app?

@Hallcoder
Copy link
Author

Hallcoder commented Sep 5, 2022 via email

@spydon
Copy link
Member

spydon commented Sep 6, 2022

I think that it is pretty clearly explained here that you need the audio cache when working with local files?
https://github.com/bluefireteam/audioplayers/blob/main/getting_started.md#audiocache

In order to play Local Assets, you must use the AudioCache class. AudioCache is not available for Flutter Web.

Flutter does not provide an easy way to play audio on your assets, but this class helps a lot. It actually copies the asset to a temporary folder in the device, where it is then played as a Local File.

It works as a cache because it keeps track of the copied files so that you can replay them without delay.

@Gustl22
Copy link
Collaborator

Gustl22 commented Sep 27, 2022

I agree it could be a bit more clear, for which sources you need to use the AudioCache, and what it cannot do. In fact it is only relevant for AssetSource. Or better link to the migration guide, where it's documented more detailed.

@Gustl22 Gustl22 added the docs Concerning the documentation label Sep 27, 2022
@Gustl22 Gustl22 changed the title Improve the Getting Started tutorial with more descriptive codes and information docs: more descriptive codes and information in Getting Started tutorial for AudioCache Sep 27, 2022
@gadishimwe
Copy link

Hi @Gustl22,
Why can't the use of AudioCache from the Getting Started tutorial be removed or rephrased as it's mentioned here in the Migration guide that it's dead and normally shouldn't be used by end users?
Because in the tutorial, it sounds like we must use it for local files("In order to play Local Assets, you must use the AudioCache class") which I think is misleading. Thanks

@Gustl22
Copy link
Collaborator

Gustl22 commented Mar 19, 2023

Yes, it is misleading, this could be adapted. Even web uses the AudioCache class, but differently ...

Gustl22 added a commit that referenced this issue Apr 5, 2023
… READMEs (#1457)

# Description

* update AudioCache explanation (closes #1256)
* replace package README.md symlinks with files, and switched main
README file to `audioplayers` package (#1433,
dart-lang/pub#2699)
* update migration guide to use Changelog
* update contribution guide
* update parity table
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants