feat!: event channel

getting_started.md

@@ -160,7 +160,7 @@ Normally you want to use `.mediaPlayer` unless you care about performance and yo
 You can globally control the amount of log messages that are emitted by this package:
 
 ```dart
-  await AudioPlayer.global.changeLogLevel(LogLevel.info);
+  AudioPlayer.logger.logLevel = LogLevel.info;
 ```
 
 You can pick one of 3 options:
@@ -173,6 +173,25 @@ You can pick one of 3 options:
 
 **Note**: despite our best efforts, some native SDK implementations that we use spam a lot of log messages that we currently haven't figured out how to conform to this configuration (specially noticeable on Android). If you would like to contribute with a PR, they are more than welcome!
 
+### Log handler
+
+The log events are handled by default via `AudioPlayer.logger.log()`.
+You can customize the behavior of player log events.
+
+```dart
+  player.setLogHandler((log) {
+    AudioPlayer.logger.log(log.level, log.message);
+  });
+```
+
+Or change the behavior of global log events.
+
+```dart
+  AudioPlayer.setGlobalLogHandler((log) {
+    AudioPlayer.logger.log(log.level, log.message);
+  });
+```
+
 ## Audio Context
 
 An Audio Context is a (mostly mobile-specific) set of secondary, platform-specific aspects of audio playback, typically related to how the act of playing audio interacts with other features of the device. In most cases, you do not need to change this.
