Download the SDK

Last updated: April 15, 2019

Use of the iOS SDK v3 requires a JW Player Enterprise license. Please contact our team if you would like to upgrade your account.

If you are using JW Player SDK for iOS 2.x.x, use this SDK documentation.

To add a player to your app, you must import the JW Player SDK for iOS and then configure your project. You can choose one of three approaches to complete these tasks. In the following table, several notes about each approach are listed. Read each approach and click the GET STARTED link for the approach that suits your implementation needs.

Approach Notes
CocoaPods - No SDK download is required.
- Core and optional modules must be added to your app.
- An existing app is required.

GET STARTED with the CocoaPods approach
Local - JW Player SDK for iOS must be downloaded and unzipped.
- Core and optional modules must be imported.
- An existing app is required.

GET STARTED with the Local appoach
Demo - JW Player SDK for iOS Open Source Demo must be downloaded.
- All modules are included. No modules need to be imported or set as dependencies.
- An existing app is not required. The open source demo is a basic demonstration app that allows you to experiment with the SDK.

GET STARTED with the Demo approach



CocoaPods

In the following subsections, you will learn how to complete these tasks:

  1. Get required items.
  2. Add SDK to Xcode project.

If you have problems completing any of these tasks, log a support ticket for assistance.

Get the required items

Before you begin this approach to add the SDK to your project, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player SDK for iOS requires an Enterprise or Developer license.
Xcode Download and install Xcode.
License key 1. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
2. In the Downloads section, copy the LICENSE KEY for the JW Player SDK for iOS.

Add SDK to an Xcode project

Now that you have the required items listed in the previous subsection, you can import the JW Player SDK for iOS to your Xcode project.

Install CocoaPods and create a Podfile

  1. At the Terminal prompt enter $ gem install cocoapods to install CocoaPods.
  2. Enter $ cd <path-to-your-project>/<your-project>/ to navigate to your project directory.
  3. Enter $ pod init to create a file named Podfile. Podfile defines the dependencies for your project.

Edit the Podfile

  1. In a text editor, open Podfile.
  2. Set the iOS version to 11.0 or greater.
  3. If you are using Objective-C, you can comment out use_frameworks!.
  4. Add JWPlayer-SDK as a dependency. To add a specific version of the SDK, be sure to use the proper Podfile syntax.
  5. Save Podfile and close the text editor.

# Uncomment the next line to define a global platform for your project
platform :ios, '11.0'

target 'MyAwesomeProject' do
  # Comment the next line if you're not using Swift and don't want to use dynamic frameworks
  use_frameworks!

  # Pods for MyAwesomeProject
  pod 'JWPlayer-SDK', '~> 3.0'
end

Install the SDK

  1. At the terminal prompt of your project directory, enter $ pod install to install the JW Player SDK for iOS.
  2. Open the .xcworkspace file for your project to launch Xcode.

You have retrieved your JW Player license key and imported the JW Player SDK for iOS into your project. You can now configure your project.


Local

In the following subsections, you will learn how to complete these tasks:

  1. Get required items.
  2. Add SDK to Xcode project.

If you have problems completing any of these tasks, log a support ticket for assistance.

Get required items

Before you begin this approach to add the SDK to your project, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player SDK for iOS requires an Enterprise or Developer license.
Xcode Download and install Xcode.
JW Player SDK for iOS and license key 1. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
2. In the Downloads section, select a VERSION of the iOS SDK from the dropdown menu.
3. Click the icon in the DOWNLOAD column.
4. Copy the LICENSE KEY for the JW Player SDK for iOS.
5. On your computer, unzip the JW Player SDK for iOS .zip file.

Import the SDK into your project

Now that you have the required items listed in the previous subsection, you can add JW Player SDK for iOS to your Xcode project.

  1. From within Xcode, select your project from the project navigator.
  2. Select the target in the left column of the project editor.
  3. Click General.
  4. In the Linked Frameworks and Libraries, click the plus sign (+).
  5. Click Add Other.
  6. Select JWPlayer_iOS_SDK.framework from the jwplayer-ios-sdk/Framework folder on your computer.
  7. Click Open.

You have retrieved your JW Player license key and imported the JW Player SDK for iOS into your project. You can now configure your project.


Demo

The JW Player SDK for iOS Open Source Demo is a basic demonstration app. In the following subsection, you will learn how to get required items that will enable you to experiment with the demo app.

If you have problems completing any of these tasks, log a support ticket for assistance.

Get the required items

Before you can start experimenting with the JW Player SDK for iOS Open Source Demo, you need the items in the table below from JW Player.

Item Acquisition process
Enterprise or Developer license JW Player Open Source Demo for iOS. requires an Enterprise or Developer license.
Xcode Download and install Xcode.
JW Player SDK for iOS Open Source Demo and license key 1. Download the JW Player Open Source Demo for iOS.
2. From your JW Player dashboard, click Players > PLAYER DOWNLOADS & KEYS.
3. In the Downloads section, copy the LICENSE KEY for the JW Player SDK for iOS.

You have retrieved your JW Player license key and downloaded the JW Player SDK for iOS Open Source Demo. You can now configure your project.



Use this form to provide your feedback.