https://github.com/rxlabz/audioplayer

A flutter plugin to play audio files iOS / Android / MacOS / Web ( Swift/Java )
https://github.com/rxlabz/audioplayer

android audio-player dartlang flutter flutter-plugin

Last synced: 3 months ago
JSON representation

A flutter plugin to play audio files iOS / Android / MacOS / Web ( Swift/Java )

• Host: GitHub
• URL: https://github.com/rxlabz/audioplayer
• Owner: rxlabz
• Archived: true
• Created: 2017-05-25T11:20:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-13T22:02:32.000Z (almost 2 years ago)
• Last Synced: 2024-09-25T19:18:56.309Z (3 months ago)
• Topics: android, audio-player, dartlang, flutter, flutter-plugin
• Language: Dart
• Homepage: https://pub.dartlang.org/packages/audioplayer
• Size: 12.6 MB
• Stars: 494
• Watchers: 17
• Forks: 189
• Open Issues: 103
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :warning: DEPRECATED

Check out 

- [audioplayers](https://pub.dev/packages/audioplayers)

- [just_audio](https://pub.dev/packages/just_audio)

___ 

# AudioPlayer

A Flutter audio plugin (Swift/Java) to play remote or local audio files on iOS / Android / MacOS and Web.

[Online demo](https://rxlabz.github.io/audioplayer/)

## Features

- [x] Android / iOS / MacOS / Web

  - [x] play remote file 

  - [x] play local file ( not for the web)  

  - [x] stop

  - [x] pause

  - [x] onComplete

  - [x] onDuration / onCurrentPosition

  - [x] seek

  - [x] mute

![screenshot](https://rxlabz.github.io/audioplayer/audioplayer.png)

## Usage

[Example](https://github.com/rxlabz/audioplayer/blob/master/example/lib/main.dart)

To use this plugin :

- Add the dependency to your [pubspec.yaml](https://github.com/rxlabz/audioplayer/blob/master/example/pubspec.yaml) file.

```yaml

  dependencies:

    flutter:

      sdk: flutter

    audioplayer: 0.8.1

    audioplayer_web: 0.7.1

```

- Instantiate an AudioPlayer instance

```dart

//...

AudioPlayer audioPlugin = AudioPlayer();

//...

```

### Player Controls

```dart

audioPlayer.play(url);

audioPlayer.pause();

audioPlayer.stop();

```

### Status and current position

The dart part of the plugin listen for platform calls :

```dart

//...

_positionSubscription = audioPlayer.onAudioPositionChanged.listen(

  (p) => setState(() => position = p)

);

_audioPlayerStateSubscription = audioPlayer.onPlayerStateChanged.listen((s) {

  if (s == AudioPlayerState.PLAYING) {

    setState(() => duration = audioPlayer.duration);

  } else if (s == AudioPlayerState.STOPPED) {

    onComplete();

    setState(() {

      position = duration;

    });

  }

}, onError: (msg) {

  setState(() {

    playerState = PlayerState.stopped;

    duration = new Duration(seconds: 0);

    position = new Duration(seconds: 0);

  });

});

```

Do not forget to cancel all the subscriptions when the widget is disposed.

## iOS

### :warning: iOS App Transport Security

By default iOS forbids loading from non-https url. To cancel this restriction edit your .plist and add :

```xml

NSAppTransportSecurity

    NSAllowsArbitraryLoads

    

```

### Background mode

cf. [enable background audio](https://developer.apple.com/documentation/avfoundation/media_assets_playback_and_editing/creating_a_basic_video_player_ios_and_tvos/enabling_background_audio)

## MacOS

Add this to entitlements files ( cf. [DebugProfile.entitlements](example/macos/Runner/DebugProfile.entitlements) )

```xml

    com.apple.security.network.client

    

```

cf. [Flutter MacOS security](https://github.com/google/flutter-desktop-embedding/blob/master/macOS-Security.md)

## Troubleshooting

- If you get a MissingPluginException, try to `flutter build apk` on Android, or `flutter build ios`

## Getting Started with Flutter

For help getting started with Flutter, view our online

[documentation](http://flutter.io/).

For help on editing plugin code, view the [documentation](https://flutter.io/platform-plugins/#edit-code).