// Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
This repository contains Network Optix Meta Platform open source web packages - the source code and published packages used in building Nx Meta Cloud Portal, Webadmin, and various web projects within Network Optix that might be useful for third-party developers.
At this moment, Network Optix is not able to process any pull/merge requests to this repository. It is likely that a policy for contributions will be developed and offered in the future.
For libraries contained in this repository the compiled packages will be published to the appropriate package manager.
- Javascript / Typescript (NPM): https://www.npmjs.com/org/networkoptix
| Package | Description |
|---|---|
@networkoptix/webrtc-stream-manager |
WebRTC streaming library for Nx Meta VMS cameras (v1). Provides an RxJS Observable-based API for establishing and managing WebRTC connections. |
@networkoptix/webrtc-stream-manager-v2 |
WebRTC streaming library for Nx Meta VMS cameras (v2). Improved lifecycle management with automatic quality optimization, MSE fallback, LRU-based connection caching, and analytics metadata support. Includes a legacy adapter for zero-change migration from v1. |
@networkoptix/object-tracking-overlay |
Canvas/DOM overlay for visualizing tracked objects with bounding boxes, hover-to-expand detail views, and physics-based layout for expanded nodes. |
@networkoptix/overlay-shared |
Shared types, utilities, and base classes for overlay packages. Provides AnimationLoop, Renderer interface, spatial/lerp utilities, and SVG layer helpers. |
The repository is set up as a monorepo with the root folder containing shared files for maintaining
the project. The source code relevant to external developers is in /packages and /examples.
The /packages directory contains the source code for our published packages. The Javascript packages
are all written in Typescript with type definitions and source maps included so it's suggested that
these are added to your project through NPM.
The /examples directory contains usage examples for some of the packages in /packages and also
some general examples for interacting with the Nx Witness Video Management System (VMS) Server.
All Javascript/Node examples contain an npm start script for running the demo/example.
Examples for a specific package in /packages ends with -example so the
/webrtc-stream-manager-example is for the /webrtc-stream-manager package.
General demos for interacting with the VMS Server end with -demo. These demos will probably use
one or more packages from /packages but are purposed with demonstrating interactions instead of
being instructional on a specific package.
The Nx Meta Platform Open Source Web Packages incorporates, depends upon, interacts with, or was developed using a number of free and open-source software components. The full list of such components can be found at OPEN SOURCE SOFTWARE DISCLOSURE. Please see the linked component websites for additional licensing, dependency, and use information, as well as the component source code.