audio_service_platform_interface 0.0.1

ryanheise · Jun 26, 2021 · 2a73ee1 · 2a73ee1
1 parent ec95a57
commit 2a73ee1
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/audio_service_platform_interface/CHANGELOG.md b/audio_service_platform_interface/CHANGELOG.md
@@ -0,0 +1,3 @@
+## 0.0.1
+
+* Initial release.
diff --git a/audio_service_platform_interface/lib/audio_service_platform_interface.dart b/audio_service_platform_interface/lib/audio_service_platform_interface.dart
@@ -9,6 +9,7 @@ import 'package:plugin_platform_interface/plugin_platform_interface.dart';
 
 import 'method_channel_audio_service.dart';
 
+/// The interface each platform implementation must implement.
 abstract class AudioServicePlatform extends PlatformInterface {
   /// Constructs an AudioServicePlatform.
   AudioServicePlatform() : super(token: _token);
@@ -176,7 +177,7 @@ abstract class AudioHandlerCallbacks {
   /// Handle the notification being swiped away (Android).
   Future<void> onNotificationDeleted(OnNotificationDeletedRequest request);
 
-  // TODO: implement
+  /// Handle the notification being clicked (Android).
   Future<void> onNotificationClicked(OnNotificationClickedRequest request);
 
   /// Get the children of a parent media item.
@@ -222,7 +223,11 @@ enum AudioProcessingStateMessage {
   error,
 }
 
-/// The actons associated with playing audio.
+/// The actions associated with playing audio. The index of each enum value from
+/// [stop] up to [setShuffleMode] is guaranteed to match the bit index of each
+/// `ACTION_*` constant in Android's `PlaybackStateCompat` class. Enum values
+/// after this are iOS/macOS specific and their indices may shift if new Android
+/// media actions are added in the future.
 enum MediaActionMessage {
   stop,
   pause,
@@ -243,9 +248,15 @@ enum MediaActionMessage {
   prepareFromSearch,
   prepareFromUri,
   setRepeatMode,
-  unused_1,
-  unused_2,
+
+  /// This Android media action is deprecated. [setShuffleMode] should be used
+  /// instead.
+  _setShuffleModeEnabled,
+  setCaptioningEnabled,
   setShuffleMode,
+
+  // -- iOS/macOS-specific actions --
+
   seekBackward,
   seekForward,
 }

diff --git a/audio_service_platform_interface/lib/method_channel_audio_service.dart b/audio_service_platform_interface/lib/method_channel_audio_service.dart
@@ -1,6 +1,5 @@
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
-import 'package:flutter_test/flutter_test.dart';
 import 'audio_service_platform_interface.dart';
 
 class MethodChannelAudioService extends AudioServicePlatform {

diff --git a/audio_service_platform_interface/pubspec.yaml b/audio_service_platform_interface/pubspec.yaml
@@ -3,12 +3,13 @@ description: A common platform interface for the audio_service plugin. Different
 homepage: https://github.com/ryanheise/audio_service/tree/master/audio_service_platform_interface
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 1.0.0
+version: 0.0.1
 
 dependencies:
   flutter:
     sdk: flutter
   plugin_platform_interface: ^2.0.0
+  meta: ^1.3.0
 
 dev_dependencies:
   flutter_test: