From index.js
| prop | type | default | required | description |
|---|---|---|---|---|
| debug | Boolean |
false |
❌ | Write internal logs to console |
| errorCallback | Function |
error => { console.log('Error: ', error.message, error.type, error.obj); } |
❌ | Error callback (lots of errors are non-fatal and the video will continue to play) |
| fadeInDuration | Number |
200 |
❌ | How long should the fadeIn animation for the controls run? (in milliseconds) Default value is 200. |
| fadeOutDuration | Number |
1000 |
❌ | How long should the fadeOut animation run? (in milliseconds) Default value is 1000. |
| fullscreenEnterIcon | Function |
FullscreenEnterIcon |
❌ | |
| fullscreenExitIcon | Function |
FullscreenExitIcon |
❌ | |
| hideControlsTimerDuration | Number |
4000 |
❌ | If the user has not interacted with the controls, how long should the controls stay visible? (in milliseconds) Default value is 4000. |
| isPortrait | Boolean |
❌ | ||
| pauseIcon | Function |
PauseIcon |
❌ | |
| playIcon | Function |
PlayIcon |
❌ | |
| playbackCallback | Function |
() => {} |
❌ | Callback that gets passed playbackStatus objects for the underlying video element |
| quickFadeOutDuration | Number |
200 |
❌ | How long should the fadeOut animation run when the screen is tapped when the controls are visible? (in milliseconds) Default value is 200. |
| replayIcon | Unknown |
ReplayIcon |
❌ | |
| showControlsOnLoad | Boolean |
false |
❌ | |
| showFullscreenButton | Boolean |
true |
❌ | |
| spinner | Function |
Spinner |
❌ | |
| switchToLandscape | Function |
() => { console.warn( 'Pass in this function switchToLandscape in props to enable fullscreening' ); } |
❌ | |
| switchToPortrait | Function |
() => { console.warn( 'Pass in this function switchToLandscape in props to enable fullscreening' ); } |
❌ | |
| textStyle | Object |
{ color: '#FFFFFF', fontSize: 12, } |
❌ | Style to use for the all the text in the videoplayer including seek bar times and error messages |
| thumbImage | Unknown |
require('./assets/thumb.png') |
❌ | |
| trackImage | Unknown |
require('./assets/track.png') |
❌ | |
| videoProps | Object |
❌ | Props to use into the underlying |