⚠️⚠️⚠️ This library has been deprecated and will be removed in the future. ⚠️⚠️⚠️

PlayerKit

PlayerKit is a modular video player system for iOS and tvOS.

Motivation

Vimeo supports various types of video and playback (360 video, Chromecast, etc.). PlayerKit allows the app to create, utilize, and interact with different types of players in an abstract way.

Goals

Provide an interface defining a common API and delegate callback strategy for different types of players to implement
Allow players to define their capabilities using protocol conformance

Example

To run the example project, clone the repo, and run pod install from the Example directory.

Minimum Requirements

iOS 8.0 / tvOS 9.0
Swift 4.2

Installation

PlayerKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "PlayerKit"

Usage

Using RegularPlayer

RegularPlayer is an implementation of Player used to play regular videos.

To play a video:

let player = RegularPlayer()

view.addSubview(player.view) // RegularPlayer conforms to `ProvidesView`, so we can add its view

player.set(asset: AVURLAsset(URL: "https://example.com/video.mp4"))

player.play()

Optionally, an object can conform to PlayerDelegate to receive updates from the player and perform actions such as UI updates. Check out the example project for an example of this.

player.delegate = delegate

Creating New Types of Players

You can create your own players by creating objects that conform to the Player protocol and call the delegate methods when appropriate.

Questions?

Post on Stackoverflow with the tag vimeo-ios. Get in touch here. Interested in working at Vimeo? We're hiring!

License

PlayerKit is available under the MIT license. See the LICENSE file for more info.

vimeo / PlayerKit

readme