## Installation
```
npm install image-sequence-player --save
```
or
```
yarn add image-sequence-player
```
CDN:
```
```
## Usage
```javascript
```
React
```javascript
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 ;
};
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](https://github.com/vagnervjs/frame-player).
- Licensed under the Apache License, Version 2.0 (the "License");
- Welcome to give a pull request!
---
_Source: https://npm.io/package/image-sequence-player · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._