https://github.com/tpkn/quartile-tracker

Easy way to track video quartiles
https://github.com/tpkn/quartile-tracker

Last synced: 6 days ago
JSON representation

Easy way to track video quartiles

• Host: GitHub
• URL: https://github.com/tpkn/quartile-tracker
• Owner: tpkn
• License: mit
• Created: 2018-12-07T20:55:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-19T13:05:03.000Z (over 1 year ago)
• Last Synced: 2024-11-14T14:32:41.669Z (2 months ago)
• Language: JavaScript
• Size: 32.2 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quartile Tracker

Easy way to track video quartiles

 

## API

```text

new QuartileTracker(video, trackers[, options])

```

### video   

**Type**: _Object_   

### trackers

**Type**: _Array_   

Array of trackers with following options:

- `time` _Number | String_ Can be a seconds or percent

- `pixel` _String_ This link would be called when `time` has come

- `callback` _Function_ Also you can call some callback function

### options

**Type**: _Object_   

### options.threshold

**Type**: _Number_   

**Default**: `1`   

Tracker fire time threshold in seconds (doesn't matter if time is in percent). 

If it's `0` and you'll jump to the end of the video, then **all the trackers will be triggered right away**. 

If it's set to `0.5` and your tracker is at `2 sec`, then tracker will be called between `2 and 2.5 sec`.

**_(!) Too small threshold may cause trackers to be jumped over._**

### options.auto_rest

**Type**: _Boolean_   

**Default**: `true`   

Reenable all trackers after end of videos

### options.verbose

**Type**: _Boolean_   

**Default**: `false`   

Turns on/off events trace

## Methods

### reset()

Reenables all trackers

### destroy()

## Usage

```javascript

let video = document.getElementById('video');

let trackers = [

   { time: '1s', callback: () => {

      console.log('1s callback');

   }},

   { time: '25%', pixel: 'https://localhost/pixel1.gif' },

   { time: 10, pixel: 'https://localhost/pixel2.gif' },

];

let qt = new QuartileTracker(video, trackers, { threshold: 1.5, verbose: true });

```

## Changelog 

#### 2023-02-02:

- Added `threshold` option to limit max fire time for trackers

- A few small optimizations...