camstreamerlib 4.0.0-beta.37 → 4.0.0-beta.38

package/types/VapixAPI.d.ts

@@ -1,5 +1,5 @@
 import { IClient, TParameters, TResponse } from './internal/types';
-import { TAudioSampleRates, TSDCardInfo, TPtzOverview, TCameraPTZItem, TCameraPTZItemData, TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
+import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
 import { ProxyClient } from './internal/ProxyClient';
 import { TCameraImageConfig, THttpRequestOptions, TProxyParams } from './types/common';
 export declare class VapixAPI<Client extends IClient<TResponse, any>> {
@@ -14,9 +14,16 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
     postJson(path: string, jsonData: Record<string, any>, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
     getCameraImage(parameters: TCameraImageConfig, options?: THttpRequestOptions): Promise<ReturnType<Client["get"]>>;
     getEventDeclarations(options?: THttpRequestOptions): Promise<string>;
-    getSupportedAudioSampleRate(options?: THttpRequestOptions): Promise<TAudioSampleRates[]>;
+    getSupportedAudioSampleRate(options?: THttpRequestOptions): Promise<{
+        sampleRate: number;
+        bitRates: number[];
+    }[]>;
     performAutofocus(options?: THttpRequestOptions): Promise<void>;
-    checkSDCard(options?: THttpRequestOptions): Promise<TSDCardInfo>;
+    checkSDCard(options?: THttpRequestOptions): Promise<{
+        status: "OK" | "connected" | "disconnected";
+        totalSize: number;
+        freeSize: number;
+    }>;
     mountSDCard(options?: THttpRequestOptions): Promise<number>;
     unmountSDCard(options?: THttpRequestOptions): Promise<number>;
     private _doSDCardMountAction;
@@ -54,13 +61,28 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
         camNbr?: unknown;
         randomEnabled?: unknown;
         timeBetweenSequences?: unknown;
-    }[]>;
-    setGuardTourEnabled(guardTourID: string, enable: boolean, options?: THttpRequestOptions): Promise<void>;
+    }>;
+    setGuardTourEnabled(guardTourId: string, enable: boolean, options?: THttpRequestOptions): Promise<void>;
     getPTZPresetList(channel: number, options?: THttpRequestOptions): Promise<string[]>;
-    listPTZ(camera: number, options?: THttpRequestOptions): Promise<TCameraPTZItem[]>;
-    listPtzVideoSourceOverview(options?: THttpRequestOptions): Promise<TPtzOverview>;
+    listPTZ(camera: number, options?: THttpRequestOptions): Promise<{
+        name: string;
+        id: number;
+        data: {
+            pan?: number | undefined;
+            tilt?: number | undefined;
+            zoom?: number | undefined;
+        };
+    }[]>;
+    listPtzVideoSourceOverview(options?: THttpRequestOptions): Promise<Record<number, {
+        name: string;
+        id: number;
+    }[]>>;
     goToPreset(channel: number, presetName: string, options?: THttpRequestOptions): Promise<TResponse>;
-    getPtzPosition(camera: number, options?: THttpRequestOptions): Promise<TCameraPTZItemData>;
+    getPtzPosition(camera: number, options?: THttpRequestOptions): Promise<{
+        pan?: number | undefined;
+        tilt?: number | undefined;
+        zoom?: number | undefined;
+    }>;
     getPorts(options?: THttpRequestOptions): Promise<{
         name: string;
         port: string;
@@ -73,10 +95,22 @@ export declare class VapixAPI<Client extends IClient<TResponse, any>> {
     }[]>;
     setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
     setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
-    getApplicationList(options?: THttpRequestOptions): Promise<any>;
-    startApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
-    restartApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
-    stopApplication(applicationID: string, options?: THttpRequestOptions): Promise<void>;
+    getApplicationList(options?: THttpRequestOptions): Promise<{
+        Name: string;
+        NiceName: string;
+        Vendor: string;
+        Version: string;
+        License: string;
+        Status: string;
+        appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | null;
+        ApplicationID?: string | undefined;
+        ConfigurationPage?: string | undefined;
+        VendorHomePage?: string | undefined;
+        LicenseName?: string | undefined;
+    }[]>;
+    startApplication(applicationId: string, options?: THttpRequestOptions): Promise<void>;
+    restartApplication(applicationId: string, options?: THttpRequestOptions): Promise<void>;
+    stopApplication(applicationId: string, options?: THttpRequestOptions): Promise<void>;
     installApplication(data: Parameters<typeof FormData.prototype.append>[1], fileName: string, options?: THttpRequestOptions): Promise<void>;
     private static parseParameters;
     private static parseCameraPtzResponse;

package/types/bin/CreatePackage.d.ts

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

package/types/{CamOverlayDrawingAPI.d.ts → node/CamOverlayDrawingAPI.d.ts}

@@ -2,7 +2,7 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import EventEmitter from 'events';
-import { CamOverlayDrawingOptions, TCairoCreateResponse, TCairoResponse, TUploadImageResponse, TWriteTextParams } from './types/CamOverlayDrawingAPI';
+import { CamOverlayDrawingOptions, TCairoCreateResponse, TCairoResponse, TUploadImageResponse, TWriteTextParams } from '../types/CamOverlayDrawingAPI';
 export declare class CamOverlayDrawingAPI extends EventEmitter {
     private tls;
     private tlsInsecure;

package/types/{CamOverlayPainter → node/CamOverlayPainter}/Frame.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import { CamOverlayDrawingAPI } from '../CamOverlayDrawingAPI';
-import { TAlign, TCairoCreateResponse, TUploadImageResponse } from '../types/CamOverlayDrawingAPI';
+import { TAlign, TCairoCreateResponse, TUploadImageResponse } from '../../types/CamOverlayDrawingAPI';
 import { ResourceManager } from './ResourceManager';
-import { TBg, TBorder, TDrawingCallback, TFrame, TFrameOptions, TObjectFitType, TRgb, TRgba, TText, TTmf } from '../types/CamOverlayPainter';
+import { TBg, TBorder, TDrawingCallback, TFrame, TFrameOptions, TObjectFitType, TRgb, TRgba, TText, TTmf } from '../../types/CamOverlayPainter';
 export declare class Frame extends EventEmitter {
     protected enabled: boolean;
     protected posX: number;

package/types/{CamOverlayPainter → node/CamOverlayPainter}/Painter.d.ts

@@ -1,19 +1,8 @@
 import { CamOverlayDrawingAPI } from '../CamOverlayDrawingAPI';
-import { CamOverlayDrawingOptions } from '../types/CamOverlayDrawingAPI';
+import { CamOverlayDrawingOptions } from '../../types/CamOverlayDrawingAPI';
 import { ResourceManager } from './ResourceManager';
 import { Frame } from './Frame';
-import { TCoAlignment, TPainterOptions } from '../types/CamOverlayPainter';
-export declare const COORD: {
-    readonly top_left: readonly [-1, -1];
-    readonly center_left: readonly [-1, 0];
-    readonly bottom_left: readonly [-1, 1];
-    readonly top_center: readonly [0, -1];
-    readonly center: readonly [0, 0];
-    readonly bottom_center: readonly [0, 1];
-    readonly top_right: readonly [1, -1];
-    readonly center_right: readonly [1, 0];
-    readonly bottom_right: readonly [1, 1];
-};
+import { TCoAlignment, TPainterOptions } from '../../types/CamOverlayPainter';
 export declare class Painter extends Frame {
     private screenWidth;
     private screenHeight;

package/types/{CamOverlayPainter → node/CamOverlayPainter}/ResourceManager.d.ts

@@ -1,5 +1,5 @@
 import { CamOverlayDrawingAPI } from '../CamOverlayDrawingAPI';
-import { TUploadImageResponse, TCairoCreateResponse } from '../types/CamOverlayDrawingAPI';
+import { TUploadImageResponse, TCairoCreateResponse } from '../../types/CamOverlayDrawingAPI';
 export declare class ResourceManager {
     private co;
     private imgFileNames;

package/types/node/CamScripterAPICameraEventsGenerator.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import { WsOptions } from '../internal/types';
+import { TCamScripterEvent, TEventDeclaration, TEventUndeclaration, TCamScripterResponse } from '../types/CamScripterAPICameraEventsGenerator';
+export declare class CamScripterAPICameraEventsGenerator extends EventEmitter {
+    private tls;
+    private tlsInsecure;
+    private ip;
+    private port;
+    private user;
+    private pass;
+    private callId;
+    private sendMessages;
+    private timeoutCheckTimer;
+    private wsConnected;
+    private ws;
+    constructor(options?: WsOptions);
+    connect(): void;
+    disconnect(): void;
+    declareEvent(eventDeclaration: TEventDeclaration): Promise<TCamScripterResponse>;
+    undeclareEvent(eventUndeclaration: TEventUndeclaration): Promise<TCamScripterResponse>;
+    sendEvent(event: TCamScripterEvent): Promise<TCamScripterResponse>;
+    private createWsClient;
+    private incomingWsMessageHandler;
+    private sendMessage;
+    private startMsgsTimeoutCheck;
+    private stopMsgsTimeoutCheck;
+    private reconnectWithError;
+    private reportErr;
+    private reportClose;
+}

package/types/node/VapixEvents.d.ts

@@ -0,0 +1,16 @@
+import { EventEmitter2 as EventEmitter } from 'eventemitter2';
+import { WsOptions } from '../internal/types';
+export declare class VapixEvents extends EventEmitter {
+    private tls;
+    private tlsInsecure;
+    private ip;
+    private port;
+    private user;
+    private pass;
+    private ws;
+    constructor(options?: WsOptions);
+    connect(): void;
+    disconnect(): void;
+    private createWsClient;
+    private isReservedEventName;
+}

package/types/node/events/GenetecAgent.d.ts

@@ -1,146 +1,4 @@
-import { z } from 'zod';
-declare const cameraGuidsResponseSchema: z.ZodObject<{
-    Rsp: z.ZodObject<{
-        Status: z.ZodLiteral<"Ok">;
-        Result: z.ZodArray<z.ZodObject<{
-            Guid: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            Guid: string;
-        }, {
-            Guid: string;
-        }>, "many">;
-    }, "strip", z.ZodTypeAny, {
-        Status: "Ok";
-        Result: {
-            Guid: string;
-        }[];
-    }, {
-        Status: "Ok";
-        Result: {
-            Guid: string;
-        }[];
-    }>;
-}, "strip", z.ZodTypeAny, {
-    Rsp: {
-        Status: "Ok";
-        Result: {
-            Guid: string;
-        }[];
-    };
-}, {
-    Rsp: {
-        Status: "Ok";
-        Result: {
-            Guid: string;
-        }[];
-    };
-}>;
-export type TCameraGuidsResponse = z.infer<typeof cameraGuidsResponseSchema>;
-declare const cameraDetailSchema: z.ZodObject<{
-    Guid: z.ZodOptional<z.ZodString>;
-    Name: z.ZodOptional<z.ZodString>;
-    EntityType: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    Name?: string | undefined;
-    Guid?: string | undefined;
-    EntityType?: string | undefined;
-}, {
-    Name?: string | undefined;
-    Guid?: string | undefined;
-    EntityType?: string | undefined;
-}>;
-declare const cameraDetailsResponseSchema: z.ZodObject<{
-    Rsp: z.ZodObject<{
-        Status: z.ZodLiteral<"Ok">;
-        Result: z.ZodUnion<[z.ZodArray<z.ZodObject<{
-            Guid: z.ZodOptional<z.ZodString>;
-            Name: z.ZodOptional<z.ZodString>;
-            EntityType: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }, {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }>, "many">, z.ZodObject<{
-            Guid: z.ZodOptional<z.ZodString>;
-            Name: z.ZodOptional<z.ZodString>;
-            EntityType: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }, {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }>]>;
-    }, "strip", z.ZodTypeAny, {
-        Status: "Ok";
-        Result: {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        } | {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }[];
-    }, {
-        Status: "Ok";
-        Result: {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        } | {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }[];
-    }>;
-}, "strip", z.ZodTypeAny, {
-    Rsp: {
-        Status: "Ok";
-        Result: {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        } | {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }[];
-    };
-}, {
-    Rsp: {
-        Status: "Ok";
-        Result: {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        } | {
-            Name?: string | undefined;
-            Guid?: string | undefined;
-            EntityType?: string | undefined;
-        }[];
-    };
-}>;
-export type TCameraDetailsResponse = z.infer<typeof cameraDetailsResponseSchema>;
-export type TCameraDetail = z.infer<typeof cameraDetailSchema>;
-export type TParams = Array<'Guid' | 'Name' | 'EntityType'>;
-export type TProtocol = 'http' | 'https' | 'https_insecure';
-export type GenetecAgentOptions = {
-    protocol?: TProtocol;
-    ip?: string;
-    port?: number;
-    baseUri?: string;
-    user?: string;
-    pass?: string;
-    appId?: string;
-    timeout?: number;
-};
+import { GenetecAgentOptions, TCameraDetail, TCameraGuidsResponse, TParams } from '../../types/GenetecAgent';
 export declare class GenetecAgent {
     private settings;
     private baseUrl;
@@ -156,4 +14,3 @@ export declare class GenetecAgent {
     private getTimeStamp;
     private fetchWithTimeout;
 }
-export {};

package/types/node/index.d.ts

@@ -3,3 +3,13 @@ export * from './WsClient';
 export * from './HttpServer';
 export * from './events/AxisCameraStationEvents';
 export * from './events/GenetecAgent';
+export { ResourceManager } from './CamOverlayPainter/ResourceManager';
+export { Painter } from './CamOverlayPainter/Painter';
+export { Frame } from './CamOverlayPainter/Frame';
+export * from '../types/CamOverlayPainter';
+export { CamOverlayDrawingAPI } from './CamOverlayDrawingAPI';
+export * from '../types/CamOverlayDrawingAPI';
+export { CamScripterAPICameraEventsGenerator } from './CamScripterAPICameraEventsGenerator';
+export * from '../types/CamScripterAPICameraEventsGenerator';
+export { VapixEvents } from './VapixEvents';
+export * from '../types/VapixEvents';

package/types/types/CamOverlayAPI/CamOverlayAPI.d.ts

@@ -10,7 +10,7 @@ import { screenSharingSchema } from './screenSharingSchema';
 import { webCameraSharingSchema } from './webCameraSharingSchema';
 import { overlaySchema } from './serviceCommonTypes';
 import { baseballScoreBoardAutomaticSchema, baseballScoreBoardSchema, scoreBoardSchema, scoreOverviewSchema } from './scoreBoardSchema';
-export declare const WSResponseSchema: z.ZodObject<{
+export declare const wsResponseSchema: z.ZodObject<{
     status: z.ZodNumber;
     message: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -20,7 +20,7 @@ export declare const WSResponseSchema: z.ZodObject<{
     status: number;
     message: string;
 }>;
-export type TWSResponse = z.infer<typeof WSResponseSchema>;
+export type TWSResponse = z.infer<typeof wsResponseSchema>;
 export declare const servicesSchema: z.ZodDiscriminatedUnion<"name", [z.ZodObject<{
     id: z.ZodNumber;
     enabled: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>;

package/types/types/CamOverlayDrawingAPI.d.ts

@@ -26,7 +26,7 @@ export type TErrorResponse = {
     error: string;
     call_id?: number;
 };
-export type TService = {
+export type TCoService = {
     id: number;
     enabled: number;
     schedule: string;
@@ -34,8 +34,8 @@ export type TService = {
     identifier: string;
     cameraList: number[];
 };
-export type TServiceList = {
-    services: TService[];
+export type TCoServiceList = {
+    services: TCoService[];
 };
 export type TAlign = 'A_RIGHT' | 'A_LEFT' | 'A_CENTER';
 export type TextFit = 'TFM_SCALE' | 'TFM_TRUNCATE' | 'TFM_OVERFLOW';
@@ -46,13 +46,3 @@ export type AsyncMessage = {
     reject: (reason: Error) => void;
     sentTimestamp: number;
 };
-export interface CamOverlayDrawingAPI {
-    on(event: 'open', listener: () => void): this;
-    on(event: 'close', listener: () => void): this;
-    on(event: 'error', listener: (err: Error) => void): this;
-    on(event: 'message', listener: (msg: string) => void): this;
-    emit(event: 'open'): boolean;
-    emit(event: 'close'): boolean;
-    emit(event: 'error', err: Error): boolean;
-    emit(event: 'message', msg: string): boolean;
-}

package/types/types/CamOverlayPainter.d.ts

@@ -1,6 +1,16 @@
-import { CamOverlayDrawingAPI } from '../CamOverlayDrawingAPI';
-import { COORD } from '../CamOverlayPainter/Painter';
+import { CamOverlayDrawingAPI } from '../node/CamOverlayDrawingAPI';
 import { TAlign, TCairoCreateResponse, TUploadImageResponse } from './CamOverlayDrawingAPI';
+export declare const COORD: {
+    readonly top_left: readonly [-1, -1];
+    readonly center_left: readonly [-1, 0];
+    readonly bottom_left: readonly [-1, 1];
+    readonly top_center: readonly [0, -1];
+    readonly center: readonly [0, 0];
+    readonly bottom_center: readonly [0, 1];
+    readonly top_right: readonly [1, -1];
+    readonly center_right: readonly [1, 0];
+    readonly bottom_right: readonly [1, 1];
+};
 export type TRgb = [number, number, number];
 export type TRgba = [number, number, number, number];
 export type TTmf = 'TFM_OVERFLOW' | 'TFM_SCALE' | 'TFM_TRUNCATE';
@@ -53,14 +63,6 @@ export type TBorder = {
     borderWidth: number;
     borderColor: TRgba;
 };
-export interface Frame {
-    on(event: 'open', listener: () => void): this;
-    on(event: 'close', listener: () => void): this;
-    on(event: 'layoutChanged', listener: () => void): this;
-    emit(event: 'open'): boolean;
-    emit(event: 'close'): boolean;
-    emit(event: 'layoutChanged'): boolean;
-}
 export type TCoAlignment = keyof typeof COORD;
 export type TPainterOptions = TFrameOptions & {
     screenWidth: number;

package/types/types/CamScripterAPICameraEventsGenerator.d.ts

@@ -0,0 +1,45 @@
+export type TDeclaration = {
+    type?: '' | 'SOURCE' | 'DATA';
+    namespace: string;
+    key: string;
+    value: string | boolean | number;
+    value_type: 'STRING' | 'INT' | 'BOOL' | 'DOUBLE';
+    key_nice_name?: string;
+    value_nice_name?: string;
+};
+export type TEventDeclaration = {
+    declaration_id: string;
+    stateless: boolean;
+    declaration: TDeclaration[];
+};
+export type TEventUndeclaration = {
+    declaration_id: string;
+};
+export type TEventData = {
+    namespace: string;
+    key: string;
+    value: string | boolean | number;
+    value_type: 'STRING' | 'INT' | 'BOOL' | 'DOUBLE';
+};
+export type TCamScripterEvent = {
+    declaration_id: string;
+    event_data: TEventData[];
+};
+export type TCamScripterResponse = {
+    call_id: number;
+    message: string;
+};
+export type TCamScripterErrorResponse = {
+    error: string;
+    call_id?: number;
+};
+export type TCamScripterMessage = {
+    call_id: number;
+    command: string;
+    data: unknown;
+};
+export type TAsyncMessage = {
+    resolve: (value: TCamScripterResponse) => void;
+    reject: (reason?: any) => void;
+    sentTimestamp: number;
+};

package/types/types/CamStreamerAPI.d.ts

@@ -100,7 +100,7 @@ export declare const streamSchema: z.ZodObject<{
     internalVapixParameters: string;
     userVapixParameters: string;
     outputParameters: string;
-    outputType: "video" | "images" | "none";
+    outputType: "video" | "none" | "images";
     mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;
@@ -122,7 +122,7 @@ export declare const streamSchema: z.ZodObject<{
     internalVapixParameters: string;
     userVapixParameters: string;
     outputParameters: string;
-    outputType: "video" | "images" | "none";
+    outputType: "video" | "none" | "images";
     mediaServerUrl: string;
     inputType: "RTSP_URL" | "CSw" | "CRS";
     inputUrl: string;