camstreamerlib 4.0.31 → 4.0.32-c4420aa

package/README.md

@@ -39,6 +39,15 @@ npm install camstreamerlib
 
 </br>
 
+# Examples
+
+| Example                                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                           | Open in browser                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| [CamSwitcherEvents](examples/camswitcher-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/camswitcher-events.html))    | Logs every CamSwitcher event. `DeviceConnectClient` (HTTP) backs [CamSwitcherAPI](doc/CamSwitcherAPI.md) to obtain the websocket authorization token, `DeviceConnectWsClient` (websocket) backs [CamSwitcherEvents](doc/ws/CamSwitcherEvents.md), which validates and dispatches the events. Connection state is taken from the `authorization` event.                                                                | [open](https://raw.githack.com/CamStreamer/CamStreamerLib/master/examples/camswitcher-events.html)  |
+| [PlaneTrackerEvents](examples/planetracker-events.html) ([source](https://github.com/CamStreamer/CamStreamerLib/blob/master/examples/planetracker-events.html)) | Logs every PlaneTracker event. PlaneTracker needs no authorization token — [PlaneTrackerEvents](doc/ws/PlaneTrackerEvents.md) 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](https://raw.githack.com/CamStreamer/CamStreamerLib/master/examples/planetracker-events.html) |
+
+</br>
+
 # Breaking Changes
 
 <details open>

package/cjs/CamSwitcherAPI.d.ts

@@ -161,7 +161,7 @@ export declare class CamSwitcherAPI<Client extends IClient<TResponse, any>> exte
         bitrateVapixParams?: string | null | undefined;
         audioSampleRate?: number | undefined;
         audioChannelCount?: 1 | 2 | undefined;
-    }>;
+    } | undefined>;
     getGlobalAudioSettings(options?: THttpRequestOptions): Promise<{
         type: "source" | "fromSource";
         source: string;

package/cjs/CamSwitcherAPI.js

@@ -34,15 +34,13 @@ class CamSwitcherAPI extends BasicAPI_1.BasicAPI {
         return common_1.networkCameraListSchema.parse(res.data);
     }
     async generateSilence(sampleRate, channels, options) {
-        const agent = this.getClient(options?.proxyParams);
-        await agent.get({
-            path: `${BASE_PATH}/generate_silence.cgi`,
-            parameters: {
-                sample_rate: sampleRate.toString(),
-                channels,
-            },
-            timeout: options?.timeout,
-        });
+        const res = await this._getJson(`${BASE_PATH}/generate_silence.cgi`, {
+            sample_rate: sampleRate.toString(),
+            channels,
+        }, options);
+        if (res.status !== 200) {
+            throw new errors_1.GenerateSilenceError(res.message);
+        }
     }
     async getMaxFps(source, options) {
         const res = await this._getJson(`${BASE_PATH}/get_max_framerate.cgi`, {
@@ -204,11 +202,7 @@ class CamSwitcherAPI extends BasicAPI_1.BasicAPI {
     async getCamSwitchOptions(options) {
         const saveData = await this.getParamFromCameraAndJSONParse(CSW_PARAM_NAMES.SETTINGS, options);
         if ((0, utils_1.isNullish)(saveData.video)) {
-            return CamSwitcherAPI_1.cameraOptionsSchema.parse({
-                audioSampleRate: saveData.audio?.sampleRate,
-                audioChannelCount: saveData.audio?.channelCount,
-                keyboard: saveData.keyboard,
-            });
+            return;
         }
         const settings = {
             audioSampleRate: saveData.audio?.sampleRate,

package/cjs/browser.index.d.ts

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/cjs/browser.index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index"), exports);
+__exportStar(require("./web/index"), exports);

package/cjs/errors/errors.d.ts

@@ -49,6 +49,9 @@ export declare class FetchDeviceInfoError extends Error {
 export declare class AddNewClipError extends Error {
     constructor(message: string);
 }
+export declare class GenerateSilenceError extends Error {
+    constructor(message: string);
+}
 export declare class PtzNotSupportedError extends Error {
     constructor();
 }

package/cjs/errors/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MigrationError = exports.BadRequestError = exports.ServerError = exports.InvalidAltitudeError = exports.InvalidLatLngError = exports.CannotSetCoordsInAutoModeError = exports.ImportSettingsError = exports.ResetCalibrationError = exports.TimezoneFetchError = exports.TimezoneNotSetupError = exports.UtcTimeFetchError = exports.WsAuthorizationError = exports.StorageDataFetchError = exports.PtzNotSupportedError = exports.AddNewClipError = exports.FetchDeviceInfoError = exports.NoDeviceInfoError = exports.MaxFPSError = exports.SDCardJobError = exports.SDCardActionError = exports.ApplicationAPIError = exports.SettingParameterError = exports.ParameterNotFoundError = exports.JsonParseError = exports.ParsingBlobError = exports.ServiceNotFoundError = exports.ServiceUnavailableError = exports.ErrorWithResponse = void 0;
+exports.MigrationError = exports.BadRequestError = exports.ServerError = exports.InvalidAltitudeError = exports.InvalidLatLngError = exports.CannotSetCoordsInAutoModeError = exports.ImportSettingsError = exports.ResetCalibrationError = exports.TimezoneFetchError = exports.TimezoneNotSetupError = exports.UtcTimeFetchError = exports.WsAuthorizationError = exports.StorageDataFetchError = exports.PtzNotSupportedError = exports.GenerateSilenceError = exports.AddNewClipError = exports.FetchDeviceInfoError = exports.NoDeviceInfoError = exports.MaxFPSError = exports.SDCardJobError = exports.SDCardActionError = exports.ApplicationAPIError = exports.SettingParameterError = exports.ParameterNotFoundError = exports.JsonParseError = exports.ParsingBlobError = exports.ServiceNotFoundError = exports.ServiceUnavailableError = exports.ErrorWithResponse = void 0;
 class ErrorWithResponse extends Error {
     res;
     constructor(res) {
@@ -111,6 +111,13 @@ class AddNewClipError extends Error {
     }
 }
 exports.AddNewClipError = AddNewClipError;
+class GenerateSilenceError extends Error {
+    constructor(message) {
+        super('Error generating silence clip: ' + message);
+        this.name = 'GenerateSilenceError';
+    }
+}
+exports.GenerateSilenceError = GenerateSilenceError;
 class PtzNotSupportedError extends Error {
     constructor() {
         super('Ptz not supported.');

package/esm/CamSwitcherAPI.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { AddNewClipError, ParameterNotFoundError } from './errors/errors';
+import { AddNewClipError, GenerateSilenceError, ParameterNotFoundError } from './errors/errors';
 import { parseBitrateOptionsToVapixParams, parseVapixParamsToBitrateOptions } from './internal/convertors';
 import { isClip, isNullish } from './internal/utils';
 import { storageInfoListSchema, outputInfoSchema, audioPushInfoSchema, clipListSchema, playlistQueueSchema, streamSaveLoadSchema, clipSaveLoadSchema, playlistSaveLoadSchema, trackerSaveLoadSchema, secondaryAudioSettingsSchema, globalAudioSettingsSchema, clipFilesListSchema, cameraOptionsSchema, } from './types/CamSwitcherAPI';
@@ -31,15 +31,13 @@ export class CamSwitcherAPI extends BasicAPI {
         return networkCameraListSchema.parse(res.data);
     }
     async generateSilence(sampleRate, channels, options) {
-        const agent = this.getClient(options?.proxyParams);
-        await agent.get({
-            path: `${BASE_PATH}/generate_silence.cgi`,
-            parameters: {
-                sample_rate: sampleRate.toString(),
-                channels,
-            },
-            timeout: options?.timeout,
-        });
+        const res = await this._getJson(`${BASE_PATH}/generate_silence.cgi`, {
+            sample_rate: sampleRate.toString(),
+            channels,
+        }, options);
+        if (res.status !== 200) {
+            throw new GenerateSilenceError(res.message);
+        }
     }
     async getMaxFps(source, options) {
         const res = await this._getJson(`${BASE_PATH}/get_max_framerate.cgi`, {
@@ -201,11 +199,7 @@ export class CamSwitcherAPI extends BasicAPI {
     async getCamSwitchOptions(options) {
         const saveData = await this.getParamFromCameraAndJSONParse(CSW_PARAM_NAMES.SETTINGS, options);
         if (isNullish(saveData.video)) {
-            return cameraOptionsSchema.parse({
-                audioSampleRate: saveData.audio?.sampleRate,
-                audioChannelCount: saveData.audio?.channelCount,
-                keyboard: saveData.keyboard,
-            });
+            return;
         }
         const settings = {
             audioSampleRate: saveData.audio?.sampleRate,

package/esm/browser.index.js

@@ -0,0 +1,2 @@
+export * from './index';
+export * from './web/index';

package/esm/errors/errors.js

@@ -94,6 +94,12 @@ export class AddNewClipError extends Error {
         this.name = 'AddNewClipError';
     }
 }
+export class GenerateSilenceError extends Error {
+    constructor(message) {
+        super('Error generating silence clip: ' + message);
+        this.name = 'GenerateSilenceError';
+    }
+}
 export class PtzNotSupportedError extends Error {
     constructor() {
         super('Ptz not supported.');

package/examples/README.md

@@ -0,0 +1,43 @@
+# Examples
+
+Standalone browser examples that use CamStreamerLib directly from a `<script type="module">`,
+without a bundler or a framework.
+
+## Build the browser bundle
+
+```bash
+npm install
+npm run build:browser
+```
+
+## Run
+
+Modules can't be loaded over `file://`, so serve the folder over HTTP:
+
+```bash
+npx serve examples
+```
+
+Both pages connect to a camera through the Device Connect proxy. Fill in the device host
+(`<MAC_ADDRESS>.device-connect.net`) and the device access token in the form, or hardcode them in the
+`DEVICE_HOST` / `DEVICE_ACCESS_TOKEN` constants at the top of the page's script to have the form
+prefilled. See [doc/Client.md](../doc/Client.md).
+
+## camswitcher-events.html
+
+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.
+
+See [doc/ws/CamSwitcherEvents.md](../doc/ws/CamSwitcherEvents.md).
+
+## planetracker-events.html
+
+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.
+
+`CAMERA_POSITION` and `FLIGHT_LIST` arrive continuously, so by default they only update the summary
+line above the log; tick the checkbox to log them as well.
+
+See [doc/ws/PlaneTrackerEvents.md](../doc/ws/PlaneTrackerEvents.md).