SwiftVideoBackground is an easy to use Swift framework that provides the ability to play a video on any UIView. This provides a beautiful UI for login screens, or splash pages, as implemented by Spotify and many others.
Features
- Play a video with one line of code
- Supports local videos
&&videos from a web URL - Automatically adjusts when device orientation changes
- Automatically resumes video when app re-enters foreground
- Pause, resume, restart, and other controls
- Loop videos (optional)
- Mute sound (optional)
- Darken videos so overlying UI stands out more (optional)
- Documentation
Contents
Integration
CocoaPods
You can use CocoaPods to install SwiftVideoBackground by adding it to your Podfile:
For Swift 5:
pod 'SwiftVideoBackground'
For Swift 4:
pod 'SwiftVideoBackground', '~> 3.0'
For Swift 3:
pod 'SwiftVideoBackground', '0.06'
Carthage
You can use Carthage to install SwiftVideoBackground by adding it to your Cartfile:
github "dingwilson/SwiftVideoBackground"
Manually
To use this library in your project manually you may:
- for Projects, just drag VideoBackground.swift to the project tree
- for Workspaces, include the whole SwiftVideoBackground.xcodeproj
Migration Guide
Version 3.0.0
- Passing in an array of videos support removed. You should merge videos in advance instead. Here is a walk through on concatenating media files with FFmpeg.
alpharenamed todarkness
Version 2.0.0
See the quick migration guide.
Usage
Example
import UIKit
import SwiftVideoBackground
class MyViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
try? VideoBackground.shared.play(view: view, videoName: "myVideo", videoType: "mp4")
/* or from URL */
let url = URL(string: "https://coolVids.com/coolVid.mp4")!
VideoBackground.shared.play(view: view, url: url)
}
}
Documentation for Version 0.06 (Swift 3) can be found here.
Customization
play() has four additional optional parameters for customization:
darkness: CGFloat - Value between0and1. The higher the value, the darker the video. Defaults to0.isMuted: Bool - Indicates whether video is muted. Defaults totrue.willLoopVideo: Bool - Indicates whether video should restart when finished. Defaults totrue.setAudioSessionAmbient: Bool - Indicates whether to set the sharedAVAudioSessionto ambient. If this is not done, audio played from your app will pause other audio playing on the device. Defaults totrue.
So for example:
VideoBackground.shared.play(
view: view,
videoName: "myVideo",
videoType: "mp4",
darkness: 0.25,
isMuted: false,
willLoopVideo: true,
setAudioSessionAmbient: true
)
-> will play the video with the sound on, slightly darkened, continuously looping, and without affecting other sources of audio on the device.
Any combination of the parameters can be included or left out.
setAudioSessionAmbientonly has an effect in iOS 10.0+. For more information, see the docs.
Controls
pause()- Pauses the video.resume()- Resumes the video.restart()- Restarts the video.getThumbnailImage(from: URL, at: CMTime)- Generate an image from the video to show as thumbnail.darkness- Change thisCGFloatto adjust the darkness of the video. Value0to1. Higher numbers are darker. Setting to an invalid value does nothing.isMuted- Change thisBoolto mute/unmute the video.willLoopVideo- Change thisBoolto set whether the video restarts when it ends.videoGravity- Default is.resizeAspectFill. Change to.resizeAspect(doesn't fill view) or.resize(doesn't conserve aspect ratio).playerLayer- TheAVPlayerLayerthat can be accessed for advanced control and customization of the video.
Singleton
SwiftVideoBackground includes a singleton instance that can be conveniently accessed with VideoBackground.shared. An instance of VideoBackground can only play one video on one UIView at a time. So if you need to play on multiple UIViews, you need to retain an instance of VideoBackground for each UIView:
let videoBackground1 = VideoBackground()
Adding Videos To Your Project
In order to play local videos, you must add them to your project:
- Open project navigator
- Select your target
- Select
Build Phases - Select
Copy Bundle Resources - Click
+to add a video
License
SwiftVideoBackground is released under an MIT License. See LICENSE for details.
Authors
Copyright © 2016-present Wilson Ding.
Please provide attribution, it is greatly appreciated.
600 Nov 24, 2022
772 Dec 28, 2022
11 Jul 25, 2022
13 Jan 22, 2022
37 Dec 2, 2022
2.5k Jan 5, 2023
50 Sep 19, 2022
92 Sep 7, 2022
404 Dec 8, 2022
336 Nov 26, 2022
6 Aug 21, 2021
682 Dec 29, 2022
8 Oct 15, 2021
14 Jun 20, 2020
3 Jan 28, 2022
631 Dec 29, 2022
15 Feb 19, 2022
617 Dec 19, 2022
43 Feb 4, 2022