0.3.4 • Published 2 years ago

@uscsf/react-native-video-player v0.3.4

Weekly downloads
1
License
MIT
Repository
github
Last release
2 years ago

React Native Video Player

A React Native video player with a few controls. This player uses react-native-video for the video playback.

This is a fork of Cornedor's react-native-video-player

Why was this forked?

The original repo had some long standing issues that were gaining no traction (such as the ability to view android in full screen). Making contributions to the original repo was difficult because it was written as one large javascript class; this made tackling bugs and adding additional features difficult. By contrast, this version has been entirely written in typescript using separate components where appropriate. In order to ensure it is a drop in replacement, all of the original props have been maintained.

Installation

In addition to react and react-native you will need to install additional peer dependencies:

yarn add @uscsf/react-native-video-player react-native-video react-native-vector-icons react-native-orientation-locker

Afterward, please make sure you follow the linking instructions provided by react-native-video, react-native-vector-icons, and react-native-orientation-locker

Important Note:

-- Fullscreen on Android will require that you configure react-native-video for EXOPlayer; by default it will use the standard android media player. See this thread for more information. To utilize Exoplayer, you will need to modify for your eact-native config before linking.

-- This has been tested against ReactNative 0.62 (the latest at the time of this writing); If you are having issues, consider upgrading to match the required peer dependencies.

Props

PropDescription
videoThe video source to pass to react-native-video.
thumbnailAn Image source to use as thumbnail before the video gets loaded.
endThumbnailAn Image source to use as thumbnail after the video has ended.
videoWidthWidth of the video to calculate the player size.
videoHeightHeight of the video to calculate the player size.
durationDuration can not always be figured out (e.g. when using hls), this can be used as fallback.
autoplayStart the video automatically.
defaultMutedStart the video muted, but allow toggling.
mutedStart the video muted and hide the mute toggle button.
controlsTimeoutTimeout when to hide the controls.
disableControlsAutoHideDisable auto hiding the controls.
disableFullscreenDisable the fullscreen button.
loopLoop the video after playback is done.
resizeModeThe video's resizeMode. defaults to contain and is passed to react-native-video.
hideControlsOnStartHides the controls on start video.
endWithThumbnailReturns to the thumbnail after the video ends. If an endThumbnail image is not specified then the image specified in thumbnail is shown.
disableSeekDisable video seeking.
pauseOnPressAutomatically pause/play when pressing the video player anywhere.
fullScreenOnLongPressAutomatically show video on fullscreen when doing a long press.
onStartCallback for when the start button is pressed.
onPlayPressCallback for when the play button is pressed.
onHideControlsCallback for when the controls are being hide.
onShowControlsCallback for when the controls are being shown.
onFullscreenPlayerWillPresenttriggered when ther user attempts to open in full screen.
onFullscreenPlayerWillDismisstriggered when ther closes the player in full screen.
customStylesThe player can be customized in this object, see customStyles for the options.
playButtonAccessibilityLabelThe accessiblity label associated with the play button on the placeholder/start btn.

All other props are passed to the react-native-video component.

customStyles

  • wrapper
  • video
  • controls
  • playControl
  • controlButton
  • controlIcon
  • playIcon
  • seekBar
  • seekBarFullWidth
  • seekBarProgress
  • seekBarKnob
  • seekBarBackground
  • thumbnail
  • playButton
  • playArrow
  • videoWrapper

Methods

MethodPropsDescription
seektime: floatSeek the player to the given time.
stopStop the playback and reset back to 0:00.
pausePause the playback.
resumeResume the playback.

Development

Clone this repo and run yarn install; this will install the dev dependencies and trigger an install of peer dependencies. Make changes to src and run yarn build before submitting a PR.

0.3.4

2 years ago

0.3.3

2 years ago

0.2.3

5 years ago

0.2.2

5 years ago

0.2.1

5 years ago

0.2.0

5 years ago