jwplayer-react-native

  

⚠️ This README is for jwplayer-react-native version 1.0.0 and higher, for previous versions from the original author, Chaim Paneth via Orthodox Union, see react-native-jw-media-player. Beginning with version 0.2.0, this library uses JWX's JWPlayerKit (iOS)) and SDK 4 (Android)).

Prerequisites | Installation | Usage | Advanced Topics | Contributions | Issues

The jwplayer-react-native library is a bridge that enables using the native JWX Android and iOS SDKs in React Native applications.

Prerequisites

Before installing and using the library, you need the following items:
- JWX Account
- JWX License Key (Android | iOS)
- React Native App
- Package Manager (npm | yarn )

Installation

Android | iOS

$3

Follow these steps to add the library to your Android project:
1. From the project directory in terminal, add the jwplayer-react-native library. You can use npm or yarn.

npm: npm i @jwplayer/jwplayer-react-native --save

yarn: yarn add @jwplayer/jwplayer-react-native

2. In android/build.gradle, add the JWX Maven repository inside the allprojects block.

``groovy
allprojects {
repositories {
...
maven {
url 'https://mvn.jwplayer.com/content/repositories/releases/'
}
`

For more details and guidance regarding configuration and requirements, see the JWX Android SDK documentation.




$3

Follow these steps to add the library to your iOS project:
1. From the project directory in terminal, add the jwplayer-react-native library. You can use npm or yarn.

npm: npm i @jwplayer/jwplayer-react-native --save

yarn: yarn add @jwplayer/jwplayer-react-native

2. Change the directory to the iOS folder of your React Native project.
`
cd ios/
`

3. Install the iOS dependencies with CocoaPods.
`
pod install
`

For more details and guidance regarding configuration and requirements, see the JWX iOS SDK documentation.





Usage

The following example shows how you can enhance your React Native application by seamlessly integrating the multimedia playback functionalities of the JWX mobile SDKs.

Follow these steps to configure the media playback experience in your app:

1. Use the following example as a guide to configure the media playback experience. Be sure to remove all instances of ... from the code.


`javascript
...

import JWPlayer, { JWPlayerState } from '@jwplayer/jwplayer-react-native';

...

const styles = StyleSheet.create({
container: {
flex: 1,
},
player: {
flex: 1,
},
});

...

const playlistItem = {
title: 'Track',
mediaId: -1,
image: 'http://image.com/image.png',
description: 'My beautiful track',
startTime: 0,
file: 'http://file.com/file.mp3',
tracks: [
{
file: 'http://file.com/english.vtt',
label: 'en',
default: true
},
{
file: 'http://file.com/spanish.srt',
label: 'es'
}
],
sources: [
{
file: 'http://file.com/file.mp3',
label: 'audio'
},
{
file: 'http://file.com/file.mp4',
label: 'video',
default: true
}
]
}

const config = {
license:
Platform.OS === 'android'
? 'YOUR_ANDROID_SDK_KEY'
: 'YOUR_IOS_SDK_KEY',
backgroundAudioEnabled: true,
autostart: true,
styling: { // only (mostly) compatible with iOS
colors: {
timeslider: {
rail: "0000FF",
},
},
},
playlist: [playlistItem],
}

...

async isPlaying() {
const playerState = await this.JWPlayer.playerState();
return playerState === JWPlayerState.JWPlayerStatePlaying;
}

...

render() {

...


ref={p => (this.JWPlayer = p)}
style={styles.player}
config={config}
onBeforePlay={() => this.onBeforePlay()}
onPlay={() => this.onPlay()}
onPause={() => this.onPause()}
onIdle={() => console.log("onIdle")}
onPlaylistItem={event => this.onPlaylistItem(event)}
onSetupPlayerError={event => this.onPlayerError(event)}
onPlayerError={event => this.onPlayerError(event)}
onBuffer={() => this.onBuffer()}
onTime={event => this.onTime(event)}
onLoaded={event => this.onLoaded(event)}
onFullScreen={() => this.onFullScreen()}
onFullScreenExit={() => this.onFullScreenExit()}
/>


...

}
`


2. Define config.license with your Android or iOS JWX license key.
3. Define config.playlist with the media to play in the player.
4. (Optional) Define the other values of the config prop.




ℹ️ See Props for all the available config prop fields.

ℹ️ See Legacy Readme for all the available config prop fields when using a legacy configuration.




$3

This repository contains the Example project. This project showcases several basic implementations of the view and can be used as a resource while working with the jwplayer-react-native library:

- Test pull requests (PRs) or modifications
- Experiment with the available media playback features
- Validate your configurations in a known, working application
- Demonstrate issues within a sanitary environment when submitting bugs




Follow these steps to run the example project:

1. Checkout this repository.
2. From the Example directory, run yarn or npm i.
3. From the Example/ios directory, install the iOS dependencies.
`
pod install
`
4. In Xcode,open RNJWPlayer.xcworkspace.
5. In App.js, within the config prop, add your JWX SDK license key.
6. Build and run the app for your preferred platform.
`
yarn android
`

OR

`
yarn ios
`




ℹ️ You can also build and run the app with specific react-native commands.





Configuration

The library now features a unified configuration system that provides consistent, type-safe configuration across both iOS and Android platforms.

$3

- Configuration Reference - Complete guide to all configuration options with examples
- Platform Differences - Detailed comparison of iOS vs Android features
- Migration Guide - Guide for upgrading to the unified type system
- Props Documentation - Component props reference

$3

`typescript
import JWPlayer, { JWPlayerConfig } from '@jwplayer/jwplayer-react-native';

const config: JWPlayerConfig = {
license: 'YOUR_LICENSE_KEY',
file: 'https://example.com/video.m3u8',
autostart: true,
advertising: {
client: 'dai',
imaDaiSettings: {
videoId: 'tears-of-steel',
cmsId: '2528370'
}
}
};

export default () => (

);
`

$3

The library supports two configuration modes:

1. Modern Configuration (Recommended)
- Uses the unified type system (JWPlayerConfig)
- Provides full type safety and IDE support
- Matches JW Player Delivery API format
- Clearly documents platform-specific features
- Example: See TypeScript Example

2. Legacy Configuration
- Set forceLegacyConfig={true} in props
- Uses older builder patterns from previous versions
- Limited type safety and platform support
- Not recommended for new implementations
- Documentation: See Legacy Readme

$3

- ✅ Type Safety: Full TypeScript support with autocomplete
- ✅ Cross-Platform: Single configuration works on both iOS and Android
- ✅ Platform Annotations: Clear documentation of platform-specific features
- ✅ Backward Compatible: Existing configurations continue to work
- ✅ Well Documented: Comprehensive guides for all features





Advanced Topics

Advertising | Background Audio | Casting | DRM | Picture in Picture (PiP) | Styling




$3

Android | iOS

#### Android Advertising

Follow these steps to set up advertising with IMA or DAI:

1. In the android/build.gradle ext{} block, add RNJWPlayerUseGoogleIMA = true.

`groovy
buildscript {
ext {
RNJWPlayerUseGoogleIMA = true
}
}
`

This setting will add the following dependencies: com.google.ads.interactivemedia.v3:interactivemedia:3.36.0 and com.google.android.gms:play-services-ads-identifier:18.0.1.

2. ⚠️ REQUIRED: Enable desugaring in your app (required for IMA SDK 3.37.0+):

In your android/app/build.gradle, add the following configuration:

`groovy
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
coreLibraryDesugaringEnabled true
}
}

