# react-native-jw-media-player-applicaster
> React-native Android/iOS plugin for JWPlayer SDK (https://www.jwplayer.com/)
Latest version **0.0.6** (published 2020-05-26) · MIT license · 0 weekly downloads
## Install
```sh
npm install react-native-jw-media-player-applicaster
pnpm add react-native-jw-media-player-applicaster
yarn add react-native-jw-media-player-applicaster
bun add react-native-jw-media-player-applicaster
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; pre 1.0.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 0.0.6 |
| Published | 2020-05-26 |
| First published | 2020-04-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 179 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Applicaster |
| Maintainers | applicaster-devs |
| Keywords | react, react-native, jwplayer, media, player, mediaplayer, media-player, jw, android, ios, audio, video, sdk |
## Links
- npm: https://www.npmjs.com/package/react-native-jw-media-player-applicaster
- Repository: https://github.com/applicaster/react-native-jw-media-player
- Homepage: https://github.com/applicaster/react-native-jw-media-player#readme
- Issues: https://github.com/applicaster/react-native-jw-media-player/issues
- npm.io page: https://npm.io/package/react-native-jw-media-player-applicaster
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 0.0.6 (latest) — 2020-05-26
- 0.0.5 — 2020-05-07
- 0.0.4 — 2020-05-07
- 0.0.3 — 2020-05-07
- 0.0.2 — 2020-04-22
- 0.0.1 — 2020-04-21
## README
# react-native-jw-media-player
### A react-native bridge for JWPlayer native SDK's
## Getting started
`npm i react-native-jw-media-player --save`
### Mostly automatic installation
Since **React Native 0.60** and higher, [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) makes the installation process simpler.
On iOS you have to run `cd ios/` && `pod install`.
On Android the package is automatically linked.
### Using React Native Link (React Native 0.59 and lower)
Link module with
`$ react-native link react-native-jw-media-player`
Then add SDK dependencies:
#### Add dependencies
##### iOS dependencies
Follow official instructions [iOS sdk installation](https://developer.jwplayer.com/jwplayer/docs/ios-getting-started) for installation via Cocoapods (only supported, other way wasn't tested).
Add `pod 'JWPlayer-SDK', '~> 3.5.0'` to your Podfile.
Then run **pod install** from your `ios` directory.
In your `info.plist` properties file, create a string entry named `JWPlayerKey`, and set its value to be your JW Player Beta license key. Make sure you enter this string exactly as you received it from JW Player, or as it appears in your JW Player Dashboard. The string is case-sensitive.
##### Android dependencies
Follow official instructions [Android sdk installation](https://developer.jwplayer.com/jwplayer/docs/android-getting-started)
Insert the following lines inside the allProjects.dependencies block in `android/build.gradle`:
```
maven{
url 'https://mvn.jwplayer.com/content/repositories/releases/'
}
```
As so
```
allprojects {
repositories {
mavenLocal()
maven {
// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
url("$rootDir/../node_modules/react-native/android")
}
maven {
// Android JSC is installed from npm
url("$rootDir/../node_modules/jsc-android/dist")
}
google()
jcenter()
maven { url 'https://jitpack.io' }
// Add these lines
maven{
url 'https://mvn.jwplayer.com/content/repositories/releases/'
}
}
}
```
Add to AndroidManifest.xml in the Application tag above the Activity tag:
```
```
... and these lines (This is needed for the controls bar in notification center).
```
```
and this line to the dependencies block in `android/app/build.gradle` (also needed for the controls bar in notification center).
```
implementation 'androidx.media:media:1.1.0'
```
JW uses some of google services in their sdk so if you get an error about any missing google services (e.g. `ERROR: Failed to resolve: com.google.android.gms:play-services-ads-identifier:16.0.0`) you can add this line to the dependencies block in `android/app/build.gradle`:
```
api 'com.google.android.gms:play-services-base:+'
```
### Manual installation
#### iOS
1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
2. Go to `node_modules` ➜ `react-native-jwplayer` and add `RNJWPlayer.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRNJWPlayer.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
4. Add [dependencies](#ios-dependencies)
5. Run your project (`Cmd+R`)<
#### Android
1. Open up `android/app/src/main/java/[...]/MainApplication.java`
- Add `import net.gamesofton.rnjwplayer.RNJWPlayerPackage;` to the imports at the top of the file
- Add `new RNJWPlayerPackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
```
include ':react-native-jwplayer'
project(':react-native-jwplayer').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-jwplayer/android')
```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```
implementation project(':react-native-jwplayer')
```
4. Add [dependencies](#android-dependencies)
## Usage
```javascript
...
import JWPlayer from 'react-native-jw-media-player';
...
const styles = StyleSheet.create({
container: {
flex: 1,
},
player: {
flex: 1,
},
});
...
const playlistItem = {
title: 'Track',
mediaId: -1,
image: 'http://image.com/image.png',
desc: 'My beautiful track',
time: 0,
file: 'http://file.com/file.mp3',
autostart: true,
controls: true,
repeat: false,
displayDescription: true,
displayTitle: true
}
...
componentDidMount() {
// Not Recommended - load the playlistItem into the player with loadPlaylistItem method
/*
setTimeout(() => {
this.JWPlayer.loadPlaylistItem(playlistItem);
// for playlist
// const playlist = [playlistItem, playlistItem]
// this.JWPlayer.loadPlaylist(playlistItem);
}, 100)
*/
}
...
render() {
...
(this.JWPlayer = p)}
style={styles.player}
playlistItem={playlistItem} // Recommended - pass the playlistItem as a prop into the player
// playlist={[playlistItem]}
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()}
/>
...
}
```
## Run example project
For running example project:
1. Checkout this repository.
2. Go to `Example` directory and run `yarn` or `npm i`
3. Go to `Example/ios` and install Pods with `pod install`
4. Open `demoJWPlayer.xcworkspace` with XCode.
5. Add your iOS api key for JWPlayer into `Info.plist`
##### PlaylistItem
| Prop | Description | Type |
| ------------------------ | ------------------------------------------- | --------- |
| **`mediaId`** | The JW media id. | `Int` |
| **`file`** | The url of the file to play. | `String` |
| **`title`** | The title of the track. | `String` |
| **`image`** | The url of the player thumbnail. | `String` |
| **`autostart`** | Should the track auto start. | `Boolean` |
| **`time`** | should the player seek to a certain second. | `Int` |
| **`desc`** | Description of the track. | `String` |
| **`controls`** | Should the control buttons show. | `Boolean` |
| **`repeat`** | Should the track repeat. | `Boolean` |
| **`displayDescription`** | Should the player show the description. | `Boolean` |
| **`displayTitle`** | Should the player show the title. | `Boolean` |
## Available props
| Prop | Description | Type |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| **`mediaId`** | The JW media id. | `Int` |
| **`file`** | The url of the file to play. | `String` |
| **`title`** | The title of the track. | `String` |
| **`image`** | The url of the player thumbnail. | `String` |
| **`autostart`** | Should the track auto start. | `Boolean` |
| **`time`** | should the player seek to a certain second. | `Int` |
| **`desc`** | Description of the track. | `String` |
| **`controls`** | Should the control buttons show. | `Boolean` |
| **`repeat`** | Should the track repeat. | `Boolean` |
| **`displayDescription`** | Should the player show the description. | `Boolean` |
| **`displayTitle`** | Should the player show the title. | `Boolean` |
| **`playlistItem`** | An object of playlistItem shape. | [PlaylistItem](#PlaylistItem) |
| **`playlist`** | An array of playlistItems. | `[playlistItem]` see [PlaylistItem](#PlaylistItem)] |
| **`nextUpDisplay`** | Should the player show the next up item in a playlist. | `Boolean` |
| **`playerStyle`** | Name of css file you put in the Main Bundle for you custom style. See below [Custom-style](#Custom-style) section. | `String` |
| **`colors`** | Object with colors in hex format (without hashtag), for the icons and progress bar See below [Colors](#Colors) section. | `Object` |
| **`nativeFullScreen`** | When this is true the player will go into full screen on the native layer automatically without the need to manage the full screen request in js onFullScreen callback | `Boolean` |
| **`fullScreenOnLandscape`** | When this is true the player will go into full screen on rotate of phone to landscape | `Boolean` |
| **`landscapeOnFullScreen`** | When this is true the player will go into landscape orientation when on full screen | `Boolean` |
| **`portraitOnExitFullScreen`** | `Available on Android.` When this is true the player will go into portrait orientation when exiting full screen | `Boolean` |
| **`exitFullScreenOnPortrait`** | `Available on Android.` When this is true the player will exit full screen when the phone goes into portrait | `Boolean` |
## Available methods
| Func | Description | Argument |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| **`seekTo`** | Tells the player to seek to position, use in onPlaylistItem callback so player finishes buffering file. | `Int` |
| **`play`** | Starts playing. | `none` |
| **`pause`** | Pauses playing. | `none` |
| **`stop`** | Stops the player completely. | `none` |
| **`state`** | Returns the current state of the player `idle`, `buffering`, `playing`, `paused`. | `none` |
| **`position`** | Returns promise that then returns the current position of the player in seconds. | `none` |
| **`toggleSpeed`** | Toggles the player speed one of `0.5`, `1.0`, `1.5`, `2.0`. | `none` |
| **`setPlaylistIndex`** | Sets the current playing item in the loaded playlist. | `Int` |
| **`setControls`** | Sets the display of the control buttons on the player. | `Boolean` |
| **`loadPlaylist`** | Loads a playlist. (Using this function before the player has finished initializing may result in assert crash or blank screen, put in a timeout to make sure JWPlayer is mounted). | `[PlaylistItems]` |
| **`loadPlaylistItem`** | Loads a playlist item. (Using this function before the player has finished initializing may result in assert crash or blank screen, put in a timeout to make sure JWPlayer is mounted). | [PlaylistItem](#PlaylistItem) |
## Available callbacks
| Func | Description | Argument |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`onPlaylist`** | A new playlist is loaded. | `[playlistItem]` see [PlaylistItem](#PlaylistItem) |
| **`onPlayerReady`** | The player has finished setting up and is ready to play. | `none` |
| **`onBeforePlay`** | Right before playing. | `none` |
| **`onBeforeComplete`** | Right before playing completed and is starting to play. | `none` |
| **`onPlay`** | Player started playing. | `none` |
| **`onPause`** | Player paused playing. | `none` |
| **`onSetupPlayerError`** | Player faced and error while setting up the player. | `{error: String}` |
| **`onPlayerError`** | Player faced an error after setting up the player but when attempting to start playing. | `{error: String}` |
| **`onBuffer`** | The player is buffering. | `none` |
| **`onTime`** | Interval callback for every millisecond playing. | `{time: double, duration: double}` |
| **`onFullScreen`** | User clicked on the fullscreen icon. Use this to resize the container view for the player. (Make use of https://github.com/yamill/react-native-orientation for fullscreen mode) | `none` |
| **`onFullScreenExit`** | User clicked on the fullscreen icon to exit. | `none` |
| **`onPlaylistItem`** | When starting to play a playlist item. | JW type playlist item see docs [ios](https://developer.jwplayer.com/sdk/ios/reference/Protocols/JWPlaylistItemEvent.html), [android](https://developer.jwplayer.com/sdk/android/reference/com/longtailvideo/jwplayer/events/PlaylistItemEvent.html) contains additional index of current playing item in playlist 0 for default |
##### Custom-style
For setting a custom style on the player:
1. Check out the [JW player guide](https://developer.jwplayer.com/jw-player/docs/developer-guide/customization/css-skinning/skins_reference/) for adding a custom css file on your player.
2. Put your custom css file in the root folder of your native files.
3. Add the prop `playerStyle` to the player and set to the name of your css file without the .css file type e.g. `playerStyle={'myCssFile'}`.
4. build & run.
##### Colors
To set the colors of icons and progress bar pass to the player a prop as such.
Note: It is expected to pass the colors in hex format without the hashtag example for white FFFFFF.
```javascript
colors: PropTypes.shape({
icons: PropTypes.string,
timeslider: PropTypes.shape({
progress: PropTypes.string,
rail: PropTypes.string
})
})
```
### Background Audio
This package supports Background audio sessions just follow the jwplayer docs for background session.
Here for Android https://developer.jwplayer.com/sdk/android/docs/developer-guide/interaction/audio/ although this package handles background audio playing in android as is and you shouldn't have to make any additional changes.
Here for iOS https://developer.jwplayer.com/sdk/ios/docs/developer-guide/embedding/features/ under Background Audio section.
You need to edit the AppDelegate.h file in iOS
Here is a complete example - iOS:
```
#import
#import
NSString* const AudioInterruptionsDidStart = @"AudioInterruptionsStarted";
NSString* const AudioInterruptionsDidEnd = @"AudioInterruptionsEnded";
@implementation AppDelegate
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary
*)launchOptions
{
AVAudioSession *audioSession = [AVAudioSession sharedInstance];
[[NSNotificationCenter defaultCenter] addObserver: self
selector: @selector(audioSessionInterrupted:)
name: AVAudioSessionInterruptionNotification
object: audioSession];
NSError *setCategoryError = nil;
BOOL success = [audioSession setCategory:AVAudioSessionCategoryPlayback
error:&setCategoryError];
NSError *activationError = nil;
success = [audioSession setActive:YES error:&activationError];
}
-(void)audioSessionInterrupted:(NSNotification*)note
{
if ([note.name isEqualToString:AVAudioSessionInterruptionNotification]) {
NSLog(@"Interruption notification");
if ([[note.userInfo valueForKey:AVAudioSessionInterruptionTypeKey] isEqualToNumber:[NSNumber
numberWithInt:AVAudioSessionInterruptionTypeBegan]]) {
[[NSNotificationCenter defaultCenter] postNotificationName:AudioInterruptionsDidStart object:self
userInfo:nil];
} else {
[[NSNotificationCenter defaultCenter] postNotificationName:AudioInterruptionsDidEnd object:self
userInfo:nil];
}
}
}
```
---
_Source: https://npm.io/package/react-native-jw-media-player-applicaster · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._