Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CookPete/react-player

A React component for playing a variety of URLs, including file paths, YouTube, Facebook, Twitch, SoundCloud, Streamable, Vimeo, Wistia and DailyMotion
https://github.com/CookPete/react-player

audio dailymotion dash facebook hls media player react soundcloud streamable twitch video vimeo wistia youtube

Last synced: about 2 months ago
JSON representation

A React component for playing a variety of URLs, including file paths, YouTube, Facebook, Twitch, SoundCloud, Streamable, Vimeo, Wistia and DailyMotion

Awesome Lists containing this project

README 

        


  ReactPlayer






  Latest npm version

  Test Coverage

  Become a sponsor on Patreon






  A React component for playing a variety of URLs, including file paths, YouTube, Facebook, Twitch, SoundCloud, Streamable, Vimeo, Wistia, Mixcloud, DailyMotion and Kaltura. Not using React? No problem.




---



> Using Next.js and need to handle video upload/processing? Check out [next-video](https://github.com/muxinc/next-video).



### ✨ The future of ReactPlayer



Maintenance of ReactPlayer is being taken over by [Mux](https://www.mux.com). Mux is a [video api](https://www.mux.com/video-api) for developers. The team at Mux have worked on many highly respected projects and are committed to improving video tooling for developers.



ReactPlayer will remain open source, but with a higher rate of fixes and releases over time. Thanks to everyone in the community for your ongoing support.



### Usage



```bash

npm install react-player # or yarn add react-player

```



```jsx

import React from 'react'

import ReactPlayer from 'react-player'



// Render a YouTube video player



```



By default, ReactPlayer supports [many different types](#supported-media) of `url`. If you only ever use one type, use imports such as `react-player/youtube` to reduce your bundle size. See [config keys](#config-prop) for all player keys.



```jsx

import React from 'react'

import ReactPlayer from 'react-player/youtube'



// Only loads the YouTube player



```



If your build system supports `import()` statements, use `react-player/lazy` to lazy load the appropriate player for the `url` you pass in. This adds several `reactPlayer` chunks to your output, but reduces your main bundle size.



```jsx

import React from 'react'

import ReactPlayer from 'react-player/lazy'



// Lazy load the YouTube player



```



Demo page: [`https://cookpete.github.io/react-player`](https://cookpete.github.io/react-player)



The component parses a URL and loads in the appropriate markup and external SDKs to play media from [various sources](#supported-media). [Props](#props) can be passed in to control playback and react to events such as buffering or media ending. See [the demo source](https://github.com/cookpete/react-player/blob/master/examples/react/src/App.js) for a full example.



For platforms without direct use of `npm` modules, a minified version of `ReactPlayer` is located in `dist` after installing. To generate this file yourself, checkout the repo and run `npm run build:dist`.



#### Autoplay



As of Chrome 66, [videos must be `muted` in order to play automatically](https://www.theverge.com/2018/3/22/17150870/google-chrome-autoplay-videos-sound-mute-update). Some players, like Facebook, cannot be unmuted until the user interacts with the video, so you may want to enable `controls` to allow users to unmute videos themselves. Please set `muted={true}`.



### Props



Prop | Description | Default

---- | ----------- | -------

`url` | The url of a video or song to play
  ◦  Can be an [array](#multiple-sources-and-tracks) or [`MediaStream`](https://developer.mozilla.org/en-US/docs/Web/API/MediaStream) object

`playing` | Set to `true` or `false` to pause or play the media | `false`

`loop` | Set to `true` or `false` to loop the media | `false`

`controls` | Set to `true` or `false` to display native player controls.
  ◦  For Vimeo videos, hiding controls must be enabled by the video owner. | `false`

`light` | Set to `true` to show just the video thumbnail, which loads the full player on click
  ◦  Pass in an image URL to override the preview image | `false`

`volume` | Set the volume of the player, between `0` and `1`
  ◦  `null` uses default volume on all players [`#357`](https://github.com/cookpete/react-player/issues/357) | `null`

`muted` | Mutes the player
  ◦  Only works if `volume` is set | `false`

`playbackRate` | Set the playback rate of the player
  ◦  Only supported by YouTube, Wistia, and file paths | `1`

`width` | Set the width of the player | `640px`

`height` | Set the height of the player | `360px`

`style` | Add [inline styles](https://facebook.github.io/react/tips/inline-styles.html) to the root element | `{}`

`progressInterval` | The time between `onProgress` callbacks, in milliseconds | `1000`

`playsinline` | Applies the `playsinline` attribute where supported | `false`

`pip` | Set to `true` or `false` to enable or disable [picture-in-picture mode](https://developers.google.com/web/updates/2018/10/watch-video-using-picture-in-picture)
  ◦  Only available when playing file URLs in [certain browsers](https://caniuse.com/#feat=picture-in-picture) | `false`

`stopOnUnmount` | If you are using `pip` you may want to use `stopOnUnmount={false}` to continue playing in picture-in-picture mode even after ReactPlayer unmounts | `true`

`fallback` | Element or component to use as a fallback if you are using lazy loading | `null`

`wrapper` | Element or component to use as the container element | `div`

`playIcon` | Element or component to use as the play icon in light mode

`previewTabIndex` | Set the tab index to be used on light mode | 0

`config` | Override options for the various players, see [config prop](#config-prop)



#### Callback props



Callback props take a function that gets fired on various player events:



Prop | Description

---- | -----------

`onReady` | Called when media is loaded and ready to play. If `playing` is set to `true`, media will play immediately

`onStart` | Called when media starts playing

`onPlay` | Called when media starts or resumes playing after pausing or buffering

`onProgress` | Callback containing `played` and `loaded` progress as a fraction, and `playedSeconds` and `loadedSeconds` in seconds
  ◦  eg `{ played: 0.12, playedSeconds: 11.3, loaded: 0.34, loadedSeconds: 16.7 }`

`onDuration` | Callback containing duration of the media, in seconds

`onPause` | Called when media is paused

`onBuffer` | Called when media starts buffering

`onBufferEnd` | Called when media has finished buffering
  ◦  Works for files, YouTube and Facebook

`onSeek` | Called when media seeks with `seconds` parameter

`onPlaybackRateChange` | Called when playback rate of the player changed
  ◦  Only supported by YouTube, Vimeo ([if enabled](https://developer.vimeo.com/player/sdk/reference#playbackratechange)), Wistia, and file paths

`onPlaybackQualityChange` | Called when playback quality of the player changed
  ◦  Only supported by YouTube ([if enabled](https://developers.google.com/youtube/iframe_api_reference#Events))

`onEnded` | Called when media finishes playing
  ◦  Does not fire when `loop` is set to `true`

`onError` | Called when an error occurs whilst attempting to play media

`onClickPreview` | Called when user clicks the `light` mode preview

`onEnablePIP` | Called when picture-in-picture mode is enabled

`onDisablePIP` | Called when picture-in-picture mode is disabled



#### Config prop



There is a single `config` prop to override settings for each type of player:



```jsx



```



Settings for each player live under different keys:



Key | Options

--- | -------

`youtube` | `playerVars`: Override the [default player vars](https://developers.google.com/youtube/player_parameters?playerVersion=HTML5)
`embedOptions`: Override the [default embed options](https://developers.google.com/youtube/iframe_api_reference#Loading_a_Video_Player)
`onUnstarted`: Called when state changes to `unstarted` (usually when video fails to autoplay)

`facebook` | `appId`: Your own [Facebook app ID](https://developers.facebook.com/docs/apps/register#app-id)
`version`: Facebook SDK version
`playerId`: Override player ID for consistent server-side rendering (use with [`react-uid`](https://github.com/thearnica/react-uid))
`attributes`: Extra data attributes to pass to the `fb-video` element

`soundcloud` | `options`: Override the [default player options](https://developers.soundcloud.com/docs/api/html5-widget#params)

`vimeo` | `playerOptions`: Override the [default params](https://developer.vimeo.com/player/sdk/embed)
`title`: Set the player `iframe` title attribute

`mux` | `attributes`: Apply [element attributes](https://github.com/muxinc/elements/blob/main/packages/mux-player/REFERENCE.md#attributes)
`version`: Mux player version

`wistia` | `options`: Override the [default player options](https://wistia.com/doc/embed-options#options_list)
`playerId`: Override player ID for consistent server-side rendering (use with [`react-uid`](https://github.com/thearnica/react-uid))

`mixcloud` | `options`: Override the [default player options](https://www.mixcloud.com/developers/widget/#methods)

`dailymotion` | `params`: Override the [default player vars](https://developer.dailymotion.com/player#player-parameters)

`twitch` | `options`: Override the [default player options](https://dev.twitch.tv/docs/embed)
`playerId`: Override player ID for consistent server-side rendering (use with [`react-uid`](https://github.com/thearnica/react-uid))

`file` | `attributes`: Apply [element attributes](https://developer.mozilla.org/en/docs/Web/HTML/Element/video#Attributes)
`forceVideo`: Always render a `` element
`forceAudio`: Always render an `` element
`forceHLS`: Use [hls.js](https://github.com/video-dev/hls.js) for HLS streams
`forceSafariHLS`: Use [hls.js](https://github.com/video-dev/hls.js) for HLS streams, [even on Safari](https://github.com/cookpete/react-player/pull/1560)
`forceDisableHLS`: Disable usage [hls.js](https://github.com/video-dev/hls.js) for HLS streams
`forceDASH`: Always use [dash.js](https://github.com/Dash-Industry-Forum/dash.js) for DASH streams
`forceFLV`: Always use [flv.js](https://github.com/Bilibili/flv.js)
`hlsOptions`: Override the [default `hls.js` options](https://github.com/video-dev/hls.js/blob/master/docs/API.md#fine-tuning)
`hlsVersion`: Override the [`hls.js`](https://github.com/video-dev/hls.js) version loaded from [`jsdelivr`](https://www.jsdelivr.com/package/npm/hls.js), default: `0.13.1`
`dashVersion`: Override the [`dash.js`](https://github.com/Dash-Industry-Forum/dash.js) version loaded from [`cdnjs`](https://cdnjs.com/libraries/dashjs), default: `2.9.2`
`flvVersion`: Override the [`flv.js`](https://github.com/Bilibili/flv.js) version loaded from [`jsdelivr`](https://www.jsdelivr.com/package/npm/flv.js), default: `1.5.0`



### Methods



#### Static Methods



Method | Description

------ | -----------

`ReactPlayer.canPlay(url)` | Determine if a URL can be played. This does *not* detect media that is unplayable due to privacy settings, streaming permissions, etc. In that case, the `onError` prop will be invoked after attempting to play. Any URL that does not match any patterns will fall back to a native HTML5 media player.

`ReactPlayer.canEnablePiP(url)` | Determine if a URL can be played in [picture-in-picture mode](https://developers.google.com/web/updates/2018/10/watch-video-using-picture-in-picture)

`ReactPlayer.addCustomPlayer(CustomPlayer)` | Add a custom player. See [Adding custom players](#adding-custom-players)

`ReactPlayer.removeCustomPlayers()` | Remove any players that have been added using `addCustomPlayer()`



#### Instance Methods



Use [`ref`](https://facebook.github.io/react/docs/refs-and-the-dom.html) to call instance methods on the player. See [the demo app](examples/react/src/App.js) for an example of this.



Method | Description

------ | -----------

`seekTo(amount, type)` | Seek to the given number of seconds, or fraction if `amount` is between `0` and `1`
  ◦  `type` parameter lets you specify `'seconds'` or `'fraction'` to override default behaviour

`getCurrentTime()` | Returns the number of seconds that have been played
  ◦  Returns `null` if unavailable

`getSecondsLoaded()` | Returns the number of seconds that have been loaded
  ◦  Returns `null` if unavailable or unsupported

`getDuration()` | Returns the duration (in seconds) of the currently playing media
  ◦  Returns `null` if duration is unavailable

`getInternalPlayer()` | Returns the internal player of whatever is currently playing
  ◦  eg the [YouTube player instance](https://developers.google.com/youtube/iframe_api_reference#Loading_a_Video_Player), or the [``](https://developer.mozilla.org/en/docs/Web/HTML/Element/video) element when playing a video file
  ◦  Use `getInternalPlayer('hls')` to get the [hls.js](https://github.com/video-dev/hls.js) player
  ◦  Use `getInternalPlayer('dash')` to get the [dash.js](https://github.com/Dash-Industry-Forum/dash.js) player
  ◦  Returns `null` if the internal player is unavailable

`showPreview()` | When using `light` mode, returns to the preview overlay



### Advanced Usage



#### Light player



The `light` prop will render a video thumbnail with simple play icon, and only load the full player once a user has interacted with the image. [Noembed](https://noembed.com) is used to fetch thumbnails for a video URL. Note that automatic thumbnail fetching for Facebook, Wistia, Mixcloud and file URLs are not supported, and ongoing support for other URLs is not guaranteed.



If you want to pass in your own thumbnail to use, set `light` to the image URL rather than `true`.



You can also pass a component through the `light` prop:



```jsx

} />

```



The styles for the preview image and play icon can be overridden by targeting the CSS classes `react-player__preview`, `react-player__shadow` and `react-player__play-icon`.



#### Responsive player



Set `width` and `height` to `100%` and wrap the player in a [fixed aspect ratio box](https://css-tricks.com/aspect-ratio-boxes) to get a responsive player:



```js

class ResponsivePlayer extends Component {

  render () {

    return (

      


        

      


    )

  }

}

```



```css

.player-wrapper {

  position: relative;

  padding-top: 56.25%; /* Player ratio: 100 / (1280 / 720) */

}



.react-player {

  position: absolute;

  top: 0;

  left: 0;

}

```



See [`jsFiddle` example](https://jsfiddle.net/e6w3rtj1/)



#### SDK Overrides



You can use your own version of any player SDK, assuming the correct `window` global is set before the player mounts. For example, to use a local version of [`hls.js`](https://cdnjs.com/libraries/hls.js), add `` to your app. If `window.Hls` is available when ReactPlayer mounts, it will use that instead of loading `hls.js` from `cdnjs`. See [#605](https://github.com/cookpete/react-player/issues/605#issuecomment-492561909) for more information.



#### Standalone player



If you aren’t using React, you can still render a player using the standalone library:



```html



  const container = document.getElementById('container')

  const url = 'https://www.youtube.com/watch?v=d46Azg3Pm4c'



  renderReactPlayer(container, { url, playing: true })



  function pausePlayer () {

    renderReactPlayer(container, { url, playing: false })

  }



```



See [`jsFiddle` example](https://jsfiddle.net/krkcvx9s/)



#### Adding custom players



If you have your own player that is compatible with ReactPlayer’s internal architecture, you can add it using `addCustomPlayer`:



```javascript

import YourOwnPlayer from './somewhere';

ReactPlayer.addCustomPlayer(YourOwnPlayer);

```



Use `removeCustomPlayers` to clear all custom players:



```javascript

ReactPlayer.removeCustomPlayers();

```



It is your responsibility to ensure that custom players keep up with any internal changes to ReactPlayer in later versions.



#### Mobile considerations



Due to various restrictions, `ReactPlayer` is not guaranteed to function properly on mobile devices. The [YouTube player documentation](https://developers.google.com/youtube/iframe_api_reference), for example, explains that [certain mobile browsers require user interaction](https://developers.google.com/youtube/iframe_api_reference#Mobile_considerations) before playing:



> The HTML5 `` element, in certain mobile browsers (such as Chrome and Safari), only allows playback to take place if it’s initiated by a user interaction (such as tapping on the player).



#### Multiple Sources and Tracks



Passing an array of YouTube URLs to the `url` prop will load them as an untitled playlist.



```jsx



```



When playing file paths, an array of sources can be passed to the `url` prop to render multiple `` tags.



```jsx



```



You can also specify a `type` for each source by using objects with `src` and `type` properties.



```jsx



```



[``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/track) elements for subtitles can be added using `config.file`:



```jsx



```



### Migrating to `v2.0`



ReactPlayer `v2.0` changes single player imports and adds lazy loading players. Support for `preload` has also been removed, plus some other changes. See [`MIGRATING.md`](/MIGRATING.md) for information.



### Supported media



* YouTube videos use the [YouTube iFrame Player API](https://developers.google.com/youtube/iframe_api_reference)

* Facebook videos use the [Facebook Embedded Video Player API](https://developers.facebook.com/docs/plugins/embedded-video-player/api)

* SoundCloud tracks use the [SoundCloud Widget API](https://developers.soundcloud.com/docs/api/html5-widget)

* Streamable videos use [`Player.js`](https://github.com/embedly/player.js)

* Vimeo videos use the [Vimeo Player API](https://developer.vimeo.com/player/sdk)

* Mux videos use the [``](https://github.com/muxinc/elements/blob/main/packages/mux-player/README.md) element

* Wistia videos use the [Wistia Player API](https://wistia.com/doc/player-api)

* Twitch videos use the [Twitch Interactive Frames API](https://dev.twitch.tv/docs/embed#interactive-frames-for-live-streams-and-vods)

* DailyMotion videos use the [DailyMotion Player API](https://developer.dailymotion.com/player)

* Vidyard videos use the [Vidyard Player API](https://knowledge.vidyard.com/hc/en-us/articles/360019034753-Using-the-Vidyard-Player-API)

* Kaltura's `react-player` implementation uses the embed.ly [`Player.js`](https://github.com/embedly/player.js) API but Kaltura specific APIs are also available, see [Kaltura Player API](http://player.kaltura.com/docs/index.php?path=kwidget)

* [Supported file types](https://developer.mozilla.org/en-US/docs/Web/HTML/Supported_media_formats) are playing using [``](https://developer.mozilla.org/en/docs/Web/HTML/Element/video) or [``](https://developer.mozilla.org/en/docs/Web/HTML/Element/audio) elements

  * HLS streams are played using [`hls.js`](https://github.com/video-dev/hls.js)

  * DASH streams are played using [`dash.js`](https://github.com/Dash-Industry-Forum/dash.js)



### Contributing



See the [contribution guidelines](https://github.com/cookpete/react-player/blob/master/CONTRIBUTING.md) before creating a pull request.



### Thanks



- Thanks to anyone who has [contributed](https://github.com/cookpete/react-player/graphs/contributors).

- Big thanks to my [Patreon](https://patreon.com/cookpete) supporters!



  

    

      
Jackson Doherty

    

    

      
Joseph Fung