JW Player is the world's most popular embeddable media player.
Switch branches/tags
Clone or download
Latest commit 0fc9082 Nov 13, 2018
Permalink
Failed to load latest commit information.
.github Hook: Run Karma Locally (#2284) Aug 29, 2017
assets Remove old font icons Sep 26, 2017
docs v8.6.1 Oct 29, 2018
libs-external Fix playlist error handling after api.load Nov 12, 2015
src Fix starttime regression Nov 13, 2018
test Use isDvr in html5, and add module doc comments and tests Oct 26, 2018
.eslintrc Always use Promise global Sep 12, 2018
.gitignore Remove npm package-lock Apr 3, 2018
.npmignore Update npmignore file Sep 22, 2017
.project.default default FlashBuilder files May 15, 2014
.stylelintrc Add custom element to stylelintrc Sep 19, 2018
.travis.yml Add DangerJS (#2736) Feb 22, 2018
CONTRIBUTING.md New docs (#1654) Jan 5, 2017
Gruntfile.js Add coverage for all events triggered by UI.js Jul 12, 2018
LICENSE Adding our CC license, human-readable version below Jul 1, 2014
README.md Add framework integration table & add micnews react library (#3059) Nov 9, 2018
_config.yml Set theme jekyll-theme-minimal Jul 6, 2017
accessibility.md Deprecate Dock Jul 25, 2017
browserslist Improve timeslider UI and controlbar background (#2246) Aug 21, 2017
dangerfile.js Add DangerJS (#2736) Feb 22, 2018
jwplayer.license.notice.js Add license banner to JS build output (#2759) Mar 6, 2018
karma.conf.js introduce normalization and merge helpers Sep 27, 2018
package.json v8.6.3 Nov 9, 2018
postcss.config.js Add drop shadow variant for idle state JW8-1668 Jul 2, 2018
webpack.config.js retrieve language json files Sep 17, 2018
yarn.lock Update Linting Dependencies Oct 24, 2018

README.md

JW Player Logo

Plays everywhere, every time.

Live on over 2 million sites with 1.3 billion unique plays per month, JW Player is the solution for seamless video playback across browsers and media types. It empowers the developer to interact with video programmatically to create unique and awesome user experiences.

Disclaimer

This is the non-commercial version of JW Player. It does not contain the same features as the commercial-use player available from jwplayer.com. Commercial use and access to features requires a license. Learn more at https://www.jwplayer.com/pricing/. If you are a paid customer and want a player, please download it from the "Downloads" section of your JW Dashboard.

Official Documentation

A Simple Example

The example below will render a video player into the div with the player id, listens to an event, and makes a few calls using the API.

<!DOCTYPE html>
<html>
<head>
    <script src='LINK_TO_YOUR_PLAYER'></script>
    <script>jwplayer.key='YOUR_KEY';</script>
</head>
<body>
    <div id="player">Loading the player...</div>
    <script>
        // Setup the player
        const player = jwplayer('player').setup({
            file: 'LINK_TO_YOUR_FILE.mp4'
        });

        // Listen to an event
        player.on('pause', (event) => {
            alert('Why did my user pause their video instead of watching it?');
        });

        // Call the API
        const bumpIt = () => {
            const vol = player.getVolume();
            player.setVolume(vol + 10);
        }
        bumpIt();
    </script>
</body>
</html>

Contributing

We appreciate all contributions towards the player! Before submitting an issue or PR, please see our contributing docs here.

Building the Player

We use grunt and a few npm scripts to build the player, lint code, and run tests. Debug code is built to /bin-debug, while minified & uglified code is built to /bin-release. Code is built with webpack, linted with eslint, and tested with karma, mocha and chai.

Requirements:

  • Node.js with npm
  • yarn is preferred for package management
  • Install global npm dependencies yarn global add eslint grunt-cli jsdoc karma-cli stylelint webpack webpack-cli

Steps:

  1. Fork the project, clone your fork, and set up the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/jwplayer
# Navigate to the newly cloned directory
cd jwplayer
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/jwplayer/jwplayer
  1. Install the dependencies:
# Install dependencies
yarn global add eslint grunt-cli jsdoc karma-cli stylelint webpack webpack-cli
yarn install
# Optionally, install webpack-dev-server
yarn global add webpack-dev-server
  1. Build the player:
# Build once
grunt
# Complete Watch - builds JS, lints, and tests on each change
grunt serve
# Quick JS Watch - build only. Requires webpack-dev-server to be installed globally
webpack-dev-server -w --env.debug --port 8888 --output-public-path /bin-debug/
# Open the test page from another terminal window
open http://localhost:8888/test/manual/
  1. Test your code:
# All browsers
grunt test
# Individual browsers - chrome, firefox, safari
grunt karma:{BROWSER} e.g. grunt karma:chrome
  1. Lint your code:
yarn run lint
  1. Setup git pre-push hook This will add a pre-push script to the project's .git/hooks folder that will lint and run unit tests on the branch before any push.
grunt hooks

Framework Integration

While the JW team does not maintain any framework integrations of our own, there are developers in our community who do. We recommend the following libraries:

Framework Link
React https://github.com/micnews/react-jw-player

If you have a library which you believe is good enough to meet the needs of other developers using a certain framework, please open a pull request modifying the above table.

Software License

The use of this library is governed by a Creative Commons license. You can use, modify, copy, and distribute this edition as long as it’s for non-commercial use, you provide attribution, and share under a similar license. http://www.jwplayer.com/license/