improved vlc controller events & callbacks code (#216)

* updated vlc event handling code

* fix vlc error description

* renamed error const strings

* fixed a minor bug

* Avoid FlutterVlcPlayerFactory new instances onAttachedToActivity (#214)

* Avoid FlutterVlcPlayerFactory new instances onAttachedToActivity

* Avoid FlutterVlcPlayerFactory instances in registerWith

* fix error description docs

* Added onInit & onRenderer listeners

* updated docs

mark onInit & onRendererHandler as deprecated.

* updated documentation

* fix initialization value of renderer variables

Co-authored-by: Guillermo Jeremy De La Cruz Onton <[email protected]>

Author: alr2413

flutter_vlc_player/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 6.0.2
+* Fix issue with vlc error event
+* Added onInit & onRenderer listeners
+Credits to Alireza Setayesh (https://github.com/alr2413) and solid-vovabeloded (https://github.com/solid-vovabeloded).
+
 ## 6.0.1
 * Fix issue with black screen / offstage
 Credits to Mitch Ross (https://github.com/mitchross)

flutter_vlc_player/android/src/main/java/software/solid/fluttervlcplayer/FlutterVlcPlayer.java

@@ -50,8 +50,8 @@ final class FlutterVlcPlayer implements PlatformView {
     //
     private LibVLC libVLC;
     private MediaPlayer mediaPlayer;
-    private List<RendererDiscoverer> rendererDiscoverers;
-    private List<RendererItem> rendererItems;
+    private List<RendererDiscoverer> rendererDiscoverers = new ArrayList<>();;
+    private List<RendererItem> rendererItems = new ArrayList<>();;
     private boolean isDisposed = false;
 
     // Platform view

flutter_vlc_player/example/lib/controls_overlay.dart

@@ -22,7 +22,7 @@ class ControlsOverlay extends StatelessWidget {
       reverseDuration: Duration(milliseconds: 200),
       child: Builder(
         builder: (ctx) {
-          if (controller.value.isEnded) {
+          if (controller.value.isEnded || controller.value.hasError) {
             return Center(
               child: FittedBox(
                 child: IconButton(

flutter_vlc_player/example/lib/multiple_tab.dart

@@ -28,7 +28,6 @@ class _MultipleTabState extends State<MultipleTab> {
         urls[i],
         hwAcc: HwAcc.FULL,
         autoPlay: false,
-        onInit: () async {},
         options: VlcPlayerOptions(
           advanced: VlcAdvancedOptions([
             VlcAdvancedOptions.networkCaching(2000),

flutter_vlc_player/example/lib/single_tab.dart

@@ -82,12 +82,6 @@ class _SingleTabState extends State<SingleTab> {
         _controller = VlcPlayerController.network(
           initVideo.path,
           hwAcc: HwAcc.FULL,
-          onInit: () async {
-            await _controller.startRendererScanning();
-          },
-          onRendererHandler: (type, id, name) {
-            print('onRendererHandler $type $id $name');
-          },
           options: VlcPlayerOptions(
             advanced: VlcAdvancedOptions([
               VlcAdvancedOptions.networkCaching(2000),
@@ -110,27 +104,21 @@ class _SingleTabState extends State<SingleTab> {
         var file = File(initVideo.path);
         _controller = VlcPlayerController.file(
           file,
-          onInit: () async {
-            await _controller.startRendererScanning();
-          },
-          onRendererHandler: (type, id, name) {
-            print('onRendererHandler $type $id $name');
-          },
         );
         break;
       case VideoType.asset:
         _controller = VlcPlayerController.asset(
           initVideo.path,
-          onInit: () async {
-            await _controller.startRendererScanning();
-          },
-          onRendererHandler: (type, id, name) {
-            print('onRendererHandler $type $id $name');
-          },
           options: VlcPlayerOptions(),
         );
         break;
     }
+    _controller.addOnInitListener(() async {
+      await _controller.startRendererScanning();
+    });
+    _controller.addOnRendererEventListener((type, id, name) {
+      print('OnRendererEventListener $type $id $name');
+    });
   }
 
   @override
@@ -186,8 +174,10 @@ class _SingleTabState extends State<SingleTab> {
               onTap: () async {
                 switch (video.type) {
                   case VideoType.network:
-                    await _controller.setMediaFromNetwork(video.path,
-                        hwAcc: HwAcc.FULL);
+                    await _controller.setMediaFromNetwork(
+                      video.path,
+                      hwAcc: HwAcc.FULL,
+                    );
                     break;
                   case VideoType.file:
                     ScaffoldMessenger.of(context).showSnackBar(

flutter_vlc_player/lib/src/vlc_player_controller.dart

@@ -35,8 +35,10 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
     this.hwAcc = HwAcc.AUTO,
     this.autoPlay = true,
     this.options,
-    VoidCallback? onInit,
-    RendererCallback? onRendererHandler,
+    @Deprecated('Please, use the addOnInitListener method instead.')
+        VoidCallback? onInit,
+    @Deprecated('Please, use the addOnRendererEventListener method instead.')
+        RendererCallback? onRendererHandler,
   })  : _dataSourceType = DataSourceType.asset,
         _onInit = onInit,
         _onRendererHandler = onRendererHandler,
@@ -53,8 +55,10 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
     this.hwAcc = HwAcc.AUTO,
     this.autoPlay = true,
     this.options,
-    VoidCallback? onInit,
-    RendererCallback? onRendererHandler,
+    @Deprecated('Please, use the addOnInitListener method instead.')
+        VoidCallback? onInit,
+    @Deprecated('Please, use the addOnRendererEventListener method instead.')
+        RendererCallback? onRendererHandler,
   })  : package = null,
         _dataSourceType = DataSourceType.network,
         _onInit = onInit,
@@ -71,8 +75,10 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
     this.hwAcc = HwAcc.AUTO,
     this.autoPlay = true,
     this.options,
-    VoidCallback? onInit,
-    RendererCallback? onRendererHandler,
+    @Deprecated('Please, use the addOnInitListener method instead.')
+        VoidCallback? onInit,
+    @Deprecated('Please, use the addOnRendererEventListener method instead.')
+        RendererCallback? onRendererHandler,
   })  : dataSource = 'file://${file.path}',
         package = null,
         _dataSourceType = DataSourceType.file,
@@ -97,6 +103,19 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
   /// Initialize vlc player when the platform is ready automatically
   final bool autoInitialize;
 
+  /// This is a callback that will be executed once the platform view has been initialized.
+  /// If you want the media to play as soon as the platform view has initialized, you could just call
+  /// [VlcPlayerController.play] in this callback. (see the example).
+  ///
+  /// This member is deprecated, please, use the [addOnInitListener] method instead.
+  final VoidCallback? _onInit;
+
+  /// This is a callback that will be executed every time a new renderer cast device attached/detached
+  /// It should be defined as "void Function(VlcRendererEventType, String, String)", where the VlcRendererEventType is an enum { attached, detached } and the next two String arguments are unique-id and name of renderer device, respectively.
+  ///
+  /// This member is deprecated, please, use the [addOnRendererEventListener] method instead.
+  final RendererCallback? _onRendererHandler;
+
   /// Only set for [asset] videos. The package that the asset was loaded from.
   String? package;
 
@@ -117,19 +136,36 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
   /// The viewId for this controller
   late int _viewId;
 
-  /// This is a callback that will be executed once the platform view has been initialized.
-  /// If you want the media to play as soon as the platform view has initialized, you could just call
-  /// [VlcPlayerController.play] in this callback. (see the example)
-  final _onInit;
+  /// List of onInit listeners
+  final List<VoidCallback> _onInitListeners = [];
 
-  /// This is a callback that will be executed every time a new renderer cast device attached/detached
-  /// It should be defined as "void Function(VlcRendererEventType, String, String)", where the VlcRendererEventType is an enum { attached, detached } and the next two String arguments are unique-id and name of renderer device, respectively.
-  final _onRendererHandler;
+  /// List of onRenderer listeners
+  final List<RendererCallback> _onRendererEventListeners = [];
 
   bool _isDisposed = false;
 
   VlcAppLifeCycleObserver? _lifeCycleObserver;
 
+  /// Register a [VoidCallback] closure to be called when the controller gets initialized
+  void addOnInitListener(VoidCallback listener) {
+    _onInitListeners.add(listener);
+  }
+
+  /// Remove a previously registered closure from the list of onInit closures
+  void removeOnInitListener(VoidCallback listener) {
+    _onInitListeners.remove(listener);
+  }
+
+  /// Register a [RendererCallback] closure to be called when a cast renderer device gets attached/detached
+  void addOnRendererEventListener(RendererCallback listener) {
+    _onRendererEventListeners.add(listener);
+  }
+
+  /// Remove a previously registered closure from the list of OnRendererEvent closures
+  void removeOnRendererEventListener(RendererCallback listener) {
+    _onRendererEventListeners.remove(listener);
+  }
+
   /// Attempts to open the given [url] and load metadata about the video.
   Future<void> initialize() async {
     if (_isDisposed) {
@@ -168,6 +204,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
             isBuffering: true,
             isEnded: false,
             playingState: PlayingState.buffering,
+            errorDescription: VlcPlayerValue.noError,
           );
           break;
 
@@ -201,6 +238,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
             activeAudioTrack: event.activeAudioTrack,
             spuTracksCount: event.spuTracksCount,
             activeSpuTrack: event.activeSpuTrack,
+            errorDescription: VlcPlayerValue.noError,
           );
           break;
 
@@ -218,6 +256,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
         case VlcMediaEventType.timeChanged:
           value = value.copyWith(
             isEnded: false,
+            isBuffering: event.mediaEventType == VlcMediaEventType.buffering,
             position: event.position,
             duration: event.duration,
             playbackSpeed: event.playbackSpeed,
@@ -231,6 +270,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
             playingState: (event.isPlaying ?? false)
                 ? PlayingState.playing
                 : value.playingState,
+            errorDescription: VlcPlayerValue.noError,
           );
           break;
 
@@ -243,6 +283,7 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
             isBuffering: false,
             isEnded: false,
             playingState: PlayingState.error,
+            errorDescription: VlcPlayerValue.unknownError,
           );
           break;
 
@@ -270,16 +311,12 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
       }
       switch (event.eventType) {
         case VlcRendererEventType.attached:
-          if (_onRendererHandler != null) {
-            _onRendererHandler(VlcRendererEventType.attached, event.rendererId,
-                event.rendererName);
-          }
-          break;
         case VlcRendererEventType.detached:
-          if (_onRendererHandler != null) {
-            _onRendererHandler(VlcRendererEventType.detached, event.rendererId,
-                event.rendererName);
-          }
+          _notifyOnRendererListeners(
+            event.eventType,
+            event.rendererId,
+            event.rendererName,
+          );
           break;
         case VlcRendererEventType.unknown:
           break;
@@ -297,24 +334,46 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
       playingState: PlayingState.initialized,
     );
 
-    if (_onInit != null) _onInit();
+    _notifyOnInitListeners();
 
     return initializingCompleter.future;
   }
 
+  /// Dispose controller
   @override
   Future<void> dispose() async {
     if (_isDisposed) {
       return;
     }
+    _onInitListeners.clear();
+    _onRendererEventListeners.clear();
     _lifeCycleObserver?.dispose();
     _isDisposed = true;
     super.dispose();
     //
-
     await vlcPlayerPlatform.dispose(_viewId);
   }
 
+  /// Notify onInit callback & all registered listeners
+  void _notifyOnInitListeners() {
+    if (_onInit != null) {
+      _onInit!();
+    }
+    _onInitListeners.forEach((listener) => listener());
+  }
+
+  /// Notify onRendererHandler callback & all registered listeners
+  void _notifyOnRendererListeners(
+    VlcRendererEventType type,
+    String? id,
+    String? name,
+  ) {
+    if (_onRendererHandler != null) {
+      _onRendererHandler!(type, id!, name!);
+    }
+    _onRendererEventListeners.forEach((listener) => listener(type, id!, name!));
+  }
+
   /// This stops playback and changes the data source. Once the new data source has been loaded, the playback state will revert to
   /// its state before the method was called. (i.e. if this method is called whilst media is playing, once the new
   /// data source has been loaded, the new stream will begin playing.)
@@ -799,18 +858,24 @@ class VlcPlayerController extends ValueNotifier<VlcPlayerValue> {
     return await vlcPlayerPlatform.takeSnapshot(_viewId);
   }
 
+  /// Get list of available renderer services which is supported by vlc library
+  Future<List<String>> getAvailableRendererServices() async {
+    _throwIfNotInitialized('getAvailableRendererServices');
+    return await vlcPlayerPlatform.getAvailableRendererServices(_viewId);
+  }
+
   /// Start vlc cast discovery to find external display devices (chromecast)
   /// By setting serviceName, the vlc discovers renderer with that service
   Future<void> startRendererScanning({String? rendererService}) async {
     _throwIfNotInitialized('startRendererScanning');
-    return await vlcPlayerPlatform.startRendererScanning(viewId!,
+    return await vlcPlayerPlatform.startRendererScanning(_viewId,
         rendererService: rendererService ?? '');
   }
 
   /// Stop vlc cast and scan
   Future<void> stopRendererScanning() async {
     _throwIfNotInitialized('stopRendererScanning');
-    return await vlcPlayerPlatform.stopRendererScanning(viewId!);
+    return await vlcPlayerPlatform.stopRendererScanning(_viewId);
   }
 
   /// Returns all detected renderer devices as array of <String, String>

flutter_vlc_player/lib/src/vlc_player_value.dart

@@ -7,6 +7,10 @@ import 'enums/playing_state.dart';
 /// The duration, current position, buffering state, error state and settings
 /// of a [VlcPlayerController].
 class VlcPlayerValue {
+  /// Define no error string
+  static const String noError = '';
+  static const String unknownError = 'An Unknown Error Occurred!';
+
   /// Constructs a video with the given values. Only [duration] is required. The
   /// rest will initialize with default values when unset.
   VlcPlayerValue({
@@ -31,7 +35,7 @@ class VlcPlayerValue {
     this.spuDelay = 0,
     this.videoTracksCount = 1,
     this.activeVideoTrack = 0,
-    this.errorDescription,
+    this.errorDescription = VlcPlayerValue.noError,
   });
 
   /// Returns an instance with a `null` [Duration].
@@ -49,7 +53,7 @@ class VlcPlayerValue {
       duration: Duration.zero,
       playingState: PlayingState.error,
       isInitialized: false,
-      errorDescription: errorDescription,
+      errorDescription: errorDescription ?? VlcPlayerValue.unknownError,
     );
   }
 
@@ -114,8 +118,8 @@ class VlcPlayerValue {
 
   /// A description of the error if present.
   ///
-  /// If [hasError] is false this is [null].
-  final String? errorDescription;
+  /// If [hasError] is false this is [VlcPlayerValue.noError].
+  final String errorDescription;
 
   /// The [size] of the currently loaded video.
   ///
@@ -127,7 +131,7 @@ class VlcPlayerValue {
 
   /// Indicates whether or not the video is in an error state. If this is true
   /// [errorDescription] should have information about the problem.
-  bool get hasError => errorDescription != null;
+  bool get hasError => errorDescription != VlcPlayerValue.noError;
 
   /// Returns [size.width] / [size.height] when the player is initialized, or `1.0.` when
   /// the player is not initialized or the aspect ratio would be less than or equal to 0.0.