added Mute setting

Author: swiftuiux

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

@@ -22,6 +22,9 @@ public enum Setting: Equatable, SettingsConvertible{
     /// Loop video
     case loop
 
+    /// Mute video
+    case mute
+    
     /// File name
     case name(String)
 

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

@@ -49,14 +49,15 @@ public protocol LoopingPlayerProtocol: AbstractPlayer, LayerMakerProtocol{
     /// Declare a variable to hold the time observer token outside the if statement
     var timeObserver: Any? { get set }
 
-    /// Initializes a new player view with specified video asset and configurations.
+    /// Initializes a new player view with a video asset and specified configurations.
     ///
     /// - Parameters:
-    ///   - asset: The `AVURLAsset` used for video playback.
-    ///   - gravity: The `AVLayerVideoGravity` defining how the video content is displayed within the layer bounds.
-    ///   - timePublishing: Optional `CMTime` that specifies a particular time for publishing or triggering an event.
-    ///   - loop: A Boolean value that indicates whether the video should loop when playback reaches the end of the content.
-    init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop : Bool)
+    ///   - asset: The `AVURLAsset` for video playback.
+    ///   - gravity: The `AVLayerVideoGravity` determining the video's display within the layer bounds.
+    ///   - timePublishing: Optional `CMTime` for publishing or triggering an event at a specific time.
+    ///   - loop: A Boolean indicating if the video should loop at the end of playback.
+    ///   - mute: A Boolean indicating if the audio playback should be muted.
+    init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop : Bool, mute: Bool)
 
     /// Sets up the necessary observers on the AVPlayerItem and AVQueuePlayer to monitor changes and errors.
     ///
@@ -83,15 +84,16 @@ internal extension LoopingPlayerProtocol {
         asset: AVURLAsset,
         gravity: AVLayerVideoGravity,
         timePublishing:  CMTime?,
-        loop: Bool
+        loop: Bool,
+        mute: Bool
     ) {
 
         let player = AVQueuePlayer(items: [])
         self.player = player
 
         update(asset: asset, loop: loop)
 
-        configurePlayer(player, gravity: gravity, timePublishing: timePublishing, loop: loop)
+        configurePlayer(player, gravity: gravity, timePublishing: timePublishing, loop: loop, mute: mute)
 
         setupObservers(for: player)
     }
