camstreamerlib 4.0.0-beta.16 → 4.0.0-beta.161

package/cjs/VapixAPI.d.ts

@@ -1,47 +1,57 @@
 import { IClient, TParameters, TResponse } from './internal/types';
-import { TAudioSampleRates, TSDCardInfo, TPtzOverview, TCameraPTZItem, TCameraPTZItemData, TAudioDevice } from './types/VapixAPI';
-import { ProxyClient } from './internal/ProxyClient';
-import { TCameraImageConfig, TProxyParam } from './types/common';
-export declare class VapixAPI<Client extends IClient<TResponse> = IClient<TResponse>> {
-    client: ProxyClient<Client>;
-    constructor(client: Client, getProxyUrl: () => string);
-    getUrlEncoded(proxy: TProxyParam, path: string, parameters?: TParameters, headers?: Record<string, string>): Promise<TResponse>;
-    postJson(proxy: TProxyParam, path: string, jsonData: Record<string, any>, headers?: Record<string, string>): Promise<TResponse>;
-    getCameraImage(params: TCameraImageConfig, proxy?: TProxyParam): Promise<TResponse>;
-    getEventDeclarations(proxy?: TProxyParam): Promise<string>;
-    getSupportedAudioSampleRate(proxy?: TProxyParam): Promise<TAudioSampleRates[]>;
-    performAutofocus(proxy?: TProxyParam): Promise<void>;
-    checkSDCard(proxy?: TProxyParam): Promise<TSDCardInfo>;
-    mountSDCard(proxy?: TProxyParam): Promise<number>;
-    unmountSDCard(proxy?: TProxyParam): Promise<number>;
+import { TAudioDevice, TPortSetSchema, TPortSequenceStateSchema } from './types/VapixAPI';
+import { TCameraImageConfig, THttpRequestOptions } from './types/common';
+import { BasicAPI } from './internal/BasicAPI';
+export declare class VapixAPI<Client extends IClient<TResponse, any>> extends BasicAPI<Client> {
+    private CustomFormData;
+    constructor(client: Client, CustomFormData?: {
+        new (form?: HTMLFormElement | undefined, submitter?: HTMLElement | null | undefined): FormData;
+        prototype: FormData;
+    });
+    postUrlEncoded(path: string, parameters?: TParameters, headers?: Record<string, string>, options?: THttpRequestOptions): Promise<TResponse>;
+    postJson(path: string, data: 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<{
+        sampleRate: number;
+        bitRates: number[];
+    }[]>;
+    performAutofocus(options?: THttpRequestOptions): Promise<void>;
+    checkSDCard(options?: THttpRequestOptions): Promise<{
+        status: "OK" | "connected" | "disconnected";
+        totalSize: number;
+        freeSize: number;
+    }>;
+    mountSDCard(options?: THttpRequestOptions): Promise<number>;
+    unmountSDCard(options?: THttpRequestOptions): Promise<number>;
     private _doSDCardMountAction;
-    fetchSDCardJobProgress(jobId: number, proxy?: TProxyParam): Promise<number>;
-    downloadCameraReport(proxy?: TProxyParam): Promise<TResponse>;
-    getSystemLog(proxy?: TProxyParam): Promise<TResponse>;
-    getMaxFps(channel: number, proxy?: TProxyParam): Promise<number>;
-    getTimezone(proxy?: TProxyParam): Promise<string>;
-    getDateTimeInfo(proxy?: TProxyParam): Promise<{
+    fetchSDCardJobProgress(jobId: number, options?: THttpRequestOptions): Promise<number>;
+    downloadCameraReport(options?: THttpRequestOptions): Promise<string>;
+    getSystemLog(options?: THttpRequestOptions): Promise<string>;
+    getMaxFps(channel: number, options?: THttpRequestOptions): Promise<number>;
+    getTimezone(options?: THttpRequestOptions): Promise<string>;
+    getDateTimeInfo(options?: THttpRequestOptions): Promise<{
         data: {
             dateTime: string;
             dstEnabled: boolean;
             localDateTime: string;
             posixTimeZone: string;
-            timeZone: string;
+            timeZone?: string | undefined;
         };
     }>;
-    getDevicesSettings(proxy?: TProxyParam): Promise<TAudioDevice[]>;
-    fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, proxy?: TProxyParam): Promise<any>;
-    getHeaders(proxy?: TProxyParam): Promise<Record<string, string>>;
-    setHeaders(headers: Record<string, string>, proxy?: TProxyParam): Promise<TResponse>;
-    getParameter(paramNames: string | string[], proxy?: TProxyParam): Promise<Record<string, string>>;
-    setParameter(params: Record<string, string | number | boolean>, proxy?: TProxyParam): Promise<boolean>;
-    getGuardTourList(proxy?: TProxyParam): Promise<{
+    getDevicesSettings(options?: THttpRequestOptions): Promise<TAudioDevice[]>;
+    fetchRemoteDeviceInfo<T extends Record<string, any>>(payload: T, options?: THttpRequestOptions): Promise<any>;
+    getHeaders(options?: THttpRequestOptions): Promise<Record<string, string>>;
+    setHeaders(headers: Record<string, string>, options?: THttpRequestOptions): Promise<void>;
+    getParameter(paramNames: string | string[], options?: THttpRequestOptions): Promise<Record<string, string>>;
+    setParameter(params: Record<string, string | number | boolean>, options?: THttpRequestOptions): Promise<void>;
+    getGuardTourList(options?: THttpRequestOptions): Promise<{
         name: string;
         id: string;
         running: string;
         tour: {
-            moveSpeed?: unknown;
             position?: unknown;
+            moveSpeed?: unknown;
             presetNbr?: unknown;
             waitTime?: unknown;
             waitTimeViewType?: unknown;
@@ -49,30 +59,73 @@ export declare class VapixAPI<Client extends IClient<TResponse> = IClient<TRespo
         camNbr?: unknown;
         randomEnabled?: unknown;
         timeBetweenSequences?: unknown;
+    }>;
+    setGuardTourEnabled(guardTourId: string, enable: boolean, options?: THttpRequestOptions): Promise<void>;
+    getPTZPresetList(channel: number, options?: THttpRequestOptions): Promise<string[]>;
+    listPTZ(camera: number, options?: THttpRequestOptions): Promise<{
+        name: string;
+        data: {
+            pan?: number | undefined;
+            tilt?: number | undefined;
+            zoom?: number | undefined;
+        };
+        id: number;
+    }[]>;
+    listPtzVideoSourceOverview(options?: THttpRequestOptions): Promise<Record<number, {
+        name: string;
+        id: number;
+    }[]>>;
+    goToPreset(channel: number, presetName: string, options?: THttpRequestOptions): Promise<void>;
+    getPtzPosition(camera: number, options?: THttpRequestOptions): Promise<{
+        pan?: number | undefined;
+        tilt?: number | undefined;
+        zoom?: number | undefined;
+    }>;
+    getPorts(options?: THttpRequestOptions): Promise<{
+        name: string;
+        port: string;
+        direction: "output" | "input";
+        state: "open" | "closed";
+        configurable: boolean;
+        usage: string;
+        normalState: "open" | "closed";
+        readonly?: boolean | undefined;
+    }[]>;
+    setPorts(ports: TPortSetSchema[], options?: THttpRequestOptions): Promise<void>;
+    setPortStateSequence(port: number, sequence: TPortSequenceStateSchema[], options?: THttpRequestOptions): Promise<void>;
+    addCameraUser(username: string, pass: string, sgrp: string, comment?: string, options?: THttpRequestOptions): Promise<void>;
+    getCameraUsers(options?: THttpRequestOptions): Promise<string[]>;
+    editCameraUser(username: string, pass: string, options?: THttpRequestOptions): Promise<void>;
+    getRecordingRuleList(options?: THttpRequestOptions): Promise<{
+        options: Record<string, string>;
+        diskid: string;
+        eventid: string;
+        profile: string;
     }[]>;
-    setGuardTourEnabled(guardTourID: string, enable: boolean, proxy?: TProxyParam): Promise<boolean>;
-    getPTZPresetList(channel: number, proxy?: TProxyParam): Promise<string[]>;
-    listPTZ(camera: number, proxy?: TProxyParam): Promise<TCameraPTZItem[]>;
-    listPtzVideoSourceOverview(proxy?: TProxyParam): Promise<TPtzOverview>;
-    goToPreset(channel: number, presetName: string, proxy?: TProxyParam): Promise<TResponse>;
-    getPtzPosition(camera: number, proxy?: TProxyParam): Promise<TCameraPTZItemData>;
-    getInputState(port: number, proxy?: TProxyParam): Promise<boolean>;
-    setOutputState(port: number, active: boolean, proxy?: TProxyParam): Promise<TResponse>;
-    getApplicationList(proxy?: TProxyParam): Promise<{
-        appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | null;
+    addRecordingRule(params: Record<string, string>, options?: THttpRequestOptions): Promise<string | null>;
+    removeRecordingRule(profileId: string, options?: THttpRequestOptions): Promise<void>;
+    getDiskInfo(diskId?: string, options?: THttpRequestOptions): Promise<boolean>;
+    getApplicationList(options?: THttpRequestOptions): Promise<{
         Name: string;
         NiceName: string;
         Vendor: string;
         Version: string;
         License: string;
         Status: string;
+        appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | "CamOverlayHtmlplugin" | null;
         ApplicationID?: string | undefined;
         ConfigurationPage?: string | undefined;
         VendorHomePage?: string | undefined;
         LicenseName?: string | undefined;
     }[]>;
-    startApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    restartApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    stopApplication(applicationID: string, proxy?: TProxyParam): Promise<void>;
-    installApplication(data: Blob, fileName: string): Promise<void>;
+    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 parseQueryString;
+    private static checkTextResponseForError;
+    private static parseParameters;
+    private static parseCameraPtzResponse;
+    private static parsePtz;
+    private static parseXmlResponse;
 }