camstreamerlib 4.0.35 → 4.0.36-c07c9c1

package/cjs/CamSwitcherAPI.d.ts

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

package/cjs/CamSwitcherAPI.js

@@ -156,6 +156,7 @@ class CamSwitcherAPI extends BasicAPI_1.BasicAPI {
             audio: {
                 sampleRate: data.audioSampleRate,
                 channelCount: data.audioChannelCount,
+                bitrate: data.audioBitrate,
             },
             keyboard: data.keyboard,
         };
@@ -207,6 +208,7 @@ class CamSwitcherAPI extends BasicAPI_1.BasicAPI {
         const settings = {
             audioSampleRate: saveData.audio?.sampleRate,
             audioChannelCount: saveData.audio?.channelCount,
+            audioBitrate: saveData.audio?.bitrate,
             keyboard: saveData.keyboard,
             fps: saveData.video.fps,
             resolution: saveData.video.resolution,

package/cjs/PlaneTrackerAPI.d.ts

@@ -45,8 +45,23 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             focusCalibrationPoints: string;
         };
         cameraConfig: {
-            defaultCaptureSizeMeters: number;
-            captureSizeExtensionMeters: number;
+            aircraft: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+            drone: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+        } | {
+            aircraft: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
+            drone: {
+                defaultCaptureSizeMeters: number;
+                captureSizeExtensionMeters: number;
+            };
         };
         stream: {
             width: number;
@@ -99,11 +114,29 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
             priority: number;
         };
         identificationLabel: {
-            firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
-            opacity: number;
+            aircraft: {
+                firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                opacity: number;
+            };
+            drone: {
+                firstRow: "blank" | "remote_id";
+                opacity: number;
+            };
+        } | {
+            aircraft: {
+                firstRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                secondRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                thirdRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                fourthRow: "blank" | "registration" | "call_sign" | "flight_number" | "icao";
+                opacity: number;
+            };
+            drone: {
+                firstRow: "blank" | "remote_id";
+                opacity: number;
+            };
         };
         acs: {
             ip: string;
@@ -181,11 +214,11 @@ export declare class PlaneTrackerAPI<Client extends IClient<TResponse, any>> ext
     importAppSettings(dataType: TImportDataType, formData: Parameters<Client['post']>[0]['data'], options?: THttpRequestOptions): Promise<void>;
     getDomainList(options?: THttpRequestOptions): Promise<Partial<Record<"adsb" | "remoteId", {
         uiName: string;
-        icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
+        icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
         categoryList: {
             categoryId: string;
             uiName: string;
-            icon: "unknown" | "small" | "large" | "heavy" | "helicopter" | "drone" | "operator" | "vehicle";
+            icon: "unknown" | "small" | "drone" | "large" | "heavy" | "helicopter" | "operator" | "vehicle";
         }[];
     }>>>;
     fetchFlightInfo(targetId: string, options?: THttpRequestOptions): Promise<{

package/cjs/VapixAPI.js

@@ -565,17 +565,21 @@ class VapixAPI extends BasicAPI_1.BasicAPI {
             allowBooleanAttributes: true,
         });
         const result = parser.parse(xml);
-        let apps = result.reply.application ?? [];
-        if (!Array.isArray(apps)) {
-            apps = [apps];
-        }
-        const appList = apps.map((app) => {
-            return {
-                ...app,
-                appId: VapixAPI_1.ALL_APP_IDS.find((id) => id.toLowerCase() === app.Name.toLowerCase()) ?? null,
-            };
-        });
-        return VapixAPI_1.applicationListSchema.parse(appList);
+        const rawApps = result.reply.application ?? [];
+        const apps = Array.isArray(rawApps) ? rawApps : [rawApps];
+        const appList = [];
+        for (const app of apps) {
+            const parsedApp = VapixAPI_1.applicationSchema.safeParse(app);
+            if (!parsedApp.success) {
+                console.debug('Skipping invalid application entry:', app, parsedApp.error.issues);
+                continue;
+            }
+            appList.push({
+                ...parsedApp.data,
+                appId: VapixAPI_1.ALL_APP_IDS.find((id) => id.toLowerCase() === parsedApp.data.Name.toLowerCase()) ?? null,
+            });
+        }
+        return appList;
     }
     async startApplication(applicationId, options) {
         const agent = this.getClient(options?.proxyParams);

package/cjs/VapixAPI.test.d.ts

@@ -0,0 +1 @@
+export {};

package/cjs/VapixAPI.test.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const VapixAPI_1 = require("./VapixAPI");
+const globals_1 = require("@jest/globals");
+const createApi = (xml) => {
+    const client = {
+        get: () => Promise.resolve(new Response(xml)),
+        post: () => Promise.reject(new Error('unused')),
+    };
+    return new VapixAPI_1.VapixAPI(client);
+};
+(0, globals_1.describe)('VapixAPI', () => {
+    (0, globals_1.describe)('getApplicationList', () => {
+        (0, globals_1.afterEach)(() => {
+            globals_1.jest.restoreAllMocks();
+        });
+        (0, globals_1.test)('skips the nameless entry of the live camera list', async () => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            const api = createApi(`<reply result="ok">
+ <application Name="camstreamer" NiceName="CamStreamer App" Vendor="CamStreamer" Version="5.0-15" ApplicationID="413135" License="None" Status="Running" ConfigurationPage="local/camstreamer/settings.html" />
+ <application Name="" License="None" Status="Stopped" />
+ <application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" ApplicationID="143440" License="None" Status="Stopped" ConfigurationPage="local/vmd/config.html" VendorHomePage="http://www.axis.com" LicenseName="Proprietary" />
+</reply>`);
+            await (0, globals_1.expect)(api.getApplicationList()).resolves.toEqual([
+                {
+                    Name: 'camstreamer',
+                    NiceName: 'CamStreamer App',
+                    Vendor: 'CamStreamer',
+                    Version: '5.0-15',
+                    ApplicationID: '413135',
+                    License: 'None',
+                    Status: 'Running',
+                    ConfigurationPage: 'local/camstreamer/settings.html',
+                    appId: 'CamStreamer',
+                },
+                {
+                    Name: 'vmd',
+                    NiceName: 'AXIS Video Motion Detection',
+                    Vendor: 'Axis Communications',
+                    Version: '4.4-5',
+                    ApplicationID: '143440',
+                    License: 'None',
+                    Status: 'Stopped',
+                    ConfigurationPage: 'local/vmd/config.html',
+                    VendorHomePage: 'http://www.axis.com',
+                    LicenseName: 'Proprietary',
+                    appId: null,
+                },
+            ]);
+            (0, globals_1.expect)(debugSpy).toHaveBeenCalledTimes(1);
+            (0, globals_1.expect)(debugSpy.mock.calls[0]).toContainEqual({ Name: '', License: 'None', Status: 'Stopped' });
+        });
+        globals_1.test.each([
+            {
+                name: 'an entry without a name',
+                xml: '<reply result="ok"><application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" License="None" Status="Stopped" /><application License="None" Status="Stopped" /></reply>',
+                expected: [
+                    {
+                        Name: 'vmd',
+                        NiceName: 'AXIS Video Motion Detection',
+                        Vendor: 'Axis Communications',
+                        Version: '4.4-5',
+                        License: 'None',
+                        Status: 'Stopped',
+                        appId: null,
+                    },
+                ],
+            },
+            {
+                name: 'a named entry missing informational fields',
+                xml: '<reply result="ok"><application Name="vmd" NiceName="AXIS Video Motion Detection" Vendor="Axis Communications" Version="4.4-5" License="None" Status="Stopped" /><application Name="broken" License="None" Status="Stopped" /></reply>',
+                expected: [
+                    {
+                        Name: 'vmd',
+                        NiceName: 'AXIS Video Motion Detection',
+                        Vendor: 'Axis Communications',
+                        Version: '4.4-5',
+                        License: 'None',
+                        Status: 'Stopped',
+                        appId: null,
+                    },
+                ],
+            },
+        ])('skips invalid entries individually: $name', async ({ xml, expected }) => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            await (0, globals_1.expect)(createApi(xml).getApplicationList()).resolves.toEqual(expected);
+            (0, globals_1.expect)(debugSpy).toHaveBeenCalledTimes(1);
+        });
+        globals_1.test.each([
+            {
+                name: 'drops attributes outside the schema',
+                xml: '<reply result="ok"><application Name="camoverlay" NiceName="CamOverlay App" Vendor="CamStreamer" Version="3.0-1" License="None" Status="Running" Unexpected="value" /></reply>',
+                expected: [
+                    {
+                        Name: 'camoverlay',
+                        NiceName: 'CamOverlay App',
+                        Vendor: 'CamStreamer',
+                        Version: '3.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'CamOverlay',
+                    },
+                ],
+            },
+            {
+                name: 'maps an application outside the core CamStreamer apps to its appId',
+                xml: '<reply result="ok"><application Name="sporttracker" NiceName="SportTracker App" Vendor="CamStreamer" Version="1.0-1" License="None" Status="Running" /></reply>',
+                expected: [
+                    {
+                        Name: 'sporttracker',
+                        NiceName: 'SportTracker App',
+                        Vendor: 'CamStreamer',
+                        Version: '1.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'SportTracker',
+                    },
+                ],
+            },
+            {
+                name: 'maps a capitalised application name to its appId',
+                xml: '<reply result="ok"><application Name="CamOverlay" NiceName="CamOverlay App" Vendor="CamStreamer" Version="3.0-1" License="None" Status="Running" /></reply>',
+                expected: [
+                    {
+                        Name: 'CamOverlay',
+                        NiceName: 'CamOverlay App',
+                        Vendor: 'CamStreamer',
+                        Version: '3.0-1',
+                        License: 'None',
+                        Status: 'Running',
+                        appId: 'CamOverlay',
+                    },
+                ],
+            },
+            {
+                name: 'returns an empty list when the camera has no applications',
+                xml: '<reply result="ok"></reply>',
+                expected: [],
+            },
+        ])('returns every valid entry with its appId and logs nothing: $name', async ({ xml, expected }) => {
+            const debugSpy = globals_1.jest.spyOn(console, 'debug').mockImplementation(() => { });
+            await (0, globals_1.expect)(createApi(xml).getApplicationList()).resolves.toEqual(expected);
+            (0, globals_1.expect)(debugSpy).not.toHaveBeenCalled();
+        });
+    });
+});

