image-sequence-player

v1.0.3

Published

3 years ago

A video player that playing video with image sequence.

Downloads

0High
0Medium
0Low

adam.lee

image img player play frame video json images mobile image sequence

A video player that playing video with image sequence.

Demo: https://skywatch24.github.io/image-sequence-player/

Installation

npm install image-sequence-player --save

yarn add image-sequence-player

CDN:

<script src="https://cdn.jsdelivr.net/npm/image-sequence-player/dist/lib.min.js"></script>

Usage

<body>
    <div id="my-player" class="frameplayer" data-vidsrc="./path-to/images.json"></div>
</body>
<script src="https://cdn.jsdelivr.net/npm/image-sequence-player/dist/lib.min.js"></script>
<script>
    var options = {
        rate: 1,
        controls: true,
        autoplay: true,
        backwards: false,
        startFrame: 0,
        width: '640px',
        height: '390px',
        progressBarColor: "#f00"
    };
    var player = new FramePlayer('my-player', options);
    player.play();
</script>

React

import React, {useRef, useEffect} from 'react';
import FramePlayer from 'image-sequence-player';
import videoFile from 'YOUR_JSON_PATH';

const APP = () => {
  const containerRef = useRef(null);

  useEffect(() => {
    var options = {
      rate: 1,
      controls: true,
      autoplay: true,
      backwards: false,
      startFrame: 0,
      width: '640px',
      height: '390px',
      progressBarColor: '#f00',
    };
    const player = FramePlayer('my-player', options, videoFile);
    player.play();
  }, []);

  return <div ref={containerRef} id="my-player" className="frameplayer"></div>;
};

export default APP;

Image JSON Format:

The player can supports jpg, jpeg, png, base64 etc.

{
  "frames": [
    "https://your_image_server/0001.jpg",
    "https://your_image_server/0002.jpg",
    "https://your_image_server/0003.jpg",
    "https://your_image_server/0004.jpg",
    "https://your_image_server/0005.jpg",
    "https://your_image_server/0006.jpg",
    "https://your_image_server/0007.jpg",
    "https://your_image_server/0008.jpg",
    ...
    ]
}

Methods

| Method | Parameters | Returns | Description | | ---------------- | ---------- | -------- | ----------------------------------------------------- | | play() | None. | Nothing. | Start playing the video. | | pause() | None. | Nothing. | Pause the current video. | | resume() | None. | Nothing. | Play the current video from the moment it was paused. | | gotoFrame(int) | Integer. | Nothing. | Jumps to a specific frame of the video. | | reverse(bool) | Boolean. | Nothing. | Reverses the video or not. | | fullscreen() | None. | Nothing. | Fullscreen mode. |

Parameters

| Property | Type | Default | Description | | ------------------ | -------- | ------- | ----------------------------------------------------- | | rate | Number. | 20 | Video frame rate. | | controls | Boolean. | True | Display control bar or not. | | autoplay | Boolean. | False | If ture, it will play the video at the beginning. | | width | String. | '480px' | The width of video player. | | height | String. | '320px' | The height of video player. | | startFrame | Number. | 0 | Decide which frame will be played at the beginning. | | backwards | Boolean. | False | If true, the video will be reversed at the beginning. | | progressBarColor | String. | '#f00' | The color of progress bar of current time. |

Note

This project is inspired by frame-player.
Licensed under the Apache License, Version 2.0 (the "License");
Welcome to give a pull request!

Published

Vulnerabilities

Links

Maintainers

Keywords