dependencies {
// ... your other dependencies
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:2.1.5'
}
`

> Important: The IMA SDK 3.37.0+ requires desugaring due to its transitive dependencies. While the jwplayer-react-native library configures desugaring internally, Android requires that your consuming app also explicitly enable desugaring. If you skip step 2, you will get build errors like "Dependency requires core library desugaring to be enabled". This is an Android Gradle requirement where both the library and the consuming app must opt-in to desugaring.




#### iOS Advertising

Follow this step to set up advertising with IMA or DAI:

1. In the Podfile ext{}, add $RNJWPlayerUseGoogleIMA = true. This setting will add GoogleAds-IMA-iOS-SDK to the pod.





$3

Background Audio allows your viewers to play audio while they are no longer actively using your app or have locked their device.

Follow these steps to enable background audio sessions:

1. Set backgroundAudioEnabled to true in the config.
2. Ensure that background audio is set for Android or iOS.

#### Android Opt-Out Information
Suppose you are not using the background audio service on Android. In that case, you will need to modify the manifest from our library (either in the node_modules, or in your fork before compilation) so as not to register a service that you will never use. Google can and will reject your Play Store submission if this is skipped. See the modified manifest below, which shows what to remove (commented-out permissions and services). Additionally, once this is done, you can never set backgroundAudioEnabled to true on Android, or you will run into a fatal crash.

`xml