@@ -241,7 +260,7 @@ This Event is called when the audio finishes playing; it's used in the loop meth
 It does not fire when you interrupt the audio with pause or stop.
 
 ```dart
-  player.onPlayerComplete.listen((event) {
+  player.onPlayerComplete.listen((_) {
     onComplete();
     setState(() {
       position = duration;

packages/audioplayers/example/integration_test/lib_test.dart

@@ -1,8 +1,7 @@
-import 'dart:io';
+import 'dart:async';
 
 import 'package:audioplayers/audioplayers.dart';
 import 'package:audioplayers_example/tabs/sources.dart';
-import 'package:flutter/foundation.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
 
@@ -14,52 +13,52 @@ void main() {
 
   IntegrationTestWidgetsFlutterBinding.ensureInitialized();
 
-  group('play multiple sources', () {
-    final audioTestDataList = [
-      if (features.hasUrlSource)
-        LibSourceTestData(
-          source: UrlSource(wavUrl1),
-          duration: const Duration(milliseconds: 451),
-        ),
-      if (features.hasUrlSource)
-        LibSourceTestData(
-          source: UrlSource(wavUrl2),
-          duration: const Duration(seconds: 1, milliseconds: 068),
-        ),
-      if (features.hasUrlSource)
-        LibSourceTestData(
-          source: UrlSource(mp3Url1),
-          duration: const Duration(minutes: 3, seconds: 30, milliseconds: 77),
-        ),
-      if (features.hasUrlSource)
-        LibSourceTestData(
-          source: UrlSource(mp3Url2),
-          duration: const Duration(minutes: 1, seconds: 34, milliseconds: 119),
-        ),
-      if (features.hasUrlSource && features.hasPlaylistSourceType)
-        LibSourceTestData(
-          source: UrlSource(m3u8StreamUrl),
-          duration: Duration.zero,
-          isLiveStream: true,
-        ),
-      if (features.hasUrlSource)
-        LibSourceTestData(
-          source: UrlSource(mpgaStreamUrl),
-          duration: Duration.zero,
-          isLiveStream: true,
-        ),
-      if (features.hasAssetSource)
-        LibSourceTestData(
-          source: AssetSource(asset1),
-          duration: const Duration(seconds: 1, milliseconds: 068),
-        ),
-      if (features.hasAssetSource)
-        LibSourceTestData(
-          source: AssetSource(asset2),
-          duration: const Duration(minutes: 1, seconds: 34, milliseconds: 119),
-        ),
-    ];
+  final audioTestDataList = [
+    if (features.hasUrlSource)
+      LibSourceTestData(
+        source: UrlSource(wavUrl1),
+        duration: const Duration(milliseconds: 451),
+      ),
+    if (features.hasUrlSource)
+      LibSourceTestData(
+        source: UrlSource(wavUrl2),
+        duration: const Duration(seconds: 1, milliseconds: 068),
+      ),
+    if (features.hasUrlSource)
+      LibSourceTestData(
+        source: UrlSource(mp3Url1),
+        duration: const Duration(minutes: 3, seconds: 30, milliseconds: 77),
+      ),
+    if (features.hasUrlSource)
+      LibSourceTestData(
+        source: UrlSource(mp3Url2),
+        duration: const Duration(minutes: 1, seconds: 34, milliseconds: 119),
+      ),
+    if (features.hasUrlSource && features.hasPlaylistSourceType)
+      LibSourceTestData(
+        source: UrlSource(m3u8StreamUrl),
+        duration: Duration.zero,
+        isLiveStream: true,
+      ),
+    if (features.hasUrlSource)
+      LibSourceTestData(
+        source: UrlSource(mpgaStreamUrl),
+        duration: Duration.zero,
+        isLiveStream: true,
+      ),
+    if (features.hasAssetSource)
+      LibSourceTestData(
+        source: AssetSource(asset1),
+        duration: const Duration(seconds: 1, milliseconds: 068),
+      ),
+    if (features.hasAssetSource)
+      LibSourceTestData(
+        source: AssetSource(asset2),
+        duration: const Duration(minutes: 1, seconds: 34, milliseconds: 119),
+      ),
+  ];
 
+  group('play multiple sources', () {
     testWidgets(
       'play multiple sources simultaneously',
       (WidgetTester tester) async {
@@ -88,7 +87,7 @@ void main() {
       // FIXME: Causes media error on Android (see #1333, #1353)
       // Unexpected platform error: MediaPlayer error with
       // what:MEDIA_ERROR_UNKNOWN {what:1} extra:MEDIA_ERROR_SYSTEM
-      skip: !kIsWeb && Platform.isAndroid,
+      // skip: !kIsWeb && Platform.isAndroid,
     );
 
     testWidgets('play multiple sources consecutively',
@@ -111,4 +110,16 @@ void main() {
       }
     });
   });
+
+  group('Logging', () {
+    testWidgets('Platforms show INFO log, when start playing', (tester) async {
+      final completer = Completer<Log>();
+      final player = AudioPlayer();
+      player.setLogHandler(completer.complete);
+      await player.play(audioTestDataList[0].source);
+      final log = await completer.future;
+      expect(log.level, LogLevel.info);
+      expect(log.message, 'RESUME');
+    });
+  });
 }

packages/audioplayers/example/integration_test/platform_features.dart

@@ -20,6 +20,7 @@ class PlatformFeatures {
   static const androidPlatformFeatures = PlatformFeatures(
     hasRecordingActive: false,
     hasBalance: false,
+    hasMp2SourceType: false,
   );
 
   static const iosPlatformFeatures = PlatformFeatures(
@@ -75,6 +76,7 @@ class PlatformFeatures {
   final bool hasBytesSource;
 
   final bool hasPlaylistSourceType;
+  final bool hasMp2SourceType;
 
   final bool hasLowLatency;
   final bool hasReleaseModeRelease;
@@ -101,6 +103,7 @@ class PlatformFeatures {
     this.hasAssetSource = true,
     this.hasBytesSource = true,
     this.hasPlaylistSourceType = true,
+    this.hasMp2SourceType = true,
     this.hasLowLatency = true,
     this.hasReleaseModeRelease = true,
     this.hasReleaseModeLoop = true,

packages/audioplayers/example/lib/main.dart

@@ -122,7 +122,7 @@ class _ExampleAppState extends State<ExampleApp> {
                 TabData(
                   key: 'loggerTab',
                   label: 'Log',
-                  content: const LoggerTab(),
+                  content: LoggerTab(player: selectedPlayer),
                 ),
               ],
             ),

packages/audioplayers/example/lib/tabs/logger.dart

@@ -1,38 +1,140 @@
 import 'package:audioplayers/audioplayers.dart';
 import 'package:audioplayers_example/components/btn.dart';
-import 'package:audioplayers_example/components/tab_wrapper.dart';
 import 'package:flutter/material.dart';
 
 class LoggerTab extends StatefulWidget {
-  const LoggerTab({super.key});
+  final AudioPlayer player;
+
+  const LoggerTab({super.key, required this.player});
 
   @override
   _LoggerTabState createState() => _LoggerTabState();
 }
 
-class _LoggerTabState extends State<LoggerTab> {
-  static GlobalPlatformInterface get _logger => AudioPlayer.global;
+class _LoggerTabState extends State<LoggerTab>
+    with AutomaticKeepAliveClientMixin<LoggerTab> {
+  static Logger get _logger => AudioPlayer.logger;
+
+  LogLevel currentLogLevel = LogLevel.info;
+
+  List<Log> logs = [];
+  List<Log> globalLogs = [];
+
+  @override
+  void initState() {
+    super.initState();
+    _logger.logLevel = currentLogLevel;
+    AudioPlayer.setGlobalLogHandler((log) {
+      if (log.level.toInt() <= currentLogLevel.toInt()) {
+        _logger.log(log.level, log.message);
+        setState(() {
+          globalLogs.add(log);
+        });
+      }
+    });
+    widget.player.setLogHandler((log) {
+      if (log.level.toInt() <= currentLogLevel.toInt()) {
+        final msg = '${log.message}\nSource: ${widget.player.source}';
+        _logger.log(log.level, msg);
+        setState(() {
+          logs.add(Log(msg, level: log.level));
+        });
+      }
+    });
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    super.build(context);
+    return Padding(
+      padding: const EdgeInsets.all(16),
+      child: Column(
+        children: [
+          Text('Log Level: $currentLogLevel'),
+          Row(
+            mainAxisAlignment: MainAxisAlignment.spaceEvenly,
+            children: LogLevel.values
+                .map(
+                  (level) => Btn(
+                    txt: level.toString().replaceAll('LogLevel.', ''),
+                    onPressed: () {
+                      _logger.logLevel = level;
+                      setState(() => currentLogLevel = _logger.logLevel);
+                    },
+                  ),
+                )
+                .toList(),
+          ),
+          const Divider(color: Colors.black),
+          Expanded(
+            child: LogView(
+              title: 'Player Logs:',
+              logs: logs,
+              onDelete: () => setState(() {
+                logs.clear();
+              }),
+            ),
+          ),
+          const Divider(color: Colors.black),
+          Expanded(
+            child: LogView(
+              title: 'Global Logs:',
+              logs: globalLogs,
+              onDelete: () => setState(() {
+                globalLogs.clear();
+              }),
+            ),
+          ),
+        ],
+      ),
+    );
+  }
+
+  @override
+  bool get wantKeepAlive => true;
+}
+
+class LogView extends StatelessWidget {
+  final String title;
+  final List<Log> logs;
+  final VoidCallback onDelete;
 
-  LogLevel currentLogLevel = _logger.logLevel;
+  const LogView({
+    super.key,
+    required this.logs,
+    required this.title,
+    required this.onDelete,
+  });
 
   @override
   Widget build(BuildContext context) {
-    return TabWrapper(
+    return Column(
       children: [
-        Text('Log Level: $currentLogLevel'),
         Row(
-          mainAxisAlignment: MainAxisAlignment.spaceEvenly,
-          children: LogLevel.values
-              .map(
-                (e) => Btn(
-                  txt: e.toString().replaceAll('LogLevel.', ''),
-                  onPressed: () async {
-                    await _logger.changeLogLevel(e);
-                    setState(() => currentLogLevel = _logger.logLevel);
-                  },
-                ),
-              )
-              .toList(),
+          mainAxisAlignment: MainAxisAlignment.spaceBetween,
+          children: [
+            Text(title),
+            IconButton(onPressed: onDelete, icon: const Icon(Icons.delete))
+          ],
+        ),
+        Expanded(
+          child: ListView(
+            children: logs
+                .map(
+                  (log) => Column(
+                    children: [
+                      SelectableText(
+                        '${log.level.toString()}: ${log.message}',
+                        style: log.level == LogLevel.error
+                            ? const TextStyle(color: Colors.red)
+                            : null,
+                      ),
+                      Divider(color: Colors.grey.shade400)
+                    ],
+                  ),
+                )
+                .toList(),
+          ),
         ),
       ],
     );

packages/audioplayers_platform_interface/test/logger_test.dart → packages/audioplayers/example/test/logger_test.dart

@@ -1,7 +1,6 @@
 import 'dart:async';
 
-import 'package:audioplayers_platform_interface/api/log_level.dart';
-import 'package:audioplayers_platform_interface/logger_platform_interface.dart';
+import 'package:audioplayers_platform_interface/api/log.dart';
 import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
 
@@ -16,7 +15,6 @@ void main() {
   });
 
   final _print = OverridePrint();
-  final _logger = GlobalPlatformInterface.instance;
 
   group('Logger', () {
     setUp(_print.clear);