README.md

react-native-video-controls

Controls for the React Native <Video> component at react-native-video.

This has yet to be tested on Android.

Features

This package contains a simple set of GUI controls that work with the react-native-video <Video> component. This includes a back button, volume bar, fullscreen toggle, play/pause toggle, seekbar, title and timer toggle that can switch between time remaining and current time when tapped.

By default the <VideoPlayer> accepts a navigator property from React's built-in <Navigator> which pops the current scene off the stack when tapped. Alternatively you can provide your own goBack prop to the component to override this functionality.

You should also provide your own onEnd prop to the component so it knows what to do when a video ends playback.

Installation

Run npm install --save react-native-video react-native-video-controls

Install rnpm and run rnpm link react-native-video

Usage

The <VideoPlayer> component follows the API of the <Video> component at react-native-video. It also takes a number of additional props which are outlined in the API section.

For basic operation the <VideoPlayer> component requires a video source and a navigator property. The default back button functionality in the component pops the navigator. This can be overridden if desired, see the API for more details.

// At the top where our imports are...
import VideoPlayer from 'react-native-video-controls';


// in the components render() function
<VideoPlayer
    source={{ uri: 'https://vjs.zencdn.net/v/oceans.mp4' }}
    navigator={ this.props.navigator }
/>

API

The <VideoPlayer> component can take a number of inputs to customize it as needed. They are outlined below:

<VideoPlayer

    // react-native-video options
    playWhenInactive={ false }   // [iOS] continuing playing when notification centre active
    playInBackground={ false }   // play audio when entering background
    resizeMode={ 'contain' }     // 'contain' or 'cover' should be used.
    paused={ false }             // stop playback entirely
    repeat={ false }             // Repeats at end of duration
    muted={ false }              // Mutes the audio entirely.
    volume={ 1 }                 // 0 is muted, 1 is normal.
    rate={ 1 }                   // 0 is paused, 1 is normal.
    title={}                     // Video title, if null title area is hidden

    // events callbacks
    onLoadStart={}   // Fired when loading of the source starts
    onProgress={}    // Fired every ~250ms when the video progresses
    onError={}       // Fired when an error is encountered on load
    onLoad={}        // Fired when loading is complete
    onEnd={}         // Fired when the video is complete.

    // actions
    goBack={}   // Function fired when back button is pressed.

/>