@@ -106,9 +108,10 @@ internal extension LoopingPlayerProtocol {
         _ player: AVQueuePlayer,
         gravity: AVLayerVideoGravity,
         timePublishing:  CMTime?,
-        loop : Bool
+        loop : Bool,
+        mute : Bool
     ) {
-        player.isMuted = true
+        player.isMuted = mute
         playerLayer.player = player
         playerLayer.videoGravity = gravity
         #if canImport(UIKit)

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

@@ -91,7 +91,7 @@ public extension LoopPlayerViewProtocol{
         asset: AVURLAsset?) -> PlayerView? {
 
         if let asset{
-            let player = PlayerView(asset: asset, gravity: settings.gravity, timePublishing: settings.timePublishing, loop:  settings.loop)
+            let player = PlayerView(asset: asset, gravity: settings.gravity, timePublishing: settings.timePublishing, loop:  settings.loop, mute: settings.mute)
             container.addSubview(player)
             activateFullScreenConstraints(for: player, in: container)
             return player

Sources/swiftui-loop-videoplayer/settings/Mute.swift

@@ -0,0 +1,22 @@
+//
+//  Mute.swift
+//
+//
+//  Created by Igor Shelopaev on 10.09.24.
+//
+
+import Foundation
+
+@available(iOS 14.0, macOS 11.0, tvOS 14.0, *)
+public struct Mute: SettingsConvertible{
+    
+    // MARK: - Life circle
+    
+    public init() {}
+    
+    /// Fetch settings
+    @_spi(Private)
+    public func asSettings() -> [Setting] {
+        [.mute]
+    }
+}

Sources/swiftui-loop-videoplayer/utils/VideoSettings.swift

@@ -22,6 +22,9 @@ public struct VideoSettings: Equatable{
     /// Loop video
     public let loop: Bool
 
+    /// Mute video
+    public let mute: Bool
+    
     /// A CMTime value representing the interval at which the player's current time should be published.
     /// If set, the player will publish periodic time updates based on this interval.
     public let timePublishing: CMTime?
@@ -70,6 +73,8 @@ public struct VideoSettings: Equatable{
 
         loop = settings.contains(.loop)
 
+        mute = settings.contains(.mute)
+        
         errorWidgetOff = settings.contains(.errorWidgetOff)
     }
 }

Sources/swiftui-loop-videoplayer/view/player/ios/LoopingPlayerUIView.swift

@@ -63,17 +63,18 @@ class LoopingPlayerUIView: UIView, LoopingPlayerProtocol {
     /// The delegate to be notified about errors encountered by the player.
     weak var delegate: PlayerDelegateProtocol?
 
-    /// Initializes a new player view with specified video asset and configurations.
+    /// Initializes a new player view with a video asset and specified configurations.
     ///
     /// - Parameters:
-    ///   - asset: The `AVURLAsset` used for video playback.
-    ///   - gravity: The `AVLayerVideoGravity` defining how the video content is displayed within the layer bounds.
-    ///   - timePublishing: Optional `CMTime` that specifies a particular time for publishing or triggering an event.
-    ///   - loop: A Boolean value that indicates whether the video should loop when playback reaches the end of the content.
-    required init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop: Bool){
+    ///   - asset: The `AVURLAsset` for video playback.
+    ///   - gravity: The `AVLayerVideoGravity` determining the video's display within the layer bounds.
+    ///   - timePublishing: Optional `CMTime` for publishing or triggering an event at a specific time.
+    ///   - loop: A Boolean indicating if the video should loop at the end of playback.
+    ///   - mute: A Boolean indicating if the audio playback should be muted.
+    required init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop: Bool, mute: Bool){
         super.init(frame: .zero)
         setupPlayerComponents(
-            asset: asset, gravity: gravity, timePublishing : timePublishing, loop: loop
+            asset: asset, gravity: gravity, timePublishing : timePublishing, loop: loop, mute: mute
         )
     }
 

Sources/swiftui-loop-videoplayer/view/player/mac/LoopingPlayerNSView.swift

@@ -65,17 +65,18 @@ class LoopingPlayerNSView: NSView, LoopingPlayerProtocol {
     /// The delegate to be notified about errors encountered by the player.
     weak var delegate: PlayerDelegateProtocol?
 
-    /// Initializes a new player view with specified video asset and configurations.
+    /// Initializes a new player view with a video asset and specified configurations.
     ///
     /// - Parameters:
-    ///   - asset: The `AVURLAsset` used for video playback.
-    ///   - gravity: The `AVLayerVideoGravity` defining how the video content is displayed within the layer bounds.
-    ///   - timePublishing: Optional `CMTime` that specifies a particular time for publishing or triggering an event.
-    ///   - loop: A Boolean value that indicates whether the video should loop when playback reaches the end of the content.
-    required init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop : Bool) {
+    ///   - asset: The `AVURLAsset` for video playback.
+    ///   - gravity: The `AVLayerVideoGravity` determining the video's display within the layer bounds.
+    ///   - timePublishing: Optional `CMTime` for publishing or triggering an event at a specific time.
+    ///   - loop: A Boolean indicating if the video should loop at the end of playback.
+    ///   - mute: A Boolean indicating if the audio playback should be muted.
+    required init(asset: AVURLAsset, gravity: AVLayerVideoGravity, timePublishing: CMTime?, loop : Bool, mute: Bool) {
         super.init(frame: .zero)
         setupPlayerComponents(
-            asset: asset, gravity: gravity, timePublishing: timePublishing, loop: loop
+            asset: asset, gravity: gravity, timePublishing: timePublishing, loop: loop, mute: mute
         )
     }