package/cjs/types/CamSwitcherAPI.d.ts

@@ -785,6 +785,7 @@ export declare const cameraOptionsSchema: z.ZodObject<{
     bitrateVapixParams: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     audioSampleRate: z.ZodOptional<z.ZodNumber>;
     audioChannelCount: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    audioBitrate: z.ZodOptional<z.ZodNumber>;
     keyboard: z.ZodOptional<z.ZodObject<{
         fromSource: z.ZodNullable<z.ZodString>;
         none: z.ZodNullable<z.ZodString>;
@@ -812,6 +813,7 @@ export declare const cameraOptionsSchema: z.ZodObject<{
     bitrateVapixParams?: string | null | undefined;
     audioSampleRate?: number | undefined;
     audioChannelCount?: 1 | 2 | undefined;
+    audioBitrate?: number | undefined;
 }, {
     resolution?: string | undefined;
     compression?: number | undefined;
@@ -829,6 +831,7 @@ export declare const cameraOptionsSchema: z.ZodObject<{
     bitrateVapixParams?: string | null | undefined;
     audioSampleRate?: number | undefined;
     audioChannelCount?: 1 | 2 | undefined;
+    audioBitrate?: number | undefined;
 }>;
 export type TCameraOptions = z.infer<typeof cameraOptionsSchema>;
 export declare const globalAudioSettingsTypeSchema: z.ZodUnion<[z.ZodLiteral<"fromSource">, z.ZodLiteral<"source">]>;

package/cjs/types/CamSwitcherAPI.js

@@ -145,6 +145,7 @@ exports.cameraOptionsSchema = common_1.bitrateVapixParamsSchema
     bitrateVapixParams: zod_1.z.string().nullable(),
     audioSampleRate: zod_1.z.number(),
     audioChannelCount: common_1.audioChannelCountSchema,
+    audioBitrate: zod_1.z.number().int().nonnegative(),
     keyboard: zod_1.z.object({
         fromSource: common_1.keyboardShortcutSchema,
         none: common_1.keyboardShortcutSchema,