Flutter Sound installation.

Installation

Install

For help on adding as a dependency, view the documentation.

SDK requirements

  • Flutter Sound requires an iOS 10.0 SDK (or later)
  • Flutter Sound requires an Android 21 (or later)

Flutter Sound flavors

Flutter Sound comes in two flavors :

  • the FULL flavor : flutter_sound
  • the LITE flavor : flutter_sound_lite

The big difference between the two flavors is that the LITE flavor does not have mobile_ffmpeg embedded inside. There is a huge impact on the memory used, but the LITE flavor will not be able to do :

  • Support some codecs like Playback OGG/OPUS on iOS or Record OGG_OPUS on iOS
  • Will not be able to offer some helping functions, like FlutterSoundHelper.FFmpegGetMediaInformation() or FlutterSoundHelper.duration()

Here are the size of example/demo1 iOS .ipa in Released Mode. Those numbers include everything (flutter library, application, …) and not only Flutter Sound.

Flavor V4.x V5.1
LITE 16.2 MB 17.8 MB
FULL 30.7 MB 32.1 MB

Linking your App directly from pub.dev

Add flutter_sound or flutter_sound_lite as a dependency in pubspec.yaml.

The actual versions are :

  • flutter_sound_lite: ^8.3.9 (the LTS version without FFmpeg)
  • flutter_sound: ^8.3.9 (the LTS version with FFmpeg embedded)
dependencies:
  flutter:
    sdk: flutter
  flutter_sound: ^8.3.9

or

dependencies:
  flutter:
    sdk: flutter
  flutter_sound_lite: ^8.3.9

Linking your App with Flutter Sound sources (optional)

The Flutter-Sound sources are here.

There is actually two branches :

  • V7. This is the last release which is not compliant with Dart Null Safety
  • master. This is the branch currently developed and is released under the version 8.x.x.

You probably want to look to the Dev notice If you want to generate your App from the sources with a FULL flavor:

cd some/where
git clone https://github.com/dooboolab/flutter_sound
cd some/where/flutter_sound
bin/reldev.sh DEV
bin/flavor FULL

and add your dependency in your pubspec.yaml :

dependencies:
  flutter:
    sdk: flutter
  flutter_sound:
    path: some/where/flutter_sound

If you prefer to link your App with the LITE flavor :

cd some/where
git clone https://github.com/dooboolab/flutter_sound
cd some/where/flutter_sound
bin/reldev.sh DEV
bin/flavor.sh LITE

and add your dependency in your pubspec.yaml :

dependencies:
  flutter:
    sdk: flutter
  flutter_sound_lite:
    path: some/where/flutter_sound

FFmpeg

flutter_sound FULL flavor makes use of a terrific plugin : Mobile FFmpeg. Your App can be built without any Flutter-FFmpeg dependency : Mobile FFmpeg full-lts is now automaticaly embedding inside the FULL flavor of Flutter Sound and Flutter Sound users do not have anything special to do.

Please refer to this notice

Your App can also use Flutter-FFmpeg for your own use. (Flutter-FFmpeg is a wrapper around Mobile FFmpeg).

If you want to use FFmpeg on the FULL flavor of Flutter Sound you do not have to link your App with the MobileFFmpeg library : this is already done by Flutter Sound. You just have to add your dependecy line into your pubspec.yaml.

Post Installation

  • On iOS you need to add usage descriptions to info.plist:

          <key>NSAppleMusicUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSCalendarsUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSCameraUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSContactsUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSLocationWhenInUseUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSMotionUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>NSSpeechRecognitionUsageDescription</key>
          <string>MyApp does not need this permission</string>
          <key>UIBackgroundModes</key>
          <array>
                  <string>audio</string>
          </array>
          <key>NSMicrophoneUsageDescription</key>
          <string>MyApp uses the microphone to record your speech and convert it to text.</string>
    

    If your App needs to play remote files you possibly must add :

         <key>NSAppTransportSecurity</key>
         <dict>
                 <key>NSAllowsArbitraryLoads</key>
                 <true/>
         </dict>
    
  • On Android you need to add a permission to AndroidManifest.xml:

    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
    

Flutter Web

To use Flutter Sound in a web application, you can either :

Static reference

Add those 4 lines at the end of the <head> section of your index.html file :

  <script src="assets/packages/flutter_sound_web/js/flutter_sound/flutter_sound.js"></script>
  <script src="assets/packages/flutter_sound_web/js/flutter_sound/flutter_sound_player.js"></script>
  <script src="assets/packages/flutter_sound_web/js/flutter_sound/flutter_sound_recorder.js"></script>
  <script src="assets/packages/flutter_sound_web/js/howler/howler.js"></script>

or Dynamic reference

Add those 4 lines at the end of the <head> section of your index.html file :

  <script src="https://cdn.jsdelivr.net/npm/tau_sound_core@8/js/flutter_sound/flutter_sound.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/tau_sound_core@8/js/flutter_sound/flutter_sound_player.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/tau_sound_core@8/js/flutter_sound/flutter_sound_recorder.min.js"></script>
  <script src="https://cdn.jsdelivr.net/npm/howler@2/dist/howler.min.js"></script>

Please read this to understand how you can specify the interval of the versions you are interested by.

Troubles shooting

Problem of the ios target version

You must put the following line on top of your Podfile :

platform :ios, '10.0'

(or a number higher)

Other problem with Cocoapods

If you get this message (specially after the release of a new Flutter Version) :

Cocoapods could not find compatible versions for pod ...

you can try the following instructions sequence (and ignore if some commands gives errors) :

cd ios
pod cache clean --all
rm Podfile.lock
rm -rf .symlinks/
cd ..
flutter clean
flutter pub get
cd ios
pod update
pod repo update
pod install --repo-update
pod update
pod install
cd ..

If everything good, the last pod install must not give any error.