videojs-xr
v0.1.0
Published
Plugin for using WebXR with videojs, based on videojs-vr
Downloads
116
Maintainers
Readme
videojs-xr
This is a plugin for using WebXR with videojs, based on videojs-vr. Videojs-xr supports the Oculus browser and Firefox Reality on Oculus Quest. For a jump start how to use it with videojs see the index.html. You can see it in action here. This plugin is used in HOAST360 and in the HOAST library.
Currently the only supported video format is 360° equirectangular.
Installation
npm install --save videojs-xr
Usage
To include videojs-xr on your website or web application, use any of the following methods.
<script>
Tag
This is the simplest case. Get the script in whatever way you prefer and include the plugin after you include video.js, so that the videojs
global is available.
<script src="//path/to/video.min.js"></script>
<script src="//path/to/videojs-xr.min.js"></script>
<script>
var player = videojs('my-video');
player.xr();
</script>
Browserify/CommonJS
When using with Browserify, install videojs-xr via npm and require
the plugin as you would any other module.
var videojs = require('video.js');
// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require('videojs-xr');
var player = videojs('my-video');
player.xr();
RequireJS/AMD
When using with RequireJS (or another AMD library), get the script in whatever way you prefer and require
the plugin as you normally would:
require(['video.js', 'videojs-xr'], function(videojs) {
var player = videojs('my-video');
player.xr();
});
License
MIT. Copyright (c) Thomas Deppisch