shaka-player-thumbnails

A customized thumbnails plugin for shaka-player

Compatible with mobile browsers

Customized thumbnail and time tooltip

install

 npm install shaka-player-thumbnails

Usage

JavaScript / TypeScript

import Thumbnails from 'shaka-player-thumbnails';

const thumbnailsPlugin = new Thumbnails(
    video: HTMLVideoElement; 
    options: IOptions;
)

Interface of options

interface IOptions {
    columns: number; // count columns in sprite
    rows: number; // count rows in sprite
    thumbnails: string[]; // array of thumbnails
    top?: number; // you can control position of thumbnail (default: 120)
    scale?: number; // multiplier size of thumbnail (default: 1)
    styles?: Object; // accept object of styles, you can write them in camelcase style
    timeTooltip?: boolean; // show time under thumbnail (default: true)
}

Initialize plugin after you stream is loaded

thumbnailsPlugin.initialize();

Example

import shaka from 'shaka-player/dist/shaka-player.ui';
import Thumbnails from 'shaka-player-thumbnails';

if (shaka.Player.isBrowserSupported()) {
    initPlayer();
} else {
    console.error('Browser not supported!');
}

const initPlayer = async () => {
    const video = document.getElementById('video');
    const player = new shaka.Player(video);

    const thumbnailsPlugin = new Thumbnails(video, {
        columns: 5,
        rows: 5,
        thumbnails: ['/sprite_1.jpg','/sprite_2.jpg'],
        styles: {
            border: '1px solid #fff',
            borderRadius: '7px',
        }
    });
    
    try {
        await player.load(manifestUri);
        thumbnailsPlugin.initialize();
    } catch (e) {
        console.error(e)
    }
}

License

Released under MIT by lelouchwe.