A <Video>
component for react-native, as seen in
react-native-login!
Requires react-native >= 0.19.0
Run npm install react-native-video --save
Install rnpm and run rnpm link react-native-video
If you would like to allow other apps to play music over your video component, add:
AppDelegate.m
#import <AVFoundation/AVFoundation.h> // import
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
...
[[AVAudioSession sharedInstance] setCategory:AVAudioSessionCategoryAmbient error:nil]; // allow
...
}
Install rnpm and run rnpm link react-native-video
Or if you have trouble using rnpm, make the following additions to the given files manually:
android/settings.gradle
include ':react-native-video'
project(':react-native-video').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-video/android')
android/app/build.gradle
dependencies {
...
compile project(':react-native-video')
}
MainActivity.java
On top, where imports are:
import com.brentvatne.react.ReactVideoPackage;
Under .addPackage(new MainReactPackage())
:
.addPackage(new ReactVideoPackage())
MainApplication.java (react-native >= 0.29.0)
On top, where imports are:
import com.brentvatne.react.ReactVideoPackage;
Under .addPackage(new MainReactPackage())
:
.addPackage(new ReactVideoPackage())
// Within your render function, assuming you have a file called
// "background.mp4" in your project. You can include multiple videos
// on a single screen if you like.
<Video source={{uri: "background"}} // Can be a URL or a local file.
rate={1.0} // 0 is paused, 1 is normal.
volume={1.0} // 0 is muted, 1 is normal.
muted={false} // Mutes the audio entirely.
paused={false} // Pauses playback entirely.
resizeMode="cover" // Fill the whole screen at aspect ratio.
repeat={true} // Repeat forever.
playInBackground={false} // Audio continues to play when app entering background.
playWhenInactive={false} // [iOS] Video continues to play when control or notification center are shown.
onLoadStart={this.loadStart} // Callback when video starts to load
onLoad={this.setDuration} // Callback when video loads
onProgress={this.setTime} // Callback every ~250ms with currentTime
onEnd={this.onEnd} // Callback when playback finishes
onError={this.videoError} // Callback when video cannot be loaded
style={styles.backgroundVideo} />
// Later on in your styles..
var styles = StyleSheet.create({
backgroundVideo: {
position: 'absolute',
top: 0,
left: 0,
bottom: 0,
right: 0,
},
});
To enable audio to play in background on iOS the audio session needs to be set to AVAudioSessionCategoryPlayback
. See Apple documentation.
seek(seconds)
Seeks the video to the specified time (in seconds). Access using a ref to the component
-
See an Example integration in
react-native-login
*note that this example uses an older version of this library, before we usedexport default
-- if you userequire
you will need to dorequire('react-native-video').default
as per instructions above. -
Try the included VideoPlayer example yourself:
git clone git@github.com:brentvatne/react-native-video.git cd react-native-video/Examples/VideoPlayer npm install open VideoPlayer.xcodeproj
Then
Cmd+R
to start the React Packager, build and run the project in the simulator.
- Add support for captions
- Add support for playing multiple videos in a sequence (will interfere with current
repeat
implementation) - Callback to get buffering progress for remote videos
- Bring API closer to HTML5
<Video>
reference
MIT Licensed