⚠️ 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 JWP's JWPlayerKit
(iOS) and SDK 4 (Android).
Prerequisites | Installation | Usage | Advanced Topics | Contributing | Issues
The jwplayer-react-native
library is a bridge that enables using the native JWP Android and iOS SDKs in React Native applications.
Before installing and using the library, you need the following items:
Follow these steps to add the library to your Android project:
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
In android/build.gradle, add the JWP Maven repository inside the allprojects
block.
allprojects {
repositories {
...
maven {
url 'https://mvn.jwplayer.com/content/repositories/releases/'
}
For more details and guidance regarding configuration and requirements, see the JWP Android SDK documentation.
Follow these steps to add the library to your iOS project:
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
Change the directory to the iOS folder of your React Native project.
cd ios/
Install the iOS dependencies with CocoaPods.
pod install
For more details and guidance regarding configuration and requirements, see the JWP iOS SDK documentation.
The following example shows how you can enhance your React Native application by seamlessly integrating the multimedia playback functionalities of the JWP mobile SDKs.
Follow these steps to configure the media playback experience in your app:
Use the following example as a guide to configure the media playback experience. Be sure to remove all instances of ...
from the code.
...
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() {
...
<View style={styles.container}>
<JWPlayer
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)}
onFullScreen={() => this.onFullScreen()}
onFullScreenExit={() => this.onFullScreenExit()}
/>
</View>
...
}
Define config.license
with your Android or iOS JWP license key.
Define config.playlist
with the media to play in the player.
(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.
This repository contains the Example project. This project showcases several basic implementations of the <JWPlayer>
view and can be used as a resource while working with the jwplayer-react-native
library:
Follow these steps to run the example project:
yarn
or npm i
.pod install
config
prop, add your JWP SDK license key.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.
Advertising | Background Audio | Casting | DRM | Picture in Picture (PiP) | Styling
Follow this step to set up advertising with IMA or DAI:
ext{}
, add RNJWPlayerUseGoogleIMA = true
. This setting will add the following dependencies: com.google.ads.interactivemedia.v3:interactivemedia:3.31.0
and com.google.android.gms:play-services-ads-identifier:18.0.1
.Follow this step to set up advertising with IMA or DAI:
ext{}
, add $RNJWPlayerUseGoogleIMA = true
. This setting will add GoogleAds-IMA-iOS-SDK
to the pod.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:
backgroundAudioEnabled
to true
in the config
.JWP enables casting by default with a casting button.
Follow these steps to enable casting:
ext{}
, add RNJWPlayerUseGoogleCast = true
.com.google.android.gms:play-services-cast-framework:21.3.0
.OptionsProvider
in your Android codebase:
.setTargetActivityClassName(RNJWPlayerView.class.getName())
with your player Activity.Add the meta-data
to your AndroidManifest.xml.
<meta-data
android:name="com.google.android.gms.cast.framework.OPTIONS_PROVIDER_CLASS_NAME"
android:value="path.to.CastOptionsProvider" />
Follow these steps to enable casting:
$RNJWPlayerUseGoogleCast = true
to your Podfile. This setting will install google-cast-sdk
pod.Edit Info.plist with the following values.
'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 |
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,
};
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.
Only Widevine is supported.
Follow these steps to enable DRM:
config.playlist
with the JWP 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 JWP signed URL response is optimal, such as adding the drm
field to the sources
for a playlist item).
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:
- Set up your iOS app for DRM playback.
- Define
config.playlist
with the JWP 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 JWP signed URL response is optimal, such as adding the
drm
field to thesources
for a playlist item).
In the activity where the player is embedded, add the following code.
@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);
}
PlayerViewController
.pipEnabled
prop to true
.togglePIP()
to enable or disable PiP.The styling
prop will not work when using the modern prop convention that matches the JWP Delivery API. Even when using the forceLegacyConfig
prop, Android may not respect your choices.
Android styling is best handled through overring JWP 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.
You can use the styling elements as defined in the Legacy Readme.
Issue
number and additional, potentially proprietary/sensitive information.