@wowyow/vision-node v1.13.5

WowYow Vision Node.js SDK

Getting Started

Examples

SDK Documentation

Data Schema

RTSP

Getting Started

Install

npm install '@wowyow/vision-node'

Include

const Vision = require('@wowyow/vision-node');

Authorize

Vision.APIKey = '';

WowYow API Key can be obtained from WowYow AI Studio.

Initialize

let vision = new Vision('https://www.youtube.com/watch?v=IgiB3dyxUvc');

Examples

YouTube Video URL

MP4 Video URL

MP4 Upload

WebM Upload

RTSP

Documentation

Initialization

There are several ways of initializing the process. As soon as Vision class is instantiated, the processing will begin. Entire process consists of of several subprocesses depending on file type or link. They are: upload, frame extraction & detection.

URL

let vision = new Vision('https://www.youtube.com/watch?v=IgiB3dyxUvc');

Supported sites: YouTube, Dailymotion, Vimeo, Discovery, FOX, Instagram, Facebook & more.

Video Upload

let vision = new Vision('./people_dancing.mp4');

Only mp4 & webm file types are supported.

Configuration

SDK Offers range of configuration options to optimize performance or help debugging. Configuration is passed as second argument in SDK.

Config Example

let vision = new Vision(e, {
  models: ['DETECT_SCENE', 'DETECT_PEOPLE']
});

Events

vision.on('progress', ({ event, progress }) => {}); // events are: upload, frame-extraction & detection.
vision.on('data', (data) => {}); // See Data Schema section for details
vision.on('start', () => {});
vision.on('pause', () => {});
vision.on('resume', () => {});
vision.on('end', () => {});
vision.on('error', (err) => {});
vision.on('metadata', (metadata) => {}); // See Metadata section for details
vision.on('stream', (stream) => {}); // See Stream section for details

Methods

vision.pause();
vision.resume();
vision.stop();

Properties

vision.started;
vision.ended;
vision.paused;
vision.metadata;
vision.stream;

Static Methods

// check if there is an avilable server
let available = Vision.available({
  target: ''
});
console.log(available); // true, false

// fetch complete algorithms
let algorithms = Vision.algorithms({
  target: ''
});
console.log(algorithms); // list of algorithms

// fetch available nodes
let nodes = Vision.nodes({
  target: ''
});
console.log(nodes); // list of nodes available to be used in algorithms

Data Schema

Metadata

Stream

Model Schema

DETECT_SCENE

DETECT_PEOPLE

DETECT_CLOTHING

RTSP

RTSP processing differs from videos with fixed duration. Serveral things need to be kept in mind when using it:

1. Response data frame and timestamp use start of processing as reference point, starting both from 0.
2. By default, frames are dropped if processing is lagging behind video playback for any reason. Whether it's because of low processing fps or network issues.

BBox