CamStreamerLib
Web and Node.js helper library for CamStreamer ACAP applications.
The library is primarily developed for ACAP applications running directly in Axis cameras.
Installation
npm install camstreamerlib
Documentation for ACAP and Camera API
| API | Description |
|---|---|
| VapixAPI | Module to access Axis camera VAPIX interface. |
| CamStreamerAPI | Module for easy control of video streaming in the CamStreamer ACAP application (RTMP, HLS, SRT and MPEG-TS protocols). |
| CamOverlayAPI | Module to access CamOverlay API. |
| CamScripterAPI | Module to access CamScripter API. |
| CamSwitcherAPI | Module to access CamSwitcher API. |
| PlaneTrackerAPI | Module to access PlaneTracker API. |
| CamStreamerEvents | Module which allows receiving events from CamStreamer ACAP application. |
| CamOverlayEvents | Module which allows receiving events from CamOverlay ACAP application. |
| CamSwitcherEvents | Module which allows receiving events from CamSwitcher ACAP application. |
| PlaneTrackerEvents | Module which allows receiving events from PlaneTracker ACAP application. |
Documentation for Node.js modules
| Module | Description |
|---|---|
| HttpServer | Module for processing HTTP requests in your scripts. It also automatically serves up the content from html directory or you can register paths which you can process by your own (e.g. http://$CAMERA_IP/local/camscripter/proxy/$MY_PACKAGE_NAME/control.cgi). |
| VapixEvents | Module which allows receiving camera events from the VAPIX API. |
| CamOverlayDrawingAPI | Module for easy control of CamOverlay drawing API. For more details on supported video overlay drawing functions see https://camstreamer.com/camoverlay-api1 |
| CamOverlayPainter | Contains three modules which makes easier to use CamOverlayDrawingAPI. |
| CamScripterAPICameraEventsGenerator | Module which allows generating events on an Axis camera. These events can be used for triggers in the Axis camera rule engine (events/actions). It is also an easy way how to integrate events and metadata in VMS systems which support Axis camera events. |
| GenetecAgent | Module which allows receiving and sending data to Genetec VMS. |
| TimeZoneDaemon | Module for periodically checking and updating the Node.js process timezone to match the system timezone. |
Examples
| Example | Description | Open in browser |
|---|---|---|
| CamSwitcherEvents (source) | Logs every CamSwitcher event. DeviceConnectClient (HTTP) backs CamSwitcherAPI to obtain the websocket authorization token, DeviceConnectWsClient (websocket) backs CamSwitcherEvents, which validates and dispatches the events. Connection state is taken from the authorization event. |
open |
| PlaneTrackerEvents (source) | Logs every PlaneTracker event. PlaneTracker needs no authorization token — PlaneTrackerEvents announces the connecting user (userId / userName / userPriority, editable in the form) as the init message instead, so only the websocket client is needed. The continuous CAMERA_POSITION and FLIGHT_LIST events only update the summary line unless the checkbox is ticked. |
open |
Breaking Changes
from version 4.\*.\* to 5.\*.\* (latest)
Breaking changes when moving from version 4.*.* to 5.*.* (latest)
Zod Upgraded to v4
The library now depends on zod v4 (^4.6.7) instead of v3 (fixes GHSA-mrhx-c7xc-m3w5). All exported schemas are zod v4 schemas.
- If your project uses the exported schemas together with its own
zod(e.g.z.array(domainIdSchema),schema.extend(...),z.infer<typeof schema>, form resolvers), upgrade yourzodto v4 as well. Mixing zod v3 and v4 schemas does not work. - Object keys declared as
z.unknown()/z.any()are now required in the inferred types (e.g.TGuardTourfields,postJsonBodyin PlaneTracker events). - See the zod v4 migration guide for changes in your own schemas.
TypeScript 5.9 or Newer Required
Exported types (e.g. the camelCase/snake_case types in CamSwitcherAPI and VapixAPI) are built on type-fest v5, which requires TypeScript >=5.9 with strict: true in your tsconfig.json.
VapixEvents Upgraded to eventemitter2 v6
VapixEvents now extends EventEmitter2 from eventemitter2 v6. Its typings are stricter, e.g. eventNames() returns (string | symbol | event[])[] instead of string[], so code relying on the old types may need to narrow the values.
Node.js 18 or Newer Required
package.json now declares "engines": { "node": ">=18" }.
from version 3.\*.\* to 4.\*.\*
Breaking changes when moving from version 3.*.* to 4.*.*
ACAP API Class Constructors Updated
All ACAP API classes now require a client instance to be passed into their constructors instead of options object.
- This change improves flexibility by allowing you to use either the Node or Web client, depending on your environment.
Example (before → now):
// Before
const coApi = new CamOverlayAPI({
ip?: string;
port?: number;
user?: string;
pass?: string;
tls?: boolean;
tlsInsecure?: boolean;
keepAlive?: boolean
});
// Now
import { DefaultClient } from 'camstreamerlib/web';
import { CamOverlayAPI } from 'camstreamerlib';
// Use DefaultClient in constructor
const coApi = new CamOverlayAPI(
new DefaultClient()
);
// Or adjust DefaultClient default values with your own
const coApi = new CamOverlayAPI(
new DefaultClient({
tls: false,
tlsInsecure: false,
host: '127.0.0.1',
port: 80,
user: '',
pass: '',
})
);
Imports Simplified
Importing from the camstreamerlib is now much easier -> all exports are now re-exported from the root index.js. You no longer need to import from subpaths.
Example:
// Before
import { CamScripterAPI } from 'camstreamerlib/CamScripterAPI';
import { Painter } from 'camstreamerlib/CamOverlayPainter/Painter';
import { DefaultAgent } from 'camstreamerlib/DefaultAgent';
// Now
import { CamScripterAPI } from 'camstreamerlib';
import { Painter } from 'camstreamerlib/node';
import { DefaultClient } from 'camstreamerlib/web';
Note: To ensure compatibility, set the module resolution in your web projects tsconfig.json to
"moduleResolution": "bundler".
Classes and Methods Refactored
- CameraVapix API has been renamed to VapixAPI.
- DefaultAgent has been refactored into two separate classes - one for node, one for web as DefaultClient
- Several method names and parameter names across the library have been updated for consistency and clarity.
- New API modules and endpoints have been introduced, providing extended functionality and better coverage of the underlying service.
Stream List Migration
CamStreamerAPI.getStreamList()andgetStream()now throw aMigrationErrorwhen old-format (v3) stream data is detected on the camera.MigrationErrorprovides four arrays to help you handle the transition:.valid,.old,.invalid, and.unknown.
import { MigrationError } from 'camstreamerlib';
try {
const streams = await csApi.getStreamList();
} catch (e) {
if (e instanceof MigrationError) {
console.log('Valid streams:', e.valid);
console.log('Old-format streams needing migration:', e.old);
}
}
CreatePackage Script Path Changed
- The path to the
CreatePackagescript changed fromcamstreamerlib/CreatePackage.jstocamstreamerlib/bin/CreatePackage.js. - Update any
package.jsonscripts accordingly:
"scripts": {
"create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js"
}
from version 2.\*.\* to 3.\*.\*
Breaking changes when moving from version 2.*.* to 3.*.*
CamStreamerlib requiers Node.js version 18 or higher.
CamOverlayDrawingAPI tries to reconnect when the websocket is closed. You don't have to do it manually.
However, events
openandcloseare still emitted in case you need to react to them.Files
common.ts,Digest.ts,HttpRequest.tsandWsClient.tsmoved to a folder internal.Removed function
httpRequest(). UsesendRequest()instead. It uses the same interface except for the "noWaitForData" parameter.
It returns (Response object)[https://developer.mozilla.org/en-US/docs/Web/API/Response] which doesn't contain data by default. If you need to wait for data, you can call for example the function
await res.text(). This change affects the functionvapixGetfrom (CameraVapix)[doc/CameraVapix.md] too.
from version 1.\*.\* to 2.\*.\**
Breaking changes when moving from version 1.*.* to 2.*.*
Renamed file HTTPRequest.ts to HttpRequest.ts
Removed deprecated protocol attribute from all options objects (use tls instead).
Removed RTSP
Previously CameraVapix.ts supported both WebSocket and RTSP. Starting with version 2.0.0, it supports WebSocket only.
ServiceID shouldn't be passed to CamOverlayAPI by the options object. Pass it as a parameter.
Renamed CamOverlayDrawingAPI event msg to message.
Drawing services extracted from CamOverlayAPI.ts to a separate file.
Please read CamOverlayAPI and CamOverlayDrawingAPI for more information.
For Developers
Publishing to npm repository
Run npm run publishPackage.
It will:
- Require npm user
camstreamer(prompts login if needed). - Run
lint,pretty:check, andbuild. - Publish from
masteraslatest. - Publish from other branches as
dev-*(ordev). - Refuse
latestpublish if the same version is already on npm or ifpackage.jsonversion is not committed.
Preparing a package to upload to CamScripter
If you want to create your own package and upload it to CamScripter App, you can use the script CreatePackage. It creates a zip file which contains all required files and directories in your package folder. The script accepts source code written either in JavaScript or TypeScript if the package has the correct structure (more information in https://github.com/CamStreamer/CamScripterApp_examples/#readme). To include this script in your package add the following lines in the file package.json:
"scripts": {
"create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js"
}
By default, the zipped package does not contain node_modules directory. If you want to include it (required when uploading to CamScripter App on Axis camera), add -includeNodeModules or -i parameter.
If you need to exclude a file or directory add -exlude= or -e= parameter with comma separated list.
The zip package is created in the current directory. You can choose different location with the -where= or -w= option.
"scripts": {
"create-package": "node node_modules/camstreamerlib/bin/CreatePackage.js -i -e=react"
}
Path to
CreatePackagescript has changed fromcamstreamerlib/CreatePackage.jstocamstreamerlib/bin/CreatePackage.js(from v.4.0.0)