Gitingest

Include files under: 50kb

Summary

Repository: cladera/videojs-cuepoints
Files analyzed: 8

Estimated tokens: 2.2k

Download

Directory Structure

Directory structure:

└── cladera-videojs-cuepoints/

    ├── README.md

    ├── bower.json

    ├── Gruntfile.js

    ├── LICENSE

    ├── package.json

    ├── .jshintrc

    └── src/

        ├── core.js

        └── cuepoint.js

Files Content

================================================
FILE: README.md
================================================
VideoJS Cuepoints
==================
## HTML5 Sync Cuepoints Plugin

VideoJS Cue Points is a plugin for Video JS player. With this plugin you can
sync actions with the media timeline and make the viewers experiences richer. 

## Installation
Add videojs.cuepoints.js, just after
videojs:

	<html>
    <head>
      <link href="http://vjs.zencdn.net/4.0/video-js.css" rel="stylesheet">
      <script src="http://vjs.zencdn.net/4.0/video.js"></script>
      <script src="dist/videojs.cuepoints.js"></script>
    </head>
      ....

**Warning!** Hosted version will be removed July 3rd. From now on, in order to use this library clone/download this project and use files in dist/ folder.

## Usage
When videojs is ready, initialize the plugin and use the function `addCuepoint` to sync actions
with the timeline:

	<script>
		videojs("myVideo").ready(function(){
			this.cuepoints();
			this.addCuepoint({
				namespace: "logger",
				start: 0,
				end: 30,
				onStart: function(params){
					if(params.error){
						console.error("Error at second 0");
					}else{
						console.log("Log at second 0");
					}
				},
				onEnd: function(params){
					console.log("Action ends at second 30");
				},
				params: {error: false}
			});
		});
	</script>
	
## Please, fork me!
I have a lot of things to learn yet (one of them is my English). So, fork me and help me to improve
the project.
Thanks! ;)



================================================
FILE: bower.json
================================================
{
  "name": "videojs-cuepoints",
  "version": "1.1.6",
  "homepage": "https://github.com/cladera/videojs-cuepoints",
  "authors": [
    "(Carlos Galan Cladera <cgcladera@gmail.com>)"
  ],
  "description": "sync actions with the media timeline",
  "main": "dist/videojs.cuepoints.js",
  "keywords": [
    "videojs"
  ],
  "dependencies": {
    "video.js": "^4.0.0"
  },
  "license": "MIT",
  "ignore": [
    "**/.*",
    "node_modules",
    "bower_components",
    "build"
  ]
}



================================================
FILE: Gruntfile.js
================================================
module.exports = function(grunt) {
	var pkg, version, verParts;
	pkg = grunt.file.readJSON('package.json');
  	verParts = pkg.version.split('.');
	version = {
		full: pkg.version,
	    major: verParts[0],
	    minor: verParts[1],
	    patch: verParts[2]
	};
  	version.majorMinor = version.major + '.' + version.minor;
  // Project configuration.
  grunt.initConfig({
    pkg: pkg,
    jshint: {
      src: {
        src: ['src/*.js'],
        options: {
        	jshintrc: '.jshintrc'
        }
      }
    },
    concat: {
    	build: {
    		src: ['src/cuepoint.js','src/core.js'],
    		dest:'build/<%= pkg.name %>.js'
    	}
    },
    uglify: {
      options: {
        banner: '/*! <%= pkg.title %> <%= grunt.template.today("yyyy-mm-dd") %> */\n'+
                '/*! See <%=pkg.github_url %> for details */\n'+
        		    '/*! Author: <%= pkg.author %> <%= pkg.author_email %>*/\n'+
                '/*! Released under the <%= pkg.license %> license */\n'
      },
      build: {
        src: 'build/<%= pkg.name %>.js',
        dest: 'build/<%= pkg.distName %>.js'
      },
      dist: {
      	src: 'build/<%= pkg.name %>.js',
        dest: 'dist/<%= pkg.distName %>.js'
      }
    }
  });

  // Load the plugin that provides the "uglify" task.
  grunt.loadNpmTasks('grunt-contrib-uglify');
  grunt.loadNpmTasks('grunt-contrib-concat');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  // Default task(s).
  grunt.registerTask('default', ['jshint', 'concat','uglify']);
  grunt.registerTask('dist',['jshint', 'concat','uglify:dist']);
};


