Customize view controller for screen mirroring in Swift for iOS

1
//
2
//  Copyright © 2017-2025 PSPDFKit GmbH. All rights reserved.
3
//
4
//  The Nutrient sample applications are licensed with a modified BSD license.
5
//  Please see License for details. This notice may not be removed from this file.
6
//
7

8
import PSPDFKit
9
import PSPDFKitUI
10

11
#if !os(visionOS)
12

13
private class MirrorablePDFViewController: PDFViewController {
14
    override func viewWillAppear(_ animated: Bool) {
15
        super.viewWillAppear(animated)
16
        SDK.shared.screenController.pdfControllerToMirror = self
17
    }
18

19
    override func viewWillDisappear(_ animated: Bool) {
20
        super.viewWillDisappear(animated)
21
        SDK.shared.screenController.pdfControllerToMirror = nil
22
    }
23
}
24

25
class ScreenMirroringExample: Example {
26

27
    override init() {
28
        super.init()
29
        title = "Screen Mirroring Customization Example"
30
        contentDescription = "Shows how to add your own view controller for screen mirroring."
31
        category = .viewCustomization
32
        priority = 10
33
    }
34

35
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController {
36
        let document = AssetLoader.document(for: .welcome)
37
        let pdfController = MirrorablePDFViewController(document: document) {
38
            $0.pageTransition = .scrollPerSpread
39
        }
40

41
        // We do additional config in the delegate
42
        SDK.shared.screenController.delegate = self
43

44
        return pdfController
45
    }
46
}
47

48
extension ScreenMirroringExample: ScreenControllerDelegate {
49

50
    internal func createPDFViewController(forMirroring screenController: ScreenController) -> PDFViewController {
51

52
        let configuration = PDFConfiguration {
53
            $0.pageMode = .automatic
54
            $0.thumbnailBarMode = .none
55
            $0.documentLabelEnabled = .NO
56
            $0.isPageLabelEnabled = false
57

58
            // Only per page scrolling is supported
59
            $0.pageTransition = .scrollPerSpread
60

61
            $0.galleryConfiguration = GalleryConfiguration {
62
                $0.allowPlayingMultipleInstances = true
63
                $0.usesExternalPlaybackWhileExternalScreenIsActive = false
64
            }
65

66
      // Set custom background for easier debugging
67
            $0.backgroundColor = UIColor.systemOrange
68
        }
69
        let pdfController = PDFViewController(document: screenController.pdfControllerToMirror?.document, configuration: configuration)
70
        return pdfController
71
    }
72

73
    internal func screenController(_ screenController: ScreenController, didStartMirroringFor screen: UIScreen) {
74
        guard let pdfController = screenController.mirrorController(for: screen) else { return }
75
        var window: UIWindow?
76
        let scenes = UIApplication.shared.connectedScenes
77
        for scene in scenes {
78
            if let windowScene = scene as? UIWindowScene {
79
                window = windowScene.windows.first { window in
80
                    window.rootViewController == pdfController
81
                }
82
            }
83
        }
84
        guard let window else { return }
85

86
        // We change the root view controller to something else after mirroring started.
87
        let hostController = UIViewController()
88
        hostController.view.backgroundColor = UIColor.systemOrange
89
        window.rootViewController = hostController
90

91
        // Re-add pdf controller and set up positioning
92
        hostController.addChild(pdfController)
93
        pdfController.view.translatesAutoresizingMaskIntoConstraints = false
94
        hostController.view.addSubview(pdfController.view)
95
        pdfController.didMove(toParent: hostController)
96

97
        NSLayoutConstraint.activate([
98
            // Thumbnail Container
99
            pdfController.view.topAnchor.constraint(equalTo: hostController.view.topAnchor, constant: 20),
100
            pdfController.view.bottomAnchor.constraint(equalTo: hostController.view.bottomAnchor, constant: -20),
101
            pdfController.view.leadingAnchor.constraint(equalTo: hostController.view.leadingAnchor, constant: 20),
102
            pdfController.view.trailingAnchor.constraint(equalTo: hostController.view.trailingAnchor, constant: -20),
103
            ])
104
    }
105
}
106

107
#endif