Add video annotation to PDF in Swift for iOS

1
//
2
//  Copyright © 2020-2026 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
class CustomGalleryExample: Example {
12

13
    override init() {
14
        super.init()
15

16
        title = "Custom Gallery Example"
17
        contentDescription = "Add animated gif or inline video."
18
        category = .multimedia
19
        priority = 200
20
    }
21

22
    override func invoke(with delegate: ExampleRunnerDelegate) -> UIViewController? {
23
        let document = AssetLoader.document(for: .annualReport)
24
        document.annotationSaveMode = .disabled
25

26
        let image = UIImage(named: "mas_audio_b41570.gif")!
27
        // Extract the image size to use it to size the annotation bounds
28
        let imageSize = image.size.applying(CGAffineTransform(scaleX: 0.5, y: 0.5))
29
        let pageSize = document.pageInfoForPage(at: 0)?.size ?? CGSize(width: 500, height: 500)
30

31
        // Create an action with custom options to execute on tapping the embedded video.
32
        let trailerVideoURL = URL(string: "http://movietrailers.apple.com/movies/wb/islandoflemurs/islandoflemurs-tlr1_480p.mov?width=848&height=480")!
33
        let sheetVideoAction = URLAction(url: trailerVideoURL, options: [
34
            // Disable browser controls.
35
            .controlsKey: false,
36
            // Will present as sheet on iPad, is ignored on iPhone.
37
            .sizeKey: CGSize(width: 620, height: 400)
38
        ])
39

40
        // Using the `pspdfkit://` scheme enables automatic gallery content detection.
41
        let videoLink = LinkAnnotation(url: URL(string: "pspdfkit://localhost/Bundle/mas_audio_b41570.gif")!)
42
        videoLink.boundingBox = CGRect(x: 0, y: pageSize.height - imageSize.height - 64.0, width: imageSize.width, height: imageSize.height)
43
        videoLink.action?.subActions = [sheetVideoAction]
44
        document.add(annotations: [videoLink])
45

46
        // Adding a single video inline.
47
        let embeddedVideoURL = URL(string: "pspdfkit://movietrailers.apple.com/movies/wb/islandoflemurs/islandoflemurs-tlr1_480p.mov?width=848&height=480")!
48
        let embeddedVideoAnnotation = LinkAnnotation(url: embeddedVideoURL)
49
        let embeddedVideoAnnotationOrigin = CGPoint(x: pageSize.width - imageSize.width, y: pageSize.height - imageSize.height - 64)
50
        embeddedVideoAnnotation.boundingBox = CGRect(origin: embeddedVideoAnnotationOrigin, size: imageSize)
51

52
        // Disable playback controls of the video
53
        embeddedVideoAnnotation.controlsEnabled = false
54
        document.add(annotations: [embeddedVideoAnnotation])
55

56
        let pdfViewController = PDFViewController(document: document) {
57
            // Disable annotation editing.
58
            $0.editableAnnotationTypes = nil
59
        }
60
        return pdfViewController
61
    }
62
}