https://github.com/jwplayer/jwplayer-ios-bestpracticeapps
https://github.com/jwplayer/jwplayer-ios-bestpracticeapps
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jwplayer/jwplayer-ios-bestpracticeapps
- Owner: jwplayer
- Created: 2016-03-15T21:38:12.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-12-12T22:41:51.000Z (over 1 year ago)
- Last Synced: 2024-12-12T23:29:43.963Z (over 1 year ago)
- Language: Swift
- Size: 16.4 MB
- Stars: 37
- Watchers: 16
- Forks: 24
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JWPlayerKit 4.x Best Practice Apps
This repository contains samples relating to the JWPlayerKit SDK version 4.x for iOS and JWPlayerTVKit SDK version 1.x for tvOS.
## BestPracticeApps
The BestPracticeApps [workspace](https://developer.apple.com/documentation/xcode/managing-multiple-projects-and-their-dependencies) is composed of several projects (with corresponding targets), each of which runs as a separate application.
|Platform | Project | Description|
| ------------- | ------------- | ------------- |
|`iOS`|[Advanced Player](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/AdvancedPlayer) | Advanced implementation of JWPlayerKit SDK with VAST ads. |
|`iOS`|[Basic Player](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/BasicPlayer) | Simple implementation of JWPlayerKit SDK with a single player item. |
|`tvOS`|[BasicTVPlayer](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/BasicTVPlayer) | Simple implementation of JWPlayerTVKit SDK with a single player item. |
|`iOS`|[ChromeCast](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/ChromeCast) | Simple implementation including the ability to cast to ChromeCast devices.[^chromecastDisclaimer] |
|`iOS`|[ChromeCast-GCKUICastButton](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Chromecast-GCKUICastButton) | Simple implementation using the cast button provided by the ChromeCast framework to cast to ChromeCast devices.[^chromecastDisclaimer] |
|`iOS`|[Custom UI](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Custom%20UI) | Demonstrates how to create a basic user interface from scratch, using only JWPlayerView. |
|`iOS`|[DRM Fairplay](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/DRM%20Fairplay#drm-fairplay---best-practices-app) | Simple implementation of JWPlayerKit SDK that plays protected video content through FairPlay (DRM). |
|`iOS`|[FeedTableViewController](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/FeedTableViewController) | Simple implementation of JWPlayerKit SDK that plays videos embedded in a UITableView, with a naive 'infinite scroll' implementation. |
|`iOS`|[Offline DRM](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Offline%20DRM#offline-drm---best-practices-app) | Demonstrates how to implement offline playback of protected video content through FairPlay (DRM). |
|`iOS`|[Offline Playback](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Offline%20Playback#offline-playback---best-practices-app) | Demonstrates how to implement offline download, storage and playback of unprotected content. |
|`iOS`|[Google IMA Ads](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Google%20IMA%20Ads#google-ima-ads---best-practices-app) | Simple implementation of JWPlayerKit SDK with Google IMA. |
|`iOS`|[Google IMA Companion Ads](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Google%20IMA%20Companion%20Ads#google-ima-companion-ads---best-practices-app) | Simple implementation of JWPlayerKit SDK with Google IMA Companion Ads. |
|`iOS`|[Google DAI Ads](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Google%20DAI%20Ads#google-dai-ads---best-practices-app) | Simple implementation of JWPlayerKit SDK with Google DAI. |
|`iOS`|[JWPlayer Ads](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/JWPlayer%20Ads#jwplayer-ads---best-practices-app) | Simple implementation of JWPlayerKit SDK with advertising. |
|`iOS`|[Recommendations](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Recommendations) | Simple implementation including recommended related content. |
|`iOS`|[Picture in Picture](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Picture%20in%20Picture) | Demonstrates how to enable Picture in Picture. |
|`iOS`|[Captions](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main/JWBestPracticeApps/Captions) | Demonstrates how to handle caption events. |
[^chromecastDisclaimer]: Unlike the other apps in this project which are *working* code examples, this app is a valid code example that nevertheless does **not** work as-is.
Rather, it requires the **dynamic** build of the Google Cast SDK. As Google does not distribute this via CocoaPods, it must be [added manually](https://developers.google.com/cast/docs/ios_sender#manual_setup) to a given project — as we do not include external frameworks in our repositories. Please refer to our [documentation](https://developer.jwplayer.com/jwplayer/docs/ios-enable-casting-to-chromecast-devices) for more information.
## Setup
| :information_source: The project uses [cocoapods](https://guides.cocoapods.org/using/getting-started.html) to manage dependencies. |
|-|
#### Steps to compile:
1. Make sure Xcode is closed.
1. In the Terminal app, navigate to the project's root directory.
1. To download and integrate the dependencies in the project, run:
```console
pod install
```
1. Open `JWBestPracticeApps-4x.xcworkspace`.
1. Add your [JWPlayer iOS SDK license key](https://support.jwplayer.com/articles/android-and-ios-sdk-reference#:~:text=HOW%20DO%20I%20GET%20THE%20IOS%20OR%20ANDROID%20SDK%3F%20HOW%20DO%20I%20USE%20THE%20SDKS%3F) to the AppDelegate for the target project:
```swift
JWPlayerKitLicense.setLicenseKey(<#Your License Key#>)
```
Now you can build and run the project.
---
| :warning: Looking for SDK version 3.x? |
|-|
| The demo apps in this repository are intended to be used with **version 4.x** of the JWPlayerKit iOS SDK.
For information on JWPlayer SDK **version 3.x** BestPracticeApps, go to [this link](https://github.com/jwplayer/jwplayer-ios-bestPracticeApps/tree/main-v3/). |