Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 3.04 KB

README.md

File metadata and controls

65 lines (39 loc) · 3.04 KB
Raw

TwitchPlayer

CI Status Version License Platform

THIS IS AN UNOFFICIAL, FAN-MADE WRAPPER. IT IS IN NO WAY ENDORSED BY TWITCH.TV

What is It?

Twitch Player is a library that helps you embed Twitch Streams, Clips, Videos, and Collections into your application easily. You can embed directly from the Storyboard or programmatically.

Example Usage

From the storyboard, drag a WKWebView onto a ViewController. Set it's subclass to TwitchPlayer (for Stream, Video, or Collection playing) or TwitchClipPlayer (for Clip playing)

You can then modify the variables directly from the Storyboard.

NOTE: This library uses WKWebView to display libraries. As a result, you cannot use any Twitch Player from the Storyboard before iOS 11.0.

Note:

As of June 2020, Twitch now requires a Base URL in the string you load. Unfortunately, I am without a Macbook for development right now, and cannot address this library to fix the issue. As a workaround, you can change the "baseURL" string value in the TwitchClipPlayer/other embedded classes to work around this. Since I can't validate the change, it would be awesome if someone could quickly add that functionality so others can use the library!

Example Project

An example project is provided with this project that shows the storyboard-creation of a Clip Player, Stream Player, and Video Player

To run the example project, clone the repo, and run pod install from the Example directory. After that, open the resulting .xcworkspace file and go nuts!

Documentation

Documentation available here

  • If the documentation is not loading, clone this repository and open docs/index.html.

Installation

  1. Install CocoaPods

  2. Add this repo to your Podfile

    target 'Example' do
	# IMPORTANT: Make sure use_frameworks! is included at the top of the file
	use_frameworks!

	pod 'TwitchPlayer'
end

  3. Run pod install in the podfile directory from your terminal

  4. Open up the .xcworkspace that CocoaPods created

  5. Done!

License

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