module react-player
1. function react-player ()
2. function react-player.propTypes.fileConfig ()
3. function react-player.propTypes.height ()
4. function react-player.propTypes.onReady ()
5. function react-player.propTypes.playing ()
6. function react-player.propTypes.soundcloudConfig ()
7. function react-player.propTypes.style ()
8. function react-player.propTypes.url ()
9. function react-player.propTypes.vidmeConfig ()
10. function react-player.propTypes.vimeoConfig ()
11. function react-player.propTypes.volume ()
12. function react-player.propTypes.width ()
13. function react-player.propTypes.youtubeConfig ()
14. object react-player.defaultProps
15. object react-player.propTypes
16. object react-player.utils
17. string react-player.displayName
module react-player.defaultProps
1. boolean react-player.defaultProps.controls
2. boolean react-player.defaultProps.hidden
3. boolean react-player.defaultProps.loop
4. boolean react-player.defaultProps.playing
5. boolean react-player.defaultProps.playsinline
6. function react-player.defaultProps.onBuffer ()
7. function react-player.defaultProps.onDuration ()
8. function react-player.defaultProps.onEnded ()
9. function react-player.defaultProps.onError ()
10. function react-player.defaultProps.onPause ()
11. function react-player.defaultProps.onPlay ()
12. function react-player.defaultProps.onProgress ()
13. function react-player.defaultProps.onReady ()
14. function react-player.defaultProps.onStart ()
15. number react-player.defaultProps.height
16. number react-player.defaultProps.playbackRate
17. number react-player.defaultProps.progressFrequency
18. number react-player.defaultProps.volume
19. number react-player.defaultProps.width
20. object react-player.defaultProps.fileConfig
21. object react-player.defaultProps.soundcloudConfig
22. object react-player.defaultProps.vidmeConfig
23. object react-player.defaultProps.vimeoConfig
24. object react-player.defaultProps.youtubeConfig
module react-player.propTypes
module react-player.propTypes.fileConfig
1. function react-player.propTypes.fileConfig ()
2. function react-player.propTypes.fileConfig.isRequired ()
module react-player.propTypes.height
1. function react-player.propTypes.height ()
2. function react-player.propTypes.height.isRequired ()
module react-player.propTypes.onReady
1. function react-player.propTypes.onReady ()
2. function react-player.propTypes.onReady.isRequired ()
module react-player.propTypes.playing
1. function react-player.propTypes.playing ()
2. function react-player.propTypes.playing.isRequired ()
module react-player.propTypes.soundcloudConfig
1. function react-player.propTypes.soundcloudConfig ()
2. function react-player.propTypes.soundcloudConfig.isRequired ()
module react-player.propTypes.style
1. function react-player.propTypes.style ()
2. function react-player.propTypes.style.isRequired ()
module react-player.propTypes.url
1. function react-player.propTypes.url ()
2. function react-player.propTypes.url.isRequired ()
module react-player.propTypes.vidmeConfig
1. function react-player.propTypes.vidmeConfig ()
2. function react-player.propTypes.vidmeConfig.isRequired ()
module react-player.propTypes.vimeoConfig
1. function react-player.propTypes.vimeoConfig ()
2. function react-player.propTypes.vimeoConfig.isRequired ()
module react-player.propTypes.volume
1. function react-player.propTypes.volume ()
2. function react-player.propTypes.volume.isRequired ()
module react-player.propTypes.width
1. function react-player.propTypes.width ()
2. function react-player.propTypes.width.isRequired ()
module react-player.propTypes.youtubeConfig
1. function react-player.propTypes.youtubeConfig ()
2. function react-player.propTypes.youtubeConfig.isRequired ()
module react-player.utils
1. function react-player.utils.parseStartTime (url)

module react-player

function react-player ()

description and source-code

