Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 6.34 KB

troubleshooting.md

File metadata and controls

72 lines (43 loc) · 6.34 KB
Raw

This file describes some common pitfalls and how to solve them. Please always refer to this before opening an issue.

Both platforms

Asset not available/not found when playing local files

Flutter requires that files are specified on your pubspec.yaml file, under flutter > assets, check this for an example. Also keep in mind that AudioCache class will look for files under the assets folder and this class must be used to play local files.

Error when playing remote URL

The remote URL must be accessible and not be a redirect. If it's not an audio file, it does a redirect, it requires some headers, cookies or authentication, it will not work. Please bundle the file on the app or host it somewhere that properly provides the file. If you are having issues with playing audio from an URL, please first download the file and try running it locally. If the issue persists, then open the issue, including the file so we can test. Otherwise, it's an issue with your URL, not audioplayers.

How to pause/stop audio?

The basic class of this package is the AudioPlayer class, which represents a single player playing a single audio, and it has methods pause and stop and resume to be used as you wish.

If you are using the AudioCache class, though, it does not have a pause method because that class generates new audio players every time you play, in order to allow for simultaneously playing. So the play or loop methods on that class returns the instance of AudioPlayer created, and you can save that to a variable and call pause/stop/resume on that instead. There is also a mode where AudioCache uses the same, fixedPlayer, but that is also returned in the method. Please take a look at the docs and source code for the AudioCache class for more details. Also, cf. this stack overflow question.

Build issues

Warning: If you are having any sort of build issues, please read this first.

Our CI builds our example app using audioplayers for Android, iOS and web. So if the build is passing, any build errors (from android/ios sdk, gradle, java, kotlin, cocoa pods, swift, flutter, etc) is not a global issue and likely is something on your setup.

Before opening an issue, you must try these steps:

  1. Run this on your project and try again:
flutter clean
rm -rf build
rm -rf ~/.pub-cache

flutter pub get
  1. If the issue persists, clone the audioplayers repo and run the example app on the platform you are having issues. If it works, then there is something wrong with your project, and you can compare it to the example app to see what the problem is.
  2. If the problem still persists, and no existing (open or closed) issue on this repo, no stack overflow question or existing discord discussion solves you problem, then you can open an issue. But you must follow the issue template, and refer to the problem on the example app (or start with its code and make only the necessary modifications to trigger the issue), not on your own app that we don't have access (because since step 2 the error must be reproducible on the example app).
  3. Again, only open an issue if you reached step 3 and follow the issue template closely. Build issues that do not follow these steps will be warned and closed.

Android

  • Can't play remote files on Android 9: Android 9 has changed some network security defaults, so it may prevent you from play files outside https by default, this stackoverflow question is a good source to solving this.

  • Some old Samsung devices have a bug that prevents certain types of audio from being played, see more here.

  • minSdkVersion: we only support SDK version 23 or up.

Supporting bellow API 23 was turning the maintenance of the package quite complicated. We looked on many sources before increasing the min version; for example, as you can see here, uses of SDK 16 and below are from less than 1% of users.

Currently, we don't plan on decreasing minSdkVersion to less than 23. Jelly Bean (SDK 16) was launched almost 10 years ago. Using such an old piece of software can in of itself lead to many performance and security issues and bugs. Please update your devices' android version to at least 23, and you will be able to enjoy audioplayers without any issues :)

iOs

  • Project does not compile with plugin: First check your xcode version, for some unknow reason compilation seens to fail when using older versions of xcode. Also, always try to compile the example app of this plugin, we try to keep the example app always updated and working, so if you can't compile it, the problem may be on your xcode version/configuration.

  • Audio doens't keep playing on the background: Apparently there is a required configuration for that to happen on your app, you add the following lines to your info.plist:

 <key>UIBackgroundModes</key>
 <array>
 	<string>audio</string>
 </array>

Or on XCode you can add it as a capability; more details here.

  • Can't play stream audio: One of the know reasons for streams not playing on iOs, may be because the stream is been gziped by the server, as reported here.

macOS

  • Project does not compile with plugin: First check your xcode version, for some unknow reason compilation seens to fail when using older versions of xcode. Also, always try to compile the example app of this plugin, we try to keep the example app always updated and working, so if you can't compile it, the problem may be on your xcode version/configuration.

  • Can't play stream audio: One of the reasons for streams not playing on macOS, may be because the stream is been gziped by the server, as reported here.