added player events

Author: swiftuiux

Sources/swiftui-loop-videoplayer/LoopPlayerView.swift

@@ -11,9 +11,11 @@ import Combine
 import AVKit
 #endif
 
+public protocol ILoopPlayerView: View {}
+
 /// Player view for running a video in loop
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
-public struct LoopPlayerView: View {    
+public struct LoopPlayerView: ILoopPlayerView{
 
     /// Set of settings for video the player
     @Binding public var settings: VideoSettings
@@ -24,8 +26,14 @@ public struct LoopPlayerView: View {
     /// The current playback time, represented as a Double.
     @State private var currentTime: Double = 0.0
 
-    /// A publisher that emits the current time as a Double value.
-    @State var timePublisher = PassthroughSubject<Double, Never>()
+    /// The current state of the player event,
+    @State private var playerEvent: PlayerEvent = .idle
+
+    /// A publisher that emits the current playback time as a `Double`. It is initialized privately within the view.
+    @State private var timePublisher = PassthroughSubject<Double, Never>()
+
+    /// A publisher that emits player events as `PlayerEvent` values. It is initialized privately within the view.
+    @State private var eventPublisher = PassthroughSubject<PlayerEvent, Never>()
 
     private var videoId : String{
         [settings.name, settings.ext].joined(separator: ".")
@@ -101,11 +109,20 @@ public struct LoopPlayerView: View {
     // MARK: - API
 
    public var body: some View {
-       LoopPlayerMultiPlatform(settings: $settings, command: $command, timePublisher: timePublisher)
+       LoopPlayerMultiPlatform(
+        settings: $settings,
+        command: $command,
+        timePublisher: timePublisher,
+        eventPublisher: eventPublisher
+       )
            .frame(maxWidth: .infinity, maxHeight: .infinity)
            .onReceive(timePublisher, perform: { time in
                currentTime = time
            })
+           .onReceive(eventPublisher, perform: { event in
+               playerEvent = event
+           })
            .preference(key: CurrentTimePreferenceKey.self, value: currentTime)
+           .preference(key: PlayerEventPreferenceKey.self, value: playerEvent)
    }
 }

Sources/swiftui-loop-videoplayer/enum/PlayerEvent.swift

@@ -0,0 +1,23 @@
+//
+//  PlayerEvents.swift
+//
+//
+//  Created by Igor  on 15.08.24.
+//
+
+import Foundation
+
+/// An enumeration representing various events that can occur within a media player.
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
+public enum PlayerEvent: Equatable {
+    
+    /// Represents a state where the player is idle.
+    case idle
+
+    /// Represents a seek action within the player.
+    /// - Parameters:
+    ///   - Bool: Indicates whether the seek was successful.
+    ///   - currentTime: The time (in seconds) to which the player is seeking.
+    case seek(Bool, currentTime: Double)
+    
+}

Sources/swiftui-loop-videoplayer/protocol/helpers/PlayerDelegateProtocol.swift

@@ -21,5 +21,15 @@ public protocol PlayerDelegateProtocol: AnyObject {
     @MainActor
     func didReceiveError(_ error: VPErrors)
 
-    func didPassedTime(seconds : Double)
+    /// A method that handles the passage of time in the player.
+    /// - Parameter seconds: The amount of time, in seconds, that has passed.
+    @MainActor
+    func didPassedTime(seconds: Double)
+
+    /// A method that handles seeking in the player.
+    /// - Parameters:
+    ///   - value: A Boolean indicating whether the seek was successful.
+    ///   - currentTime: The current time of the player after seeking, in seconds.
+    @MainActor
+    func didSeek(value: Bool, currentTime: Double)
 }

Sources/swiftui-loop-videoplayer/protocol/player/AbstractPlayer.swift

@@ -14,6 +14,9 @@ import CoreImage
 @MainActor @preconcurrency
 public protocol AbstractPlayer: AnyObject {
 
+    /// The delegate to be notified about errors encountered by the player.
+    var delegate: PlayerDelegateProtocol? { get set }
+    
     /// Retrieves the current item being played.
     var currentItem : AVPlayerItem? { get }
 
@@ -35,9 +38,6 @@ public protocol AbstractPlayer: AnyObject {
     /// The queue player that plays the video items.
     var player: AVQueuePlayer? { get set }
 
-    /// A Boolean value indicating whether the player is currently seeking to a new time.
-    var isSeeking : Bool { get set }
-    
     // Playback control methods
 
     /// Initiates or resumes playback of the video.
@@ -145,8 +145,6 @@ extension AbstractPlayer{
             return
         }
 
-        isSeeking = true
-        
         let endTime = CMTimeGetSeconds(duration)
         let seekTime : CMTime
 
@@ -164,7 +162,8 @@ extension AbstractPlayer{
         }
 
         player.seek(to: seekTime){ [weak self] value in
-            self?.isSeeking = false
+            let currentTime = CMTimeGetSeconds(player.currentTime())
+            self?.delegate?.didSeek(value: value, currentTime: currentTime)
         }
     }
 

Sources/swiftui-loop-videoplayer/protocol/player/LoopingPlayerProtocol.swift

@@ -29,9 +29,6 @@ public protocol LoopingPlayerProtocol: AbstractPlayer, LayerMakerProtocol{
 
     var playerLayer : AVPlayerLayer { get }
 
-    /// The delegate to be notified about errors encountered by the player.
-    var delegate: PlayerDelegateProtocol? { get set }
-
     /// An optional NSKeyValueObservation to monitor errors encountered by the video player.
     /// This observer should be configured to detect and handle errors from the AVQueuePlayer,
     /// ensuring that all playback errors are managed and reported appropriately.
@@ -147,9 +144,7 @@ internal extension LoopingPlayerProtocol {
             timeObserverToken = player.addPeriodicTimeObserver(forInterval: timePublishing, queue: .main) { [weak self] time in
                 guard let self = self else{ return }
 
-                if !self.isSeeking{
-                    self.delegate?.didPassedTime(seconds: time.seconds)
-                }
+                self.delegate?.didPassedTime(seconds: time.seconds)
             }
         }
 

Sources/swiftui-loop-videoplayer/protocol/view/LoopPlayerViewProtocol.swift

@@ -36,15 +36,18 @@ public protocol LoopPlayerViewProtocol {
     /// Settings for configuring the video player.
     var settings: VideoSettings { get set }
 
-    /// Initializes a new instance with the provided settings and playback command.
-    ///
+    /// Initializes a new instance of `LoopPlayerView`.
     /// - Parameters:
-    ///   - settings: A binding to a `VideoSettings` containing configuration details.
-    ///   - command: A binding to a `PlaybackCommand` that controls playback actions.
-    ///
-    /// This initializer sets up the necessary configuration and command bindings for playback functionality.
-    init(settings: Binding<VideoSettings>, command: Binding<PlaybackCommand>, timePublisher : PassthroughSubject<Double, Never>)
-    
+    ///   - settings: A binding to the video settings used by the player.
+    ///   - command: A binding to the playback command that controls playback actions.
+    ///   - timePublisher: A publisher that emits the current playback time as a `Double`.
+    ///   - eventPublisher: A publisher that emits player events as `PlayerEvent` values.
+    init(
+        settings: Binding<VideoSettings>,
+        command: Binding<PlaybackCommand>,
+        timePublisher: PassthroughSubject<Double, Never>,
+        eventPublisher: PassthroughSubject<PlayerEvent, Never>
+    )
 }
 
 @available(iOS 14, macOS 11, tvOS 14, *)

Sources/swiftui-loop-videoplayer/view/loop/Modifier/OnPlayerEventChangeModifier.swift

@@ -0,0 +1,32 @@
+//
+//  OnPlayerEventChangeModifier.swift
+//
+//
+//  Created by Igor  on 15.08.24.
+//
+
+import SwiftUI
+
+internal struct PlayerEventPreferenceKey: PreferenceKey {
+    public static var defaultValue: PlayerEvent = .idle
+    public static func reduce(value: inout PlayerEvent, nextValue: () -> PlayerEvent) {
+        value = nextValue()
+    }
+}
+
+internal struct OnPlayerEventChangeModifier: ViewModifier {
+    var onPlayerEventChange: (PlayerEvent) -> Void
+
+    func body(content: Content) -> some View {
+        content
+            .onPreferenceChange(PlayerEventPreferenceKey.self) { event in
+                onPlayerEventChange(event)
+            }
+    }
+}
+
+public extension View{
+    func onPlayerEventChange(perform action: @escaping (PlayerEvent) -> Void) -> some View {
+        self.modifier(OnPlayerEventChangeModifier(onPlayerEventChange: action))
+    }
+}

Sources/swiftui-loop-videoplayer/view/loop/Modifier/OnTimeChangeModifier.swift

@@ -25,8 +25,9 @@ internal struct OnTimeChangeModifier: ViewModifier {
     }
 }
 
-public extension LoopPlayerView {
+public extension View{
     func onTimeChange(perform action: @escaping (Double) -> Void) -> some View {
         self.modifier(OnTimeChangeModifier(onTimeChange: action))
     }
 }
+

Sources/swiftui-loop-videoplayer/view/loop/helpers/PlayerCoordinator.swift

@@ -10,6 +10,8 @@ import Combine
 
 @MainActor
 internal class PlayerCoordinator: NSObject, PlayerDelegateProtocol {
+        
+    let eventPublisher: PassthroughSubject<PlayerEvent, Never>
 
     let timePublisher: PassthroughSubject<Double, Never>
 
@@ -19,11 +21,15 @@ internal class PlayerCoordinator: NSObject, PlayerDelegateProtocol {
     /// A binding to an optional `VPErrors` instance, used to report errors back to the parent view.
     @Binding private var error: VPErrors?
 
-    /// Initializes a new instance of `PlayerCoordinator`.
-    /// - Parameter error: A binding to an optional `VPErrors` instance to manage error reporting.
-    init(_ error: Binding<VPErrors?>, timePublisher: PassthroughSubject<Double, Never>) {
+
+    init(
+        _ error: Binding<VPErrors?>,
+         timePublisher: PassthroughSubject<Double, Never>,
+        eventPublisher: PassthroughSubject<PlayerEvent, Never>
+    ) {
         self._error = error
         self.timePublisher = timePublisher
+        self.eventPublisher = eventPublisher
     }
 
     /// Deinitializes the coordinator and prints a debug message if in DEBUG mode.
@@ -53,7 +59,17 @@ internal class PlayerCoordinator: NSObject, PlayerDelegateProtocol {
         return lastCommand
     }
 
+    /// A method that handles the passage of time in the player.
+    /// - Parameter seconds: The amount of time, in seconds, that has passed.
     func didPassedTime(seconds : Double) {
         timePublisher.send(seconds)
     }
+    
+    /// A method that handles seeking in the player.
+    /// - Parameters:
+    ///   - value: A Boolean indicating whether the seek was successful.
+    ///   - currentTime: The current time of the player after seeking, in seconds.
+    func didSeek(value: Bool, currentTime : Double) {
+        eventPublisher.send(.seek(value, currentTime: currentTime))
+    }
 }

Sources/swiftui-loop-videoplayer/view/loop/main/LoopPlayerMultiPlatform.swift

@@ -23,9 +23,7 @@ import AppKit
 @available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
 @MainActor
 struct LoopPlayerMultiPlatform: LoopPlayerViewProtocol {
-    
-    let timePublisher: PassthroughSubject<Double, Never>
-    
+        
     #if canImport(UIKit)
     typealias View = UIView
 
@@ -40,6 +38,12 @@ struct LoopPlayerMultiPlatform: LoopPlayerViewProtocol {
     typealias PlayerView = LoopingPlayerNSView
     #endif
 
+    /// A publisher that emits the current playback time as a `Double`.
+    private let timePublisher: PassthroughSubject<Double, Never>
+
+    /// A publisher that emits player events as `PlayerEvent` values.
+    private let eventPublisher: PassthroughSubject<PlayerEvent, Never>
+    
     /// Command for the player view
     @Binding public var command : PlaybackCommand
 
@@ -53,15 +57,20 @@ struct LoopPlayerMultiPlatform: LoopPlayerViewProtocol {
         assetFor(settings)
     }
 
-    /// Initializes a new instance with the provided settings and playback command.
-    ///
-    /// This initializer sets up the necessary configuration and command bindings for playback functionality.
-    ///
+    /// Initializes a new instance of `LoopPlayerView`.
     /// - Parameters:
-    ///   - settings: A binding to an instance of `VideoSettings` containing configuration details.
-    ///   - command: A binding to a `PlaybackCommand` that controls playback actions.
-    init(settings: Binding<VideoSettings>, command: Binding<PlaybackCommand>, timePublisher : PassthroughSubject<Double, Never>) {
+    ///   - settings: A binding to the video settings used by the player.
+    ///   - command: A binding to the playback command that controls playback actions.
+    ///   - timePublisher: A publisher that emits the current playback time as a `Double`.
+    ///   - eventPublisher: A publisher that emits player events as `PlayerEvent` values.
+    init(
+        settings: Binding<VideoSettings>, 
+        command: Binding<PlaybackCommand>,
+        timePublisher : PassthroughSubject<Double, Never>,
+        eventPublisher : PassthroughSubject<PlayerEvent, Never>
+    ) {
         self.timePublisher = timePublisher
+        self.eventPublisher = eventPublisher
         self._settings = settings
         self._command = command
         let settings = settings.wrappedValue
@@ -73,7 +82,7 @@ struct LoopPlayerMultiPlatform: LoopPlayerViewProtocol {
     /// Creates a coordinator that handles error-related updates and interactions between the SwiftUI view and its underlying model.
     /// - Returns: An instance of PlayerErrorCoordinator that can be used to manage error states and communicate between the view and model.
     func makeCoordinator() -> PlayerCoordinator {
-        PlayerCoordinator($error, timePublisher: timePublisher)
+        PlayerCoordinator($error, timePublisher: timePublisher, eventPublisher: eventPublisher)
     }
 }