function ReactPlayer() {
  var _ref;

  var _temp, _this, _ret;

  _classCallCheck(this, ReactPlayer);

  for (var _len = arguments.length, args = Array(_len), _key = 0; _key < _len; _key++) {
    args[_key] = arguments[_key];
  }

  return _ret = (_temp = (_this = _possibleConstructorReturn(this, (_ref = ReactPlayer.__proto__ || Object.getPrototypeOf(ReactPlayer
)).call.apply(_ref, [this].concat(args))), _this), _this.seekTo = function (fraction) {
    if (_this.player) {
      _this.player.seekTo(fraction);
    }
  }, _this.getDuration = function () {
    if (!_this.player) return null;
    return _this.player.getDuration();
  }, _this.getCurrentTime = function () {
    if (!_this.player) return null;
    var duration = _this.player.getDuration();
    var fractionPlayed = _this.player.getFractionPlayed();
    if (duration === null || fractionPlayed === null) {
      return null;
    }
    return fractionPlayed * duration;
  }, _this.progress = function () {
    if (_this.props.url && _this.player) {
      var loaded = _this.player.getFractionLoaded() || 0;
      var played = _this.player.getFractionPlayed() || 0;
      var duration = _this.player.getDuration();
      var progress = {};
      if (loaded !== _this.prevLoaded) {
        progress.loaded = loaded;
        if (duration) {
          progress.loadedSeconds = progress.loaded * duration;
        }
      }
      if (played !== _this.prevPlayed) {
        progress.played = played;
        if (duration) {
          progress.playedSeconds = progress.played * duration;
        }
      }
      if (progress.loaded || progress.played) {
        _this.props.onProgress(progress);
      }
      _this.prevLoaded = loaded;
      _this.prevPlayed = played;
    }
    _this.progressTimeout = setTimeout(_this.progress, _this.props.progressFrequency);
  }, _this.ref = function (player) {
    _this.player = player;
  }, _this.renderPlayer = function (Player) {
    var active = Player.canPlay(_this.props.url);

    var _this$props = _this.props,
        youtubeConfig = _this$props.youtubeConfig,
        soundcloudConfig = _this$props.soundcloudConfig,
        vimeoConfig = _this$props.vimeoConfig,
        vidmeConfig = _this$props.vidmeConfig,
        fileConfig = _this$props.fileConfig,
        activeProps = _objectWithoutProperties(_this$props, ['youtubeConfig', 'soundcloudConfig', 'vimeoConfig', 'vidmeConfig', '
fileConfig']);

    var props = active ? _extends({}, activeProps, { ref: _this.ref }) : {};
    return _react2['default'].createElement(Player, _extends({
      key: Player.displayName,
      youtubeConfig: youtubeConfig,
      soundcloudConfig: soundcloudConfig,
      vimeoConfig: vimeoConfig,
      vidmeConfig: vidmeConfig,
      fileConfig: fileConfig
    }, props));
  }, _temp), _possibleConstructorReturn(_this, _ret);
}

example usage
```
n/a
```

function react-player.propTypes.fileConfig ()

description and source-code

propTypes.fileConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.height ()

description and source-code

propTypes.height = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.onReady ()

description and source-code

propTypes.onReady = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.playing ()

description and source-code

propTypes.playing = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.soundcloudConfig ()

description and source-code

propTypes.soundcloudConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.style ()

description and source-code

propTypes.style = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.url ()

description and source-code

propTypes.url = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.vidmeConfig ()

description and source-code

propTypes.vidmeConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.vimeoConfig ()

description and source-code

propTypes.vimeoConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.volume ()

description and source-code

propTypes.volume = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.width ()

description and source-code

propTypes.width = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.youtubeConfig ()

description and source-code

propTypes.youtubeConfig = function () { [native code] }

example usage
```
n/a
```

module react-player.defaultProps

function react-player.defaultProps.onBuffer ()

description and source-code
```
function onBuffer() {}
```
example usage
```
n/a
```

function react-player.defaultProps.onDuration ()

description and source-code
```
function onDuration() {}
```
example usage
```
n/a
```

function react-player.defaultProps.onEnded ()

description and source-code
```
function onEnded() {}
```

example usage

...
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
  var _this$props = _this.props,
      loop = _this$props.loop,
...

function react-player.defaultProps.onError ()

description and source-code
```
function onError() {}
```

example usage

...
      return Promise.resolve(songData[url]);
    }
    return (0, _fetchJsonp2['default'])(RESOLVE_URL + '?url=' + url + '&client_id=' + this.clientId
).then(function (response) {
      if (response.ok) {
        songData[url] = response.json();
        return songData[url];
      } else {
        _this2.props.onError(new Error('SoundCloud track could not be resolved&#
x27;));
      }
    });
  }
}, {
  key: 'load',
  value: function load(url) {
    var _this3 = this;
...

function react-player.defaultProps.onPause ()

description and source-code
```
function onPause() {}
```

example usage

...
    _this.postMessage('addEventListener', 'play');
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
  var _this$props = _this.props,
...

function react-player.defaultProps.onPlay ()

description and source-code
```
function onPlay() {}
```

example usage

...
    _this.postMessage('addEventListener', 'loadProgress');
    _this.postMessage('addEventListener', 'play');
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
...

function react-player.defaultProps.onProgress ()

description and source-code
```
function onProgress() {}
```
example usage
```
n/a
```

function react-player.defaultProps.onReady ()

description and source-code
```
function onReady() {}
```

example usage

...
if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
if (data.event === 'play') _this.onPlay();
if (data.event === 'pause') _this.props.onPause();
if (data.event === 'finish') _this.onEnded();
if (data.method === 'getDuration') {
  _this.duration = data.value; // Store for use later
  _this.onReady();
}
    }, _this.onEnded = function () {
var _this$props = _this.props,
    loop = _this$props.loop,
    onEnded = _this$props.onEnded;

if (loop) {
...

function react-player.defaultProps.onStart ()

description and source-code
```
function onStart() {}
```
example usage
```
n/a
```

module react-player.propTypes

function react-player.propTypes.className ()

description and source-code

className = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.controls ()

description and source-code

controls = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.fileConfig ()

description and source-code

fileConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.height ()

description and source-code
```
height = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.hidden ()

description and source-code
```
hidden = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.loop ()

description and source-code
```
loop = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.onBuffer ()

description and source-code

onBuffer = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.onDuration ()

description and source-code

onDuration = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.onEnded ()

description and source-code
```
onEnded = function () { [native code] }
```

example usage

...
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
  var _this$props = _this.props,
      loop = _this$props.loop,
...

function react-player.propTypes.onError ()

description and source-code
```
onError = function () { [native code] }
```

example usage

...
      return Promise.resolve(songData[url]);
    }
    return (0, _fetchJsonp2['default'])(RESOLVE_URL + '?url=' + url + '&client_id=' + this.clientId
).then(function (response) {
      if (response.ok) {
        songData[url] = response.json();
        return songData[url];
      } else {
        _this2.props.onError(new Error('SoundCloud track could not be resolved&#
x27;));
      }
    });
  }
}, {
  key: 'load',
  value: function load(url) {
    var _this3 = this;
...

function react-player.propTypes.onPause ()

description and source-code
```
onPause = function () { [native code] }
```

example usage

...
    _this.postMessage('addEventListener', 'play');
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
  var _this$props = _this.props,
...

function react-player.propTypes.onPlay ()

description and source-code
```
onPlay = function () { [native code] }
```

example usage

...
    _this.postMessage('addEventListener', 'loadProgress');
    _this.postMessage('addEventListener', 'play');
    _this.postMessage('addEventListener', 'pause');
    _this.postMessage('addEventListener', 'finish');
  }
  if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
  if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
  if (data.event === 'play') _this.onPlay();
  if (data.event === 'pause') _this.props.onPause();
  if (data.event === 'finish') _this.onEnded();
  if (data.method === 'getDuration') {
    _this.duration = data.value; // Store for use later
    _this.onReady();
  }
}, _this.onEnded = function () {
...

function react-player.propTypes.onProgress ()

description and source-code

onProgress = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.onReady ()

description and source-code
```
onReady = function () { [native code] }
```

example usage

...
if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
if (data.event === 'play') _this.onPlay();
if (data.event === 'pause') _this.props.onPause();
if (data.event === 'finish') _this.onEnded();
if (data.method === 'getDuration') {
  _this.duration = data.value; // Store for use later
  _this.onReady();
}
    }, _this.onEnded = function () {
var _this$props = _this.props,
    loop = _this$props.loop,
    onEnded = _this$props.onEnded;

if (loop) {
...

function react-player.propTypes.onStart ()

description and source-code
```
onStart = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.playbackRate ()

description and source-code

playbackRate = function () { [native code] }

example usage

...
    if (!this.isReady || !this.player || !this.player.volume) return;
    this.player.volume(fraction);
  }
}, {
  key: 'setPlaybackRate',
  value: function setPlaybackRate(rate) {
    if (!this.isReady || !this.player || !this.player.playbackRate) return;
    this.player.playbackRate(rate);
  }
}, {
  key: 'getDuration',
  value: function getDuration() {
    if (!this.isReady || !this.player || !this.player.duration) return;
    return this.player.duration();
  }
...

function react-player.propTypes.playing ()

description and source-code
```
playing = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.playsinline ()

description and source-code

playsinline = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.progressFrequency ()

description and source-code

progressFrequency = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.soundcloudConfig ()

description and source-code

soundcloudConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.style ()

description and source-code
```
style = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.url ()

description and source-code
```
url = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.vidmeConfig ()

description and source-code

vidmeConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.vimeoConfig ()

description and source-code

vimeoConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.volume ()

description and source-code
```
volume = function () { [native code] }
```

example usage

...
    if (!this.isReady || !this.player) return;
    this.player.time(this.getDuration() * fraction);
  }
}, {
  key: 'setVolume',
  value: function setVolume(fraction) {
    if (!this.isReady || !this.player || !this.player.volume) return;
    this.player.volume(fraction);
  }
}, {
  key: 'setPlaybackRate',
  value: function setPlaybackRate(rate) {
    if (!this.isReady || !this.player || !this.player.playbackRate) return;
    this.player.playbackRate(rate);
  }
...

function react-player.propTypes.width ()

description and source-code
```
width = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.youtubeConfig ()

description and source-code

youtubeConfig = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.fileConfig

function react-player.propTypes.fileConfig ()

description and source-code

fileConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.fileConfig.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.height

function react-player.propTypes.height ()

description and source-code
```
height = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.height.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.onReady

function react-player.propTypes.onReady ()

description and source-code
```
onReady = function () { [native code] }
```

example usage

...
if (data.event === 'playProgress') _this.fractionPlayed = data.data.percent;
if (data.event === 'loadProgress') _this.fractionLoaded = data.data.percent;
if (data.event === 'play') _this.onPlay();
if (data.event === 'pause') _this.props.onPause();
if (data.event === 'finish') _this.onEnded();
if (data.method === 'getDuration') {
  _this.duration = data.value; // Store for use later
  _this.onReady();
}
    }, _this.onEnded = function () {
var _this$props = _this.props,
    loop = _this$props.loop,
    onEnded = _this$props.onEnded;

if (loop) {
...

function react-player.propTypes.onReady.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.playing

function react-player.propTypes.playing ()

description and source-code
```
playing = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.playing.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.soundcloudConfig

function react-player.propTypes.soundcloudConfig ()

description and source-code

soundcloudConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.soundcloudConfig.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.style

function react-player.propTypes.style ()

description and source-code
```
style = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.style.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.url

function react-player.propTypes.url ()

description and source-code
```
url = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.url.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.vidmeConfig

function react-player.propTypes.vidmeConfig ()

description and source-code

vidmeConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.vidmeConfig.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.vimeoConfig

function react-player.propTypes.vimeoConfig ()

description and source-code

vimeoConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.vimeoConfig.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.volume

function react-player.propTypes.volume ()

description and source-code
```
volume = function () { [native code] }
```

example usage

...
    if (!this.isReady || !this.player) return;
    this.player.time(this.getDuration() * fraction);
  }
}, {
  key: 'setVolume',
  value: function setVolume(fraction) {
    if (!this.isReady || !this.player || !this.player.volume) return;
    this.player.volume(fraction);
  }
}, {
  key: 'setPlaybackRate',
  value: function setPlaybackRate(rate) {
    if (!this.isReady || !this.player || !this.player.playbackRate) return;
    this.player.playbackRate(rate);
  }
...

function react-player.propTypes.volume.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.width

function react-player.propTypes.width ()

description and source-code
```
width = function () { [native code] }
```
example usage
```
n/a
```

function react-player.propTypes.width.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.propTypes.youtubeConfig

function react-player.propTypes.youtubeConfig ()

description and source-code

youtubeConfig = function () { [native code] }

example usage
```
n/a
```

function react-player.propTypes.youtubeConfig.isRequired ()

description and source-code

isRequired = function () { [native code] }

example usage
```
n/a
```

module react-player.utils

function react-player.utils.parseStartTime (url)

description and source-code

function parseStartTime(url) {
  var match = url.match(MATCH_START_QUERY);
  if (match) {
    var stamp = match[1];
    if (stamp.match(MATCH_START_STAMP)) {
      return parseStartStamp(stamp);
    }
    if (MATCH_NUMERIC.test(stamp)) {
      return parseInt(stamp, 10);
    }
  }
  return 0;
}

example usage
```
n/a
```

api documentation for react-player (v0.15.0)

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

table of contents