YouTubePlayer
Embed and control YouTube videos in your iOS applications! Neato, right? Let's see how it works.
0.7.0 Update: WKWebView breaking changes
Installation
Carthage
Add this to your Cartfile:
github "gilesvangruisen/Swift-YouTube-Player"
…and then run carthage update
Don't forget to:
- add
YouTubePlayer.frameworkto theLink binary with librariesbuild phase - add
YouTubePlayer.frameworkas an input file to thecarthage copy-frameworksrun script phase (only necesasry if you're building for iOS)
See Carthage for more information about using Carthage as a dependency manager.
Cocoapods
Ensure you are opting into using frameworks with use_frameworks!. Then add the following to your Podfile:
pod 'YouTubePlayer'
…and then run pod install.
Example
// Import Swift module
import YouTubePlayer
Build and lay out the view however you wish, whether in IB w/ an outlet or programmatically.
@IBOutlet var videoPlayer: YouTubePlayerView!
// init YouTubePlayerView w/ playerFrame rect (assume playerFrame declared)
var videoPlayer = YouTubePlayerView(frame: playerFrame)
Give the player a video to load, whether from ID or URL.
// Load video from YouTube ID
videoPlayer.loadVideoID("nfWlot6h_JM")
// Load video from YouTube URL
let myVideoURL = NSURL(string: "https://www.youtube.com/watch?v=wQg3bXrVLtg")
videoPlayer.loadVideoURL(myVideoURL!)
Controlling YouTubePlayerView
Each YouTubePlayerView has methods for controlling the player (play, pause, seek, change video, etc.) They are:
func loadVideoURL(videoURL: NSURL)func loadVideoID(videoID: String)func loadPlaylistID(playlistID: String)func play()func pause()func stop()func clear()func seekTo(seconds: Float, seekAhead: Bool)func previousVideo()func nextVideo()func getCurrentTime(completion: ((Double?) -> Void)?)func getDuration(completion: ((Double?) -> Void)?))
Please note that calls to all but the first two methods will result in a JavaScript runtime error if they are called before the player is ready. The player will not be ready until shortly after a call to either loadVideoURL(videoURL: NSURL) or loadVideoID(videoID: String). You can check the readiness of the player at any time by checking its ready: Bool property. These functions run asynchronously, so it is not guaranteed that a call to a play function will be safe if it immediately follows a call to a load function. I plan to update the library soon to add completion handlers to be called when the player is ready.
In the meantime, you can also the YouTubePlayerDelegate method playerReady(videoPlayer: YouTubePlayerView) to ensure code is executed immediately when the player becomes ready.
Responding to events
YouTube's iFrame player emits certain events based on the lifecycle of the player. The YouTubePlayerDelegate outlines these methods that get called during a player's lifecycle. They are:
func playerReady(videoPlayer: YouTubePlayerView)func playerStateChanged(videoPlayer: YouTubePlayerView, playerState: YouTubePlayerState)func playerQualityChanged(videoPlayer: YouTubePlayerView, playbackQuality: YouTubePlaybackQuality)
Side note: All these delegate methods are optional which means that you can implement none, all, or some of them in your delegate class.
Breaking Changes
0.7.0 Transitioning from UIWebView (deprecated) to WKWebView required changing player calls which return values to be asynchronous. If you upgrade to 0.7.0, you will need to replace any call to either getCurrentTime() and getDuration() with its asynchronous equivalent, documented above.
555 Dec 28, 2022
304 Jan 7, 2023
28 Dec 3, 2022
52 Dec 2, 2022
724 Nov 24, 2022
2.9k Jan 7, 2023
1 Nov 28, 2021
80 Dec 20, 2022
169 Dec 10, 2022
11 May 30, 2022
158 Dec 10, 2022
168 Jan 6, 2023
2.4k Dec 29, 2022
12 Dec 25, 2022
4 Nov 19, 2021
156 Jun 8, 2022
19 Dec 8, 2022
33 Dec 26, 2022
11 Dec 27, 2022