https://github.com/chris-perkins/twitchplayer
🖥 Embed Twitch Videos, Streams, Collections, and Clips into your iOS application
https://github.com/chris-perkins/twitchplayer
clips cocoapod ios library player pod streaming swift swift4 twitch twitch-api video
Last synced: 9 months ago
JSON representation
🖥 Embed Twitch Videos, Streams, Collections, and Clips into your iOS application
- Host: GitHub
- URL: https://github.com/chris-perkins/twitchplayer
- Owner: Chris-Perkins
- License: mit
- Created: 2019-01-16T03:23:17.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-14T04:59:02.000Z (almost 6 years ago)
- Last Synced: 2025-09-14T04:25:02.510Z (9 months ago)
- Topics: clips, cocoapod, ios, library, player, pod, streaming, swift, swift4, twitch, twitch-api, video
- Language: Swift
- Homepage:
- Size: 1.84 MB
- Stars: 30
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TwitchPlayer
[](https://travis-ci.org/chrisfromtemporaryid@gmail.com/TwitchPlayer)
[](https://cocoapods.org/pods/TwitchPlayer)
[](https://cocoapods.org/pods/TwitchPlayer)
[](https://cocoapods.org/pods/TwitchPlayer)
**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](https://htmlpreview.github.io/?https://github.com/Chris-Perkins/TwitchPlayer/blob/master/docs/index.html)
- If the documentation is not loading, clone this repository and open `docs/index.html`.
## Installation
1. Install [CocoaPods](https://cocoapods.org)
1. Add this repo to your `Podfile`
```ruby
target 'Example' do
# IMPORTANT: Make sure use_frameworks! is included at the top of the file
use_frameworks!
pod 'TwitchPlayer'
end
```
1. Run `pod install` in the podfile directory from your terminal
1. Open up the `.xcworkspace` that CocoaPods created
1. Done!
## License
TwitchPlayer is available under the MIT license. See the LICENSE file for more info.