videojs-theater-toggle

A plugin to enable Theater Mode in VideoJS 6.4+

Table of Contents

Installation

• Installation
• Usage
  • <script> Tag
  • Browserify/CommonJS
  • RequireJS/AMD
• License

Installation

npm install --save videojs-theater-toggle

Usage

To include videojs-theater-toggle 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>
<link rel="stylesheet" href="//path/to/videojs-theater-toggle.css">
<script src="//path/to/videojs-theater-toggle.min.js"></script>
<script>
  var player = videojs('my-video');

  player.theaterToggle();

  player.on("theaterMode",function(){
    if(player.theaterToggle().isTheater()){
      //The 'Theater' is enabled
    }else {
      //The 'Theater' is disabled
    }
  });
</script>

Browserify/CommonJS

When using with Browserify, install videojs-theater-toggle 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-theater-toggle');

var player = videojs('my-video');

player.theaterToggle();

player.on("theaterMode",function(){
  if(player.theaterToggle().isTheater()){
    //The 'Theater' is enabled
  }else {
    //The 'Theater' is disabled
  }
});

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-theater-toggle'], function(videojs) {
  var player = videojs('my-video');

  player.theaterToggle();

  player.on("theaterMode",function(){
    if(player.theaterToggle().isTheater()){
      //The 'Theater' is enabled
    }else {
      //The 'Theater' is disabled
    }
  });

});

License

MIT. Copyright (c) Will Xavier <[email protected]>