================================================
FILE: LICENSE
================================================
The MIT License (MIT)

Copyright (c) 2013 Carlos Galan Cladera

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



================================================
FILE: package.json
================================================
{
  "name": "cuepoints",
  "title": "VideoJS Cuepoints plugin",
  "distName": "videojs.cuepoints",
  "version": "1.2.0",
  "author": "Carlos Galan Cladera <cgcladera@gmail.com>",
  "license": "MIT",
  "author_url": "www.carlosgalancladera.net",
  "github_url": "http://github.com/cladera/videojs-cuepoints",
  "devDependencies": {
    "grunt": "~0.4.1",
    "grunt-contrib-jshint": "~0.6.0",
    "grunt-contrib-nodeunit": "~0.2.0",
    "grunt-contrib-uglify": "~0.2.2",
    "grunt-s3": "~0.2.0-alpha.2",
    "grunt-contrib-concat": "~0.3.0"
  }
}



================================================
FILE: .jshintrc
================================================
{
  "curly"	: 	true,
  "eqnull"	: 	true,
  "eqeqeq"	: 	true,
  "undef"	: 	true,
  "predef"	:	[
  		"videojs",
  		"Cuepoint"
  ]
}


================================================
FILE: src/core.js
================================================
function vjsCuepoints(options) {
    var player = this;
    player.cuepoints = player.cuepoints || {};
    player.cuepoints.init = function(options) {
        player.cuepoints.instances = [];
    };
    player.cuepoints.destroy = function() {
        var i = 0,
            j = player.cuepoints.instances.length;
        for (; i < j; i++) {
            player.cuepoints.instances[i].destroy();
            player.cuepoints.instances[i] = null;
        }
        player.cuepoints.instances = null;
    };
    player.cuepoints._addCuepoint = function(options) {
        var cp = new Cuepoint(player, options);
        cp.activate();
        player.cuepoints.instances.push(cp);
        return cp;
    };
    

    player.addCuepoint = function(options) {
        return player.cuepoints._addCuepoint(options);
    };

    player.destroyCuepoints = function() {
        return player.cuepoints.destroy();
    };

    player.cuepoints.init(options);
}

videojs.plugin('cuepoints', vjsCuepoints);



================================================
FILE: src/cuepoint.js
================================================
function Cuepoint(player, options) {
    this.player = player;
    var opts = options || {};
    this.namespace = opts.namespace || "";
    this.start = opts.start || 0;
    this.end = opts.end || -1;
    this.startFn = opts.onStart || function() {};
    this.endFn = opts.onEnd || function() {};
    this.params = opts.params || {};
    this.fired = false;
}
Cuepoint.prototype._process = function() {
    //Check if current time is between start and end
    if (this.player.currentTime() >= this.start && (this.end < 0 || this.player.currentTime() < this.end)) {
        if (this.fired) { //Do nothing if start has already been called
            return;
        }
        this.fired = true; //Set fired flag to true
        this._start(); //Call start function
    } else {
        if (!this.fired) { //Do nothing if end has already been called
            return;
        }
        this.fired = false; //Set fired flat to false
        this._end(); //Call end function
    }
};

Cuepoint.prototype.start = 0;

Cuepoint.prototype.end = -1;

Cuepoint.prototype._start = function() {
    this.startFn.call(this, this.params);
};

Cuepoint.prototype._end = function() {
    this.endFn.call(this, this.params);
};

Cuepoint.prototype.activate = function() {
    var self = this;
    this.processHandler = function() {
        self._process();
    };
    this.player.on("timeupdate", this.processHandler);
};

Cuepoint.prototype.suspend = function() {
    this.fired = false;
    var self = this;
    this.player.off("timeupdate", this.processHandler);
};

Cuepoint.prototype.destroy = function() {
    var self = this;
    this.player.off("timeupdate", this.processHandler);
};