Platform DocsPlayers DocsRelease Notes
System StatusSubmit a CaseDashboard LoginContact Sales

<img src="https://img.shields.io/badge/%20-ENTERPRISE-B10031" style="float:left"/><br />

The JWP SDK for iOS is built upon the native iOS player framework, AVFoundation. Apps built with this SDK integrate with video hosting, streaming, and analytics services. These services allow you to incorporate media playback experiences, monetize your app, and discover ways to increase viewer engagement. You can also use this SDK with video content that is hosted with non-JWP services.

<br /> <hr />

## Key Features

#### Advertising

  • Google DAI

  • Google IMA

  • VAST

  • VMAP

  • Open Measurement (OMID)

#### Monitoring

  • Analytics

  • Ability to monitor and set video and audio qualities

  • API design that enables native control creation or customization

  • Player, playlist, playback, and content state monitoring

#### Playback

  • Fullscreen video playback

  • Casting

  • AirPlay

  • DRM

  • HLS, SmoothStreaming, and MP4 playback

#### UX

  • Rich configuration options including playlists, content title, and poster image

  • Caption support (.vtt, .srt, .ttml)

  • Picture in Picture

  • Thumbnail previews

  • Lockscreen controls

  • Related content support

  • External metadata support

<br /> <hr />

## Requirements

### General

ItemNotes
**Xcode 12+**Download and install <a href="https://developer.apple.com/support/xcode/" target="_blank">Xcode</a>.
**iOS 14.0+**Your app must be leveraging at least this minimum OS version.
**JWP License**Get your <a href="https://www.jwplayer.com/pricing/" target="_blank">JWP license</a>.
**JWP SDK for iOS**Follow these instructions to [download the SDK](🔗).
**JW Player License Key**1. From your <a href="https://dashboard.jwplayer.com/#/players/downloads" target="_blank"><strong>Player Downloads & Keys</strong></a> page, scroll down to the **Downloads** section. <br />2. In the **Downloads** section, copy the **LICENSE KEY** for the JWP SDK for iOS.<br /><br />_NOTE: If you have more than one property in your account, select the property from the dropdown menu at the top of the page. Each property has a unique set of license keys._

<br />

### Dependencies

Each version of this SDK has been built to work with a specific dependency version. Use the following table to ensure that you are referencing the correct dependency version in your app. The JWP SDK for iOS version listed shows when the minimum dependency support version was first updated.

JWP SDK for iOSGoogle IMA SDKGoogle Cast SDK
4.17.0+3.19.14.5.3
4.15.03.18.44.5.3
4.0.03.14.34.5.3

<br /> <hr />

## Documentation

This developer guide provides best practice approaches for implementing this SDK. We also provide comprehensive documentation for each class in our SDK reference.

<br /> <hr />

## Third-Party Libraries and Frameworks

The JWP iOS SDK supports Google IMA, Google DAI, Google Cast, and Open Measurement (embedded within our SDK). At this time, the iOS SDK neither supports nor maintains components for any frameworks, such as React Native, Cordova, Ionic, and Flutter.

<br /> <hr />

## Intended audience

This guide assumes that a developer has the knowledge to write and build an iOS application in Swift/Objective-C using Xcode and the latest developer tools.

<br /> <hr />

## Terms of service

By adding the JWP SDK for iOS to your app, you agree to the [JWP Terms of Service](🔗).

<br />

<!-- Removes the automatic page-to-page navigation at the bottom of the page -->

<style> .rm-Pagination { display: none; } </style>