https://github.com/tapioca24/videojs-remnant
A video.js plugin to leave the last frame video at the end of playback.
https://github.com/tapioca24/videojs-remnant
video videojs
Last synced: 12 months ago
JSON representation
A video.js plugin to leave the last frame video at the end of playback.
- Host: GitHub
- URL: https://github.com/tapioca24/videojs-remnant
- Owner: tapioca24
- License: mit
- Created: 2019-11-07T09:42:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-11T16:07:51.000Z (almost 5 years ago)
- Last Synced: 2025-05-23T01:35:57.384Z (about 1 year ago)
- Topics: video, videojs
- Language: JavaScript
- Size: 1.5 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# videojs-remnant
A video.js plugin to leave the last frame video at the end of playback.
This is useful when playing a video that has been split into multiple files.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [`` Tag](#script-tag)
- [Browserify/CommonJS](#browserifycommonjs)
- [Browserify/ES6](#browserifyes6)
- [RequireJS/AMD](#requirejsamd)
- [TypeScript](#typescript)
- [Configuration](#configuration)
- [License](#license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Installation
```sh
npm install --save videojs-remnant
```
## Usage
To include videojs-remnant on your website or web application, use any of the following methods.
### `<script>` Tag
This is the simplest case. Get the script in whatever way you prefer and include the plugin _after_ you include [video.js][videojs], so that the `videojs` global is available.
```html
<script src="//path/to/video.min.js">
var player = videojs("my-video");
player.remnant();
```
### Browserify/CommonJS
When using with Browserify, install videojs-remnant via npm and `require` the plugin as you would any other module.
```js
var videojs = require("video.js");
// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
require("videojs-remnant");
var player = videojs("my-video");
player.remnant();
```
### Browserify/ES6
When using with Browserify, install videojs-remnant via npm and `import` the plugin as you would any other module.
```js
import videojs from "video.js";
// The actual plugin function is exported by this module, but it is also
// attached to the `Player.prototype`; so, there is no need to assign it
// to a variable.
import "videojs-remnant";
const player = videojs("my-video");
player.remnant();
```
### RequireJS/AMD
When using with RequireJS (or another AMD library), get the script in whatever way you prefer and `require` the plugin as you normally would:
```js
require(["video.js", "videojs-remnant"], function(videojs) {
var player = videojs("my-video");
player.remnant();
});
```
### TypeScript
When using with TypeScript, install videojs-remnant via npm and `import` the plugin as you would any other module.
You can use the `VideoJsRemnant` namespace.
```ts
import videojs, { VideoJsRemnant } from "video.js";
import "videojs-remnant";
const player = videojs("my-video");
const options: VideoJsRemnant.Options = {
disableColorCorrection: true
};
player.remnant(options);
```
## Configuration
| Property | Attributes | Type | Default value | Description |
| ---------------------- | ---------- | ------- | ------------- | -------------------------------- |
| disableColorCorrection | Optional | Boolean | false | Disable canvas color correction. |
## License
MIT. Copyright (c) tapioca24
[videojs]: http://videojs.com/