PDVideoPlayer

PDVideoPlayer is a Swift Package that provides a customizable video player component for SwiftUI on both iOS and macOS. It wraps AVPlayer inside a SwiftUI view and exposes convenient APIs for common playback controls.

Features

• Universal support for iOS and macOS using the same code base.
• Picture-in-Picture on iOS.
• Custom context menus on iOS via contextMenuProvider.
• Gesture handling including double-tap skip with ripple effects, long press speed changes.
• Optional overlay to enlarge the trackpad swipe seeking area on macOS.
• Customizable keyboard shortcuts for quick navigation.
• Environment driven configuration such as mute state, close actions, long‑press callbacks and foreground color.
• Built using pure SwiftUI with minimal dependencies.

Installation

Add PDVideoPlayer to your project using Swift Package Manager. In Xcode choose File > Add Packages... and enter https://github.com/lynnswap/PDVideoPlayer as the package URL. Alternatively, you can declare it in your Package.swift:

dependencies: [
    .package(url: "https://github.com/lynnswap/PDVideoPlayer", from: "0.2.x")
]

Then import PDVideoPlayer where needed.

Basic Usage

Create a player from a URL or an existing AVPlayer and provide optional menus and content.

import PDVideoPlayer

struct ContentView: View {
    let videoURL: URL
    @State private var speed: PlaybackSpeed = .x1_0
    var body: some View {
        PDVideoPlayer(url: videoURL, menu: {
            Button("Sample 1") { print("Button 1") }
            Button("Sample 2") { print("Button 2") }
        }) { proxy in
            ZStack {
                proxy.player
                    .onTap { inside in
                        print("tap", inside)
                    }
#if os(iOS)
                    .skipRippleEffect()
                        // adds a ripple animation when double‑tap skipping
#endif
#if os(macOS)
                    .onPresentationSizeChange({ view, size in
                        // e.g. handle window resizing or other presentation-size changes
                    })
#endif
                    .ignoresSafeArea()
                VStack {
                    Spacer()
                    proxy.control
                        .knobSize(16)
                        .frame(maxWidth: 500,alignment: .center)
                }
            }
        }
        .playbackSpeed($speed)
        .onLongPress { value in
            print("onLongPress", value)
        }
        .onClose { value in
            print("onClose", value)
        }
        .playerForegroundColor(.white)
        .rippleForegroundColor(.white.opacity(0.8))
    }
}

Example

An example implementation is provided in Sources/PDVideoPlayer/Example/PDVideoPlayerSampleView.swift. This view showcases a basic player setup with custom controls.

Modifiers

PDVideoPlayer provides modifiers for each view in the player hierarchy:

PDVideoPlayer

• playbackSpeed(_:) – Bind the playback speed.
• onClose(_:) – Handle closing the player.
• onLongPress(_:) – Respond to long-press gestures.
• playerForegroundColor(_:) – Set tint color for controls.
• rippleForegroundColor(_:) – Override the color used by skip ripple overlays (defaults to the player foreground color).
• windowDraggable(_:) – Allow dragging the window. (macOS)

Player View (proxy.player)

• onTap(_:) – Handle taps on the player.
• onPresentationSizeChange(_:) – Observe the presentation size.
• scrollViewConfigurator(_:) – Customize the underlying scroll view.
• contextMenuProvider(_:) – Provide a custom context menu. (iOS)
• skipRippleEffect() – Show a ripple animation when double‑tap skipping. (iOS)
• playerViewConfigurator(_:) – Configure the underlying NSView. (macOS)

Control View (proxy.control)

• knobSize(_:) – Adjust the slider knob size.
• trackpadSwipeOverlay() – Expand the area for trackpad swipe seeking. (macOS)

Content Container

• videoPlayerKeyboardShortcuts(_:) – Add keyboard shortcuts for playback.

Components

These helper views can be combined with PDVideoPlayer:

• FastForwardIndicatorView – Shows the current speed during long‑press fast-forwarding (iOS only).

Apps Using

License

This project is released under the MIT License. See LICENSE for details.