AudioPlayers

Pub Build Status Discord Melos

A Flutter plugin to play multiple simultaneously audio files, works for Android, iOS, macOS, Windows and web.

Note: all the docs have been update to reflect the content for the v1 release (currently 1.0.0-rc.1). If you are looking for v0 specific information and guidance, please checkout the version of this repo before the first v0 change.

If you are interest in migrating to v1, please check our migration guide.

Help

If you have any problems, please follow these steps before opening an issue.

  1. Carefully read the Getting Started tutorial before anything else. Re-read if necessary.
  2. Check our Troubleshooting Guide for solutions for most problems.
  3. If you have a missing feature report or feature request, please first check the Feature Parity Table to understand our roadmap and what we know is missing. We love contributions!
  4. Join Blue Fire's Discord server and ask for directions. Maybe it's not a bug, or it's a known issue.
  5. If you are more comfortable with StackOverflow, you can also create a question there. Add the generic Flame tag, so that anyone following the tag can help out.
  6. If the issue still persists, go to the create an issue page and follow the step-by-step there before submitting.
  7. If the step-by-step there doesn't give you any help, then proceed to create the issue following the template. Do not skip mandatory sections. Do not include the literal text of the template, rather replace the sections with what they should contain.

Any issues created not following the list above can be flagged or closed by our team.

Contributing

All help is appreciated but if you have questions, bug reports, issues, feature requests, pull requests, etc, please first refer to our Contributing Guide.

Be sure to check the Feature Parity Table to understand if your suggestion is already tracked, on the roadmap, or out of scope for this project.

Also, as always, please give us a star to help!

Getting Started

We tried to make audioplayers as simple to use as possible.

Please follow our Getting Started tutorial for all high-level information you need to know.

Then, if you want to dig deeper, our code is very well documented with dartdocs, so check our API reference or the codebase itself on your IDE (or on GitHub).

If something is not clear on our docs, please send a PR to help us improve.

Support

The simplest way to show us your support is by giving the project a star.

You can also support us by becoming a patron on Patreon:

Patreon

Or by making a single donation by buying us a coffee:

Buy Me A Coffee

Note: this software was made by the community, for the community, on our spare time, with no commercial affiliation. It is provided as is and any positive contribution is appreciated. Be kind and mindful of the free time that a battalion of people has gifted on behalf of the community to craft and maintain this.

Feature Parity Table

Not all features are available on all platforms. Click here to see a table relating what features can be used on each target.

Feel free to use it for ideas for possible PRs and contributions you can help with on our roadmap! If you are submitting a PR, don't forget to update the table.

Credits

This was originally a fork of rxlabz's audioplayer, but since we have diverged and added more features.

Thanks for @rxlabz for the amazing work!

Libraries

audio_context_config
audioplayers_platform_interface
for_player
log_level
logger_platform_interface
method_channel_audioplayers_platform
method_channel_interface
player_mode
player_state
release_mode
streams_interface