package="com.jwplayer.rnjwplayer">

















`





$3

Android | iOS | DRM Casting

JWX enables casting by default with a casting button.




#### Android Casting

Follow these steps to enable casting:

1. In app/build.gradle in ext{}, add RNJWPlayerUseGoogleCast = true.
2. In app/build.gradle, add com.google.android.gms:play-services-cast-framework:21.3.0.
3. Create a class that overrides OptionsProvider in your Android codebase:
1. See the reference file android/src/main/java/com/appgoalz/rnjwplayer/CastOptionsProvider.java.
2. Replace .setTargetActivityClassName(RNJWPlayerView.class.getName()) with your player Activity.
3. Modify the file with any options necessary for your use case.
4. Add the meta-data to your AndroidManifest.xml.

`xml
android:name="com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="path.to.CastOptionsProvider" />
`




#### iOS Casting

Follow these steps to enable casting:

1. Enable casting to Chromecast devices.
2. Add $RNJWPlayerUseGoogleCast = true to your Podfile. This setting will install google-cast-sdk pod.
3. Edit Info.plist with the following values.

`text
'NSBluetoothAlwaysUsageDescription' => 'We will use your Bluetooth for media casting.',
'NSBluetoothPeripheralUsageDescription' => 'We will use your Bluetooth for media casting.',
'NSLocalNetworkUsageDescription' => 'We will use the local network to discover Cast-enabled devices on your WiFi network.',
'Privacy - Local Network Usage Description' => 'We will use the local network to discover Cast-enabled devices on your WiFi network.'
'NSMicrophoneUsageDescription' => 'We will use your Microphone for media casting.'
`




| Available Method | Description |
| --- | --- |
| castState(GCKCastState) | Gets the cast state
See: GCKCastState |

##### GCKCastState

`text
typedef NS_ENUM(NSUInteger, GCKCastState) {
/* No Cast session is established, and no Cast devices are available. /
GCKCastStateNoDevicesAvailable = 0,
/* No Cast session is establishd, and Cast devices are available. /
GCKCastStateNotConnected = 1,
/* A Cast session is being established. /
GCKCastStateConnecting = 2,
/* A Cast session is established. /
GCKCastStateConnected = 3,
};
`

#### DRM Casting
Casting your DRM protected content requires some additional configuration and most likely a custom Chromecast Receiver.

See our Android and iOS documentation about creating (iOS / Android) and sending data (iOS / Android) for more information.

To send custom data to your receiver, use the userInfo prop and avoid using the reserved sources key, as the JWX SDK will append the DRM source information here for you to parse in your DRM enabled receiver.





$3

Enable digital rights management (DRM) protected playback.

💡 Check out the DRMExample in the Example app. The DRMExample cannot be run in the Simulator. Additionally, the window will not show on an Android Emulator.




#### Android DRM

Only Widevine is supported.

Follow these steps to enable DRM:
1. Set up your Android app for DRM playback.
2. Define config.playlist with the JWX signed URL of the media to play in the player.

❗️DO NOT sign and store your API secerets from your application.❗️

If you use a different provider for DRM or this does not work for your use case, conforming to a similiar format as a JWX signed URL response is optimal, such as adding the drm field to the sources for a playlist item).




#### iOS DRM

Only Fairplay is supported.

The below is currently not fully supported by the iOS SDK, so please refer to Example app, or the legacy DRM documentation. For now, you must still provide the DRM asset in the config.playlist as a legacy object [{fairplayCertUrl: string,processSpcUrl: string,file: string}]

> Follow these steps to enable DRM:
> 1. Set up your iOS app for DRM playback.
> 2. Define config.playlist with the JWX signed URL of the media to play in the player.
>
> ❗️DO NOT sign and store your API secerets from your application.❗️
>
If you use a different provider for DRM or this does not work for your use case, conforming to a similiar format as a JWX signed URL response is optimal, such as adding the drm field to the sources for a playlist item).





$3

Android | iOS

#### Android PiP

1. Read and understand the requirements for PiP in the Android SDK.
2. In the activity where the player is embedded, add the following code.
`java
@Override
public void onPictureInPictureModeChanged(boolean isInPictureInPictureMode, Configuration newConfig) {
super.onPictureInPictureModeChanged(isInPictureInPictureMode, newConfig);

Intent intent = new Intent("onPictureInPictureModeChanged");
intent.putExtra("isInPictureInPictureMode", isInPictureInPictureMode);
intent.putExtra("newConfig", newConfig);
this.sendBroadcast(intent);
}
`




#### iOS PiP

1. Read and understand the requirements for PiP in the iOS SDK. PiP mode is enabled by JWX for the PlayerViewController.
2. (viewOnly:true only) Set the pipEnabled prop to true.
3. (viewOnly:true only) Call togglePIP() to enable or disable PiP.
4. Ensure category and/or categoryOptions prop(s) are set to define and configure your media. This is required to setup the audio session. If category is not defined but pipEnabled is set true, we default to the standard playback category to avoid crashing.





$3

Android | iOS

#### Android Styling
The styling` prop will not work with Android when using the modern configuration system. Android styling should be handled through XML resource overrides (see below).

Android styling is best handled through overring JWX IDs in your apps resources files. See the documentation here.

A sample of overring a color via XML can be seen in this colors file. The color specified here is the default, but if you wish to change it, the color will be updated on the player.

#### iOS Styling
You can use the styling elements as defined in the Legacy Readme.

Contributions

We welcome thoughtful contributions. To avoid duplicate work, review the following before opening a pull request (PR):
- Ensure your contribution applies directly to an open issue.
- When appropriate, develop solutions that can be applied to multiple use cases and implementations.
- Submit small, well-scoped pull requests.

Follow these steps to contribute:
1. Review an issue.
2. Create a pull request to propose a solution.

Issues

To ensure issues are efficiently addressed, we outline our expectations, define what we support, and explain how to submit issues below.

$3

If you’re filing an issue, follow the Try → Wait → Fork model:
- Try first. Investigate the bug. If you find the cause, submit a fix. We focus on issues backed by effort.
- Wait patiently. We prioritize our core Native SDK development over this React-Native repository. Responses here may be delayed.
- Fork when needed. For one-off use cases, fork the repo. We only support changes with broad value.

$3

We focus on work that delivers the greatest long-term value to the broader community. The following categories are listed in order of priority:
1. Breakages and critical bugs caused by updates to the Native SDKs.
2. Critical bugs in the wrapper that can be reproduced in the Example app.
3. Structural issues that impact long-term maintainability.
4. New features that align with official SDK capabilities and benefit the broader community. _Note: These are prioritized lower than bugs and will be addressed only as time allows._

$3

Follow these steps to submit an issue:
1. Submit a bug report, feature request, implementation request, or question in this project. _Note: All information requested in the submission template must be provided. If any item is not applicable, enter "N/A"._
2. (Optional) Submit a JWP support request when you need to share sensitive information.