Vectorly Upscaler Library

Vectorly Upscaler Library

@vectorly-io/ai-upscaler 2.3.2

Vectorly Upscaler Library

Vectorly's upscaler library use AI to upscale web in real-time in the browser. Signup on Upscaler Dashboard to start using upscaler libraries.

Detailed library reference documentation is at https://cdn.vectorly.io/upscaler/docs/latest/

CDN

The easiest way to load Vectorly's Upscaler library directly via CDN

https://cdn.vectorly.io/upscaler/v2/latest/vectorly-upscaler.js

Plugins

Aside from the standalone upscaler, we have several plugins

VideoJS

https://cdn.vectorly.io/upscaler/v2/latest/vectorly-videojs.js

Shaka Player

https://cdn.vectorly.io/upscaler/v2/latest/vectorly-shaka.js

JW Player

https://cdn.vectorly.io/upscaler/v2/latest/vectorly-jwplayer.js

Core

If you need more control over the rendering and are integrating into a custom pipeline use the core Library

https://cdn.vectorly.io/upscaler/v2/latest/vectorly-core.js

NPM package

You can also load Vectorly's libraries through NPM. See the following github repo for a working demo.

Installation Using yarn

yarn add @vectorly-io/ai-upscaler

Using npm

npm install --save @vectorly-io/ai-upscaler

Usage

For our standalone upscaler, just import the library

import vectorlyUpscaler from '@vectorly-io/ai-upscaler';
// Use as vectoryUpscaler(video, config)

Plugins

If you want to use one of the javascript player plugins,

VideoJS

If using webpack v4

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/dist/vectorly-videojs.js';

If using webpack v5

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/videojs';
vectorlyUpscaler.register(videojs) // Register the plugin
const vjsUpscaler = player.vectorlyPlugin({token: "your-token-here"})
// vjsUpscaler is videoJSPlugin instance

Shaka Player

If using webpack v4

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/dist/vectorly-shaka.js';
// Use the plugin as vectorlyUpscaler.shakaPlugin

If using webpack v5

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/shaka';
// Use the plugin as vectorlyUpscaler.shakaPlugin

JW Player

If using webpack v4

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/dist/vectorly-jwplayer.js';
// Use the plugin as vectorlyUpscaler.jwPlugin

If using webpack v5

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/jwplayer';
// Use the plugin as vectorlyUpscaler.jwPlugin

Core

If you need more control over the rendering and are integrating into a custom pipeline use the core Library Check vectorlyUpscalerCore for usage

If using webpack v4

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/dist/vectorly-core.js';
// Use the vectorlyUpscalerCore class as vectorlyUpscaler.core

If using webpack v5

import vectorlyUpscaler from '@vectorly-io/ai-upscaler/core';
// Use the vectorlyUpscalerCore class as vectorlyUpscaler.core