feat!: event channel #1352

Gustl22 · 2022-12-22T22:34:01Z

Description

Replace Platform Method Channels (platform -> lib) with Event Channels
Combined Event stream for player (PlayerEvent) and global (GlobalEvent) events
Add methods create, dispose and getEventStream to AudioplayersPlatformInterface
Add method getGlobalEventStream to GlobalAudioplayersPlatformInterface
Add log stream player.onLog() and AudioPlayer.global.onLog()
Example for using Logger
Throw PlatformException on Method Error via Method Channel (lib -> platform)
Emit PlatformException on Event Error via Event Channel (platform -> lib) player.eventStream.listen().onError() and AudioPlayer.global.eventStream.listen().onError()
Add docs

Checklist

The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs:, chore: etc).
I have read the Contributor Guide and followed the process outlined for submitting PRs.
I have updated/added tests for ALL new/updated/fixed functionality.
I have updated/added relevant documentation and added dartdoc comments with ///, where necessary.
I have updated/added relevant examples in example.

Breaking Change

Yes, this is a breaking change.
No, this is not a breaking change.

Migration instructions

audioplayers:

Before	After
deprecated `AudioPlayer.global.changeLogLevel(LogLevel.info)`	`Logger.logLevel = LogLevel.info`
deprecated `AudioPlayer.global.logLevel`	`Logger.logLevel`
deprecated `AudioPlayer.global.log()`	`Logger.log()` or `Logger.error()`
deprecated `AudioPlayer.global.info()`	`Logger.log()`
deprecated `AudioPlayer.global.error()`	`Logger.error()`
`ForPlayer<>`	removed

audioplayers_platform_interface:

Before	After
`LogLevel`	moved to `audioplayers` package
`StreamsInterface`	removed
`ForPlayer<>`	removed

Related Issues

Closes #106
Closes #151
Closes #1266
Can handle error of #1260
Related to #208 and #933, but cannot hide Android MediaPlayer logs

This would bypass: flutter/flutter#69103

…stream

...s/audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/WrappedPlayer.kt

Gustl22 · 2023-01-01T18:43:00Z

@luanpotter @spydon we could also think about unifying the logger and the error stream and handle the logging on the dart side to gain more control. But don't know if it would hit on performance, but I don't think so...

Gustl22 · 2023-01-08T19:49:26Z

@luanpotter @spydon I unified the error and the logs in a single stream, or more specific: a stream for each player and a global stream to log stuff outside of player scope.

I just implemented it for Android, but wanted you to review before rewriting the other platforms. Thank you in advance for your feedback.

spydon · 2023-01-08T20:04:29Z

@luanpotter @spydon I unified the error and the logs in a single stream, or more specific: a stream for each player and a global stream to log stuff outside of player scope.

I just implemented it for Android, but wanted you to review before rewriting the other platforms. Thank you in advance for your feedback.

Looks like a great improvement to me! I have too little knowledge about any potential downsides to do a proper review, but I'm sure Luan will chime in.

Gustl22 · 2023-01-09T10:59:25Z

packages/audioplayers/lib/src/audioplayer.dart

+    _onLogStreamSubscription = _onLog.listen(logHandler);
+  }
+
+  static void setGlobalLogHandler(void Function(Log log)? logHandler) {


I'm also considering to handle both streams in the Logger class and then be able to set only one logging handler in there, which would make it easier to handle all logs at once and would allow the preprocessing by the log level. Downside is, that you cannot differentiate between player logs and global logs anymore.

Now I solved it by exposing the log stream (per player and global), but also allow the user to disable logs/errors via Logger.logLevel. The log level now is not attached to the AudioPlayer anymore, as it can/should handle logs / errors from anywhere (like global ones, too).

…stream # Conflicts: # packages/audioplayers/example/test/logger_test.dart # packages/audioplayers_platform_interface/lib/global_platform_interface.dart # packages/audioplayers_platform_interface/lib/method_channel_audioplayers_platform.dart

Gustl22 · 2023-03-24T11:39:40Z

I think the work is done now. I tried to split independent changes as Merge Requests beforehand, but this still is a bulky Merge Request. As I'm definitely no expert in C / C++ and Swift, it would be nice if someone can have a look into these. Or if having any concerns elsewhere in these changes.

luanpotter · 2023-04-03T01:25:17Z

packages/audioplayers/example/pubspec.yaml

@@ -4,6 +4,7 @@ publish_to: none

 dependencies:
  audioplayers: ^3.0.1
+  audioplayers_platform_interface: ^4.0.0


should the main audioplayers package expose anything that users my want to access? I think no one should have to depend on platform_interface directly

You're right. I decided to test the integration tests of audioplayers_platform_interface (which weren't present before) alos in the audioplayers package, to avoid having and maintaining two example apps. So therefore this dependency is listed here (not relevant for the actual example app). But I changed it to a dev dependency now.

