JSPM

react-player

0.3.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1093497
  • Score
    100M100P100Q177314F
  • License MIT

A react component for playing a variety of URLs, including file paths, YouTube, SoundCloud and Vimeo

Package Exports

  • react-player
  • react-player/lib/players/FilePlayer
  • react-player/lib/players/YouTube

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-player) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ReactPlayer

Latest npm version Build Status Dependency Status devDependency Status

A react component for playing media from YouTube, SoundCloud and Vimeo, as well as supported media files.

The component parses a URL and loads in the appropriate markup and external SDKs to play media from various sources. Props can be passed in to control playback and react to events such as buffering or media ending.

Usage

npm install react-player --save
import React, { Component } from 'react'
import ReactPlayer from 'react-player'

class App extends Component {
  render () {
    <ReactPlayer
      url='https://www.youtube.com/watch?v=ysz5S6PUM-U'
      playing={true}
    />
  }
}

See App.js for a full example

Demo

The quickest way to see it in action is to checkout the repo and run the demo:

git clone http://github.com/cookpete/react-player
cd react-player
npm install
npm start
open http://localhost:3000

Props

Prop Description
url The url of a video or song to play
playing Set to true or false to pause or play the media
volume Sets the volume of the appropriate player
width Sets the width of the player
height Sets the height of the player
onProgress Callback containing played and loaded progress as a fraction eg { played: 0.12, loaded: 0.34 }
onPlay Called when media starts or resumes playing after pausing or buffering
onPause Called when media is paused
onBuffer Called when media starts buffering
onEnded Called when media finishes playing
onError Called when an error occurs whilst attempting to play media

Config props

These props allow you to override the parameters for the various players

Prop Description
soundcloudConfig Configuration object for the SoundCloud player. Set clientId, to your own SoundCloud app client ID
vimeoConfig Configuration object for the Vimeo player. Set iframeParams, to override the default params. Set preload for preloading
youtubeConfig Configuration object for the YouTube player. Set playerVars, to override the default player vars. Set preload for preloading
Preloading

Both youtubeConfig and vimeoConfig props can take a preload value. Setting this to true will play a short, silent video in the background when ReactPlayer first mounts. This fixes a bug where videos would not play when loaded in a background browser tab.

Methods

There is a static method ReactPlayer.canPlay(url) to determine if a URL can be played by the media player. Note that this does not detect media that is unplayable due to streaming permissions etc. In that case, onError will occur after attemping to play.

To seek to a certain part of the media, there is a seekTo(fraction) instance method that will seek to the appropriate place in the media. See App.js for an example of this using refs.

Supported Media

Linting

This project uses standard code style.

npm run lint

Testing

This project uses mocha with chai assertions for unit testing.

npm run test

Thanks