Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gilesvangruisen/Swift-YouTube-Player
Swift library for embedding and controlling YouTube videos in your iOS applications via WKWebView!
https://github.com/gilesvangruisen/Swift-YouTube-Player
Last synced: about 1 month ago
JSON representation
Swift library for embedding and controlling YouTube videos in your iOS applications via WKWebView!
- Host: GitHub
- URL: https://github.com/gilesvangruisen/Swift-YouTube-Player
- Owner: gilesvangruisen
- License: mit
- Created: 2014-12-21T20:50:19.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T02:47:40.000Z (3 months ago)
- Last Synced: 2024-07-19T11:14:50.472Z (2 months ago)
- Language: Swift
- Homepage:
- Size: 101 KB
- Stars: 872
- Watchers: 39
- Forks: 284
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - Swift-YouTube-Player - Swift library for embedding and controlling YouTube videos in your iOS applications! (Media / Video)
- awesome-ios-star - Swift-YouTube-Player - Swift library for embedding and controlling YouTube videos in your iOS applications! (Media / Video)
README
# 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](#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.framework` to the `Link binary with libraries` build phase
* add `YouTubePlayer.framework` as an input file to the `carthage copy-frameworks` run script phase (only necesasry if you're building for iOS)
See [Carthage](http://github.com/carthage/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
```Swift
// Import Swift module
import YouTubePlayer
```
Build and lay out the view however you wish, whether in IB w/ an outlet or programmatically.
```Swift
@IBOutlet var videoPlayer: YouTubePlayerView!
```
```Swift
// 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.
```Swift
// Load video from YouTube ID
videoPlayer.loadVideoID("nfWlot6h_JM")
```
```Swift
// 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](https://developers.google.com/youtube/iframe_api_reference) 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](#controlling-youtubeplayerview).