packages/audioplayers/lib/src/audioplayer.dart

packages/audioplayers/lib/src/log_level.dart

luanpotter · 2023-04-03T01:32:08Z

...audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/SoundPoolPlayer.kt

@@ -219,10 +223,10 @@ class SoundPoolManager {
                    .setAudioAttributes(attrs)
                    .setMaxStreams(maxStreams)
                    .build()
-                Logger.info("Create SoundPool with $attrs")
+                ref.handleGlobalLog("Create SoundPool with $attrs")


should this call the player-specific log?

Creating a SoundPool is a global action in my opinion, as it can be used by multiple players. Although it is initiated by one of these. (And it would be a bit quirky to bring in the player scope in this area, as the specific player is not available here)

gotcha, agreed. forgot the soundpool was shared

packages/audioplayers_platform_interface/lib/src/api/global_event.dart

luanpotter · 2023-04-03T01:38:12Z

packages/audioplayers_platform_interface/test/util.dart

+}
+
+// See: https://github.com/flutter/packages/blob/12609a2abbb0a30b9d32af7b73599bfc834e609e/packages/video_player/video_player_android/test/android_video_player_test.dart#L270
+void createNativeEventStream({


for a followup: between this, MapParser/MethodCall extensions, OverridePrint, and more, there seems to be a lot of generic testing utils that could be extracted to their own package.
I think I could use them on gamepads for example.

Ah nice, didn't noticed you started this lib 🎉 Sure, if it's more practical. Feel free to move any generic testing stuff :)

luanpotter

Excellent refactor @Gustl22 🚀 👏 ❤️

spydon

Great job! Would be good to add a paragraph to the migration doc so that the user knows what changes they have to do to migrate from the previous version.

packages/audioplayers/lib/src/global_audio_scope.dart

packages/audioplayers/lib/src/log_level.dart

Gustl22 · 2023-04-03T09:54:30Z

Great job! Would be good to add a paragraph to the migration doc so that the user knows what changes they have to do to migrate from the previous version.

I would also do this in a separate MR, as it concerns the version migration and not this specific MR, where the relevant steps are in the description. The migration also includes other MR like #1443

I also wonder how you handle migration in flame. Maybe the Changelog is sufficient. At least we have to make more sections in the migration guide for the different versions. But maybe that's overengineered. Or we have to ditch stuff from the migration from v0 to v1. Whats are your proposals @spydon @luanpotter ? Thank you :D

spydon · 2023-04-03T10:01:32Z

I would also do this in a separate MR, as it concerns the version migration and not this specific MR, where the relevant steps are in the description. The migration also includes other MR like #1443

I also wonder how you handle migration in flame. Maybe the Changelog is sufficient. At least we have to make more sections in the migration guide for the different versions. But maybe that's overengineered.

In Flame we have the migration instructions in the bottom of the version in the changelog, so we could do the same here, and maybe mention that in the existing migration doc?

# Description - Upgrade min Dart to v2.7.0 - Upgrade min Flutter to v3.0.0 - Adapt some code to new Dart features ## Related Issues #1352

# Description As some of the classes introduced in #1352 are quite generic and could conflict with other packages, we should rename them to be more specific to the package: - Refactor `GlobalEvent` to `GlobalAudioEvent` - Refactor `PlayerEvent` to `AudioEvent` - Refactor `Logger` to `AudioLogger` - Refactor `LogLevel` to `AudioLogLevel` PlayerEvent was renamed to have the same scheme as `GlobalAudioEvent` and so that it is more applicable to Audio and not to all players in general (e.g. media or video player). ## Breaking Change This is a breaking change regarding the current master channel, but not the published versions. **audioplayers** | Before | After | |---|---| | `GlobalEvent` | `GlobalAudioEvent` | | `PlayerEvent` | `AudioEvent` | | `Logger` | `AudioLogger` | | `LogLevel` | `AudioLogLevel` | **audioplayers_platform_interface** | Before | After | |---|---| | `GlobalEvent` | `GlobalAudioEvent` | | `PlayerEvent` | `AudioEvent` | ## Related Issues #1352

# Description Closes #1453. ### Migration instructions See #1352 and #1443

feat: error stream (#1266)

4a1380a

Gustl22 mentioned this pull request Dec 23, 2022

tests: library tests to play multiple sources #1333

Merged

8 tasks

Gustl22 added 4 commits December 25, 2022 08:04

Merge branch 'main' into gustl22/1266-error-stream

e5e1a1c

fix(android): forward errors from event stream to avoid crashing (#1260)

f7efbc8

Merge remote-tracking branch 'upstream/main' into gustl22/1266-error-…

63126f0

…stream

tests(android): add simultaneously lib tests (#1353)

2252dbc

luanpotter reviewed Dec 31, 2022

View reviewed changes

...s/audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/WrappedPlayer.kt Outdated Show resolved Hide resolved

luanpotter reviewed Dec 31, 2022

View reviewed changes

...s/audioplayers_android/android/src/main/kotlin/xyz/luan/audioplayers/player/WrappedPlayer.kt Show resolved Hide resolved

luanpotter mentioned this pull request Dec 31, 2022

fix: [Discussion] Add try-catch to avoid IllegalStateException when calling player.isPlaying on Android media player #1365

Closed

7 tasks

Gustl22 added 3 commits January 1, 2023 19:33

feat(android): print stacktrace

4cd51f0

Merge branch 'main' into gustl22/1266-error-stream

ea3ecfc

feat: add mp2 record

d1b71c7

Gustl22 added 8 commits January 2, 2023 14:56

feat: logs as stream

d553054

feat: hashMapOf

a63407b

feat: global log

b95728c

feat: global log

71a4597

feat: SoundPoolWrapper

f19b7fa

feat: colorized logs

0c41e60

test: onResume log test

061b5f8

docs: edit docs for log

3a5dbeb

Gustl22 changed the title ~~feat: error stream (#1266)~~ feat!: log stream (#1266) Jan 8, 2023

fix: optional playerId

821a669

Gustl22 commented Jan 9, 2023

View reviewed changes

Gustl22 mentioned this pull request Jan 11, 2023

Audio not playing on iOS device #1330

Open

2 tasks

Gustl22 added 3 commits January 16, 2023 16:08

feat: mutable soundPoolWrapper

40b38ca

feat(android): configurable AudioContext in LOW_LATENCY mode

294e0ba

Gustl22 requested a review from wolfenrain March 24, 2023 11:35

renancaraujo approved these changes Mar 24, 2023

View reviewed changes

luanpotter reviewed Apr 3, 2023

View reviewed changes

packages/audioplayers/lib/src/audioplayer.dart Outdated Show resolved Hide resolved

luanpotter reviewed Apr 3, 2023

View reviewed changes

packages/audioplayers/lib/src/log_level.dart Outdated Show resolved Hide resolved

luanpotter reviewed Apr 3, 2023

View reviewed changes

packages/audioplayers_platform_interface/lib/src/api/global_event.dart Outdated Show resolved Hide resolved

luanpotter reviewed Apr 3, 2023

View reviewed changes

luanpotter approved these changes Apr 3, 2023

View reviewed changes

Gustl22 added 4 commits April 3, 2023 08:17

chore: make audioplayers_platform_interface a dev dependency

b97bf5e

feat: make create method private

56bde56

feat: throw on invalid lovLevel value in fromInt

6e436ec

docs: adapt wrong logMessage docs

12241dc

spydon approved these changes Apr 3, 2023

View reviewed changes

packages/audioplayers/lib/src/global_audio_scope.dart Outdated Show resolved Hide resolved

packages/audioplayers/lib/src/log_level.dart Show resolved Hide resolved

chore: add deprecation notice vor v5.0.0

c632015

dart format .

c9d8609

Gustl22 mentioned this pull request Apr 3, 2023

Remove deprecated methods in v5.0.0 #1453

Closed

1 task

feat: improve deprecation line breaking

1b34fb0

Gustl22 mentioned this pull request Apr 3, 2023

chore: Upgrade minimum Dart & Flutter versions #1454

Merged

7 tasks

Gustl22 merged commit c9fd6a7 into main Apr 4, 2023
7 checks passed

Gustl22 deleted the gustl22/1266-error-stream branch April 4, 2023 10:06

Gustl22 added a commit that referenced this pull request Apr 4, 2023

chore: Upgrade minimum Dart & Flutter versions (#1454)

8babb0e

# Description - Upgrade min Dart to v2.7.0 - Upgrade min Flutter to v3.0.0 - Adapt some code to new Dart features ## Related Issues #1352

Gustl22 mentioned this pull request Apr 7, 2023

refactor!: prevent from confusing and conflicting class names #1465

Merged

7 tasks

Gustl22 mentioned this pull request Jun 28, 2023

tests: Linux pumps don't work with async GStreamer operations #1556

Open

2 tasks

Gustl22 mentioned this pull request Jul 25, 2023

refactor!: Remove deprecated methods #1583

Merged

7 tasks

Gustl22 added a commit that referenced this pull request Aug 16, 2023

refactor!: Remove deprecated methods (#1583)

8d0cbed

# Description Closes #1453. ### Migration instructions See #1352 and #1443

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: event channel #1352

feat!: event channel #1352

Gustl22 commented Dec 22, 2022 •

edited

Gustl22 commented Jan 1, 2023 •

edited

Gustl22 commented Jan 8, 2023 •

edited

spydon commented Jan 8, 2023

Gustl22 Jan 9, 2023

Gustl22 Mar 16, 2023 •

edited

Gustl22 commented Mar 24, 2023

luanpotter Apr 3, 2023

Gustl22 Apr 3, 2023

luanpotter Apr 3, 2023

Gustl22 Apr 3, 2023 •

edited

luanpotter Apr 3, 2023

luanpotter Apr 3, 2023

Gustl22 Apr 3, 2023

luanpotter left a comment

spydon left a comment

Gustl22 commented Apr 3, 2023 •

edited

spydon commented Apr 3, 2023

feat!: event channel #1352

feat!: event channel #1352

Conversation

Gustl22 commented Dec 22, 2022 • edited

Description

Checklist

Breaking Change

Migration instructions

Related Issues

Gustl22 commented Jan 1, 2023 • edited

Gustl22 commented Jan 8, 2023 • edited

spydon commented Jan 8, 2023

Gustl22 Jan 9, 2023

Choose a reason for hiding this comment

Gustl22 Mar 16, 2023 • edited

Choose a reason for hiding this comment

Gustl22 commented Mar 24, 2023

luanpotter Apr 3, 2023

Choose a reason for hiding this comment

Gustl22 Apr 3, 2023

Choose a reason for hiding this comment

luanpotter Apr 3, 2023

Choose a reason for hiding this comment

Gustl22 Apr 3, 2023 • edited

Choose a reason for hiding this comment

luanpotter Apr 3, 2023

Choose a reason for hiding this comment

luanpotter Apr 3, 2023

Choose a reason for hiding this comment

Gustl22 Apr 3, 2023

Choose a reason for hiding this comment

luanpotter left a comment

Choose a reason for hiding this comment

spydon left a comment

Choose a reason for hiding this comment

Gustl22 commented Apr 3, 2023 • edited

spydon commented Apr 3, 2023

Gustl22 commented Dec 22, 2022 •

edited

Gustl22 commented Jan 1, 2023 •

edited

Gustl22 commented Jan 8, 2023 •

edited

Gustl22 Mar 16, 2023 •

edited

Gustl22 Apr 3, 2023 •

edited

Gustl22 commented Apr 3, 2023 •

edited