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

package/{esm → types}/types/VapixAPI.d.ts

@@ -1,6 +1,4 @@
-import { HttpOptions } from '../internal/types';
 import { z } from 'zod';
-export type CameraVapixOptions = HttpOptions;
 export declare const applicationSchema: z.ZodObject<{
     Name: z.ZodString;
     NiceName: z.ZodString;
@@ -35,11 +33,50 @@ export declare const applicationSchema: z.ZodObject<{
     VendorHomePage?: string | undefined;
     LicenseName?: string | undefined;
 }>;
-export declare const APP_IDS: readonly ["CamStreamer", "CamSwitcher", "CamOverlay", "CamScripter", "PlaneTracker", "Ndihxplugin", "SportTracker"];
+export declare const applicationListSchema: z.ZodArray<z.ZodObject<{
+    Name: z.ZodString;
+    NiceName: z.ZodString;
+    Vendor: z.ZodString;
+    Version: z.ZodString;
+    ApplicationID: z.ZodOptional<z.ZodString>;
+    License: z.ZodString;
+    Status: z.ZodString;
+    ConfigurationPage: z.ZodOptional<z.ZodString>;
+    VendorHomePage: z.ZodOptional<z.ZodString>;
+    LicenseName: z.ZodOptional<z.ZodString>;
+} & {
+    appId: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"CamStreamer">, z.ZodLiteral<"CamSwitcher">, z.ZodLiteral<"CamOverlay">, z.ZodLiteral<"CamScripter">, z.ZodLiteral<"PlaneTracker">, z.ZodLiteral<"Ndihxplugin">, z.ZodLiteral<"SportTracker">, z.ZodLiteral<"CamOverlayHtmlplugin">]>>;
+}, "strip", z.ZodTypeAny, {
+    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;
+}, {
+    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;
+}>, "many">;
+export declare const APP_IDS: readonly ["CamStreamer", "CamSwitcher", "CamOverlay", "CamScripter", "PlaneTracker", "Ndihxplugin"];
+export declare const ALL_APP_IDS: readonly ["CamStreamer", "CamSwitcher", "CamOverlay", "CamScripter", "PlaneTracker", "Ndihxplugin", "SportTracker", "CamOverlayHtmlplugin"];
 export type TApplicationId = (typeof APP_IDS)[number];
-export type TApplication = z.infer<typeof applicationSchema> & {
-    appId: null | TApplicationId;
-};
+export type TApplicationList = z.infer<typeof applicationListSchema>;
+export type TApplication = z.infer<typeof applicationListSchema>[number];
+export type TAllApplicationId = (typeof ALL_APP_IDS)[number];
 export declare const guardTourSchema: z.ZodObject<{
     id: z.ZodString;
     camNbr: z.ZodUnknown;
@@ -54,14 +91,14 @@ export declare const guardTourSchema: z.ZodObject<{
         waitTime: z.ZodUnknown;
         waitTimeViewType: z.ZodUnknown;
     }, "strip", z.ZodTypeAny, {
-        moveSpeed?: unknown;
         position?: unknown;
+        moveSpeed?: unknown;
         presetNbr?: unknown;
         waitTime?: unknown;
         waitTimeViewType?: unknown;
     }, {
-        moveSpeed?: unknown;
         position?: unknown;
+        moveSpeed?: unknown;
         presetNbr?: unknown;
         waitTime?: unknown;
         waitTimeViewType?: unknown;
@@ -71,8 +108,8 @@ export declare const guardTourSchema: z.ZodObject<{
     id: string;
     running: string;
     tour: {
-        moveSpeed?: unknown;
         position?: unknown;
+        moveSpeed?: unknown;
         presetNbr?: unknown;
         waitTime?: unknown;
         waitTimeViewType?: unknown;
@@ -85,8 +122,8 @@ export declare const guardTourSchema: z.ZodObject<{
     id: string;
     running: string;
     tour: {
-        moveSpeed?: unknown;
         position?: unknown;
+        moveSpeed?: unknown;
         presetNbr?: unknown;
         waitTime?: unknown;
         waitTimeViewType?: unknown;
@@ -114,12 +151,21 @@ declare const audioSampleRatesOutSchema: z.ZodEffects<z.ZodObject<{
 }>;
 export type TAudioSampleRates = z.infer<typeof audioSampleRatesOutSchema>;
 export declare const sdCardWatchedStatuses: readonly ["OK", "connected", "disconnected"];
-export type TSDCardInfo = {
-    status: (typeof sdCardWatchedStatuses)[number];
+export declare const sdCardInfoSchema: z.ZodObject<{
+    status: z.ZodEnum<["OK", "connected", "disconnected"]>;
+    totalSize: z.ZodNumber;
+    freeSize: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    status: "OK" | "connected" | "disconnected";
+    totalSize: number;
+    freeSize: number;
+}, {
+    status: "OK" | "connected" | "disconnected";
     totalSize: number;
     freeSize: number;
-};
-export declare const PtzOverviewSchema: z.ZodRecord<z.ZodNumber, z.ZodArray<z.ZodObject<{
+}>;
+export type TSDCardInfo = z.infer<typeof sdCardInfoSchema>;
+export declare const ptzOverviewSchema: z.ZodRecord<z.ZodNumber, z.ZodArray<z.ZodObject<{
     id: z.ZodNumber;
     name: z.ZodString;
 }, "strip", z.ZodTypeAny, {
@@ -129,7 +175,7 @@ export declare const PtzOverviewSchema: z.ZodRecord<z.ZodNumber, z.ZodArray<z.Zo
     name: string;
     id: number;
 }>, "many">>;
-export type TPtzOverview = z.infer<typeof PtzOverviewSchema>;
+export type TPtzOverview = z.infer<typeof ptzOverviewSchema>;
 export declare const cameraPTZItemDataSchema: z.ZodObject<{
     pan: z.ZodOptional<z.ZodNumber>;
     tilt: z.ZodOptional<z.ZodNumber>;
@@ -161,20 +207,20 @@ export declare const cameraPTZItemSchema: z.ZodObject<{
     }>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    id: number;
     data: {
         pan?: number | undefined;
         tilt?: number | undefined;
         zoom?: number | undefined;
     };
+    id: number;
 }, {
     name: string;
-    id: number;
     data: {
         pan?: number | undefined;
         tilt?: number | undefined;
         zoom?: number | undefined;
     };
+    id: number;
 }>;
 export type TCameraPTZItem = z.infer<typeof cameraPTZItemSchema>;
 export type TCameraPTZItemData = z.infer<typeof cameraPTZItemDataSchema>;
@@ -1499,19 +1545,19 @@ export declare const dateTimeinfoSchema: z.ZodObject<{
         dstEnabled: z.ZodBoolean;
         localDateTime: z.ZodString;
         posixTimeZone: z.ZodString;
-        timeZone: z.ZodString;
+        timeZone: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         dateTime: string;
         dstEnabled: boolean;
         localDateTime: string;
         posixTimeZone: string;
-        timeZone: string;
+        timeZone?: string | undefined;
     }, {
         dateTime: string;
         dstEnabled: boolean;
         localDateTime: string;
         posixTimeZone: string;
-        timeZone: string;
+        timeZone?: string | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     data: {
@@ -1519,7 +1565,7 @@ export declare const dateTimeinfoSchema: z.ZodObject<{
         dstEnabled: boolean;
         localDateTime: string;
         posixTimeZone: string;
-        timeZone: string;
+        timeZone?: string | undefined;
     };
 }, {
     data: {
@@ -1527,9 +1573,48 @@ export declare const dateTimeinfoSchema: z.ZodObject<{
         dstEnabled: boolean;
         localDateTime: string;
         posixTimeZone: string;
-        timeZone: string;
+        timeZone?: string | undefined;
     };
 }>;
+export declare const timeZoneSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+    status: z.ZodLiteral<"success">;
+    data: z.ZodObject<{
+        activeTimeZone: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        activeTimeZone: string;
+    }, {
+        activeTimeZone: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    status: "success";
+    data: {
+        activeTimeZone: string;
+    };
+}, {
+    status: "success";
+    data: {
+        activeTimeZone: string;
+    };
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"error">;
+    error: z.ZodObject<{
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+    }, {
+        message: string;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    status: "error";
+    error: {
+        message: string;
+    };
+}, {
+    status: "error";
+    error: {
+        message: string;
+    };
+}>]>;
 export declare const audioSampleRatesResponseSchema: z.ZodObject<{
     data: z.ZodObject<{
         encoders: z.ZodObject<{
@@ -1622,4 +1707,178 @@ export declare const audioSampleRatesResponseSchema: z.ZodObject<{
         };
     };
 }>;
+export declare const portStatusSchema: z.ZodObject<{
+    port: z.ZodString;
+    state: z.ZodEnum<["open", "closed"]>;
+    configurable: z.ZodBoolean;
+    readonly: z.ZodOptional<z.ZodBoolean>;
+    usage: z.ZodString;
+    direction: z.ZodEnum<["input", "output"]>;
+    name: z.ZodString;
+    normalState: z.ZodEnum<["open", "closed"]>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    port: string;
+    direction: "output" | "input";
+    state: "open" | "closed";
+    configurable: boolean;
+    usage: string;
+    normalState: "open" | "closed";
+    readonly?: boolean | undefined;
+}, {
+    name: string;
+    port: string;
+    direction: "output" | "input";
+    state: "open" | "closed";
+    configurable: boolean;
+    usage: string;
+    normalState: "open" | "closed";
+    readonly?: boolean | undefined;
+}>;
+export type TPortStatusSchema = z.infer<typeof portStatusSchema>;
+export declare const getPortsResponseSchema: z.ZodObject<{
+    apiVersion: z.ZodString;
+    context: z.ZodString;
+    method: z.ZodLiteral<"getPorts">;
+    data: z.ZodObject<{
+        numberOfPorts: z.ZodNumber;
+        items: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            port: z.ZodString;
+            state: z.ZodEnum<["open", "closed"]>;
+            configurable: z.ZodBoolean;
+            readonly: z.ZodOptional<z.ZodBoolean>;
+            usage: z.ZodString;
+            direction: z.ZodEnum<["input", "output"]>;
+            name: z.ZodString;
+            normalState: z.ZodEnum<["open", "closed"]>;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }, {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        numberOfPorts: number;
+        items?: {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }[] | undefined;
+    }, {
+        numberOfPorts: number;
+        items?: {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    data: {
+        numberOfPorts: number;
+        items?: {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }[] | undefined;
+    };
+    apiVersion: string;
+    context: string;
+    method: "getPorts";
+}, {
+    data: {
+        numberOfPorts: number;
+        items?: {
+            name: string;
+            port: string;
+            direction: "output" | "input";
+            state: "open" | "closed";
+            configurable: boolean;
+            usage: string;
+            normalState: "open" | "closed";
+            readonly?: boolean | undefined;
+        }[] | undefined;
+    };
+    apiVersion: string;
+    context: string;
+    method: "getPorts";
+}>;
+export declare const portSetSchema: z.ZodObject<{
+    port: z.ZodString;
+    state: z.ZodEnum<["open", "closed"]>;
+    usage: z.ZodOptional<z.ZodString>;
+    direction: z.ZodOptional<z.ZodEnum<["input", "output"]>>;
+    name: z.ZodOptional<z.ZodString>;
+    normalState: z.ZodOptional<z.ZodEnum<["open", "closed"]>>;
+}, "strip", z.ZodTypeAny, {
+    port: string;
+    state: "open" | "closed";
+    name?: string | undefined;
+    direction?: "output" | "input" | undefined;
+    usage?: string | undefined;
+    normalState?: "open" | "closed" | undefined;
+}, {
+    port: string;
+    state: "open" | "closed";
+    name?: string | undefined;
+    direction?: "output" | "input" | undefined;
+    usage?: string | undefined;
+    normalState?: "open" | "closed" | undefined;
+}>;
+export type TPortSetSchema = z.infer<typeof portSetSchema>;
+export declare const portSequenceStateSchema: z.ZodObject<{
+    state: z.ZodEnum<["open", "closed"]>;
+    time: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    state: "open" | "closed";
+    time: number;
+}, {
+    state: "open" | "closed";
+    time: number;
+}>;
+export type TPortSequenceStateSchema = z.infer<typeof portSequenceStateSchema>;
+export declare const recordingConfigItemSchema: z.ZodObject<{
+    diskid: z.ZodString;
+    eventid: z.ZodString;
+    options: z.ZodRecord<z.ZodString, z.ZodString>;
+    profile: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    options: Record<string, string>;
+    diskid: string;
+    eventid: string;
+    profile: string;
+}, {
+    options: Record<string, string>;
+    diskid: string;
+    eventid: string;
+    profile: string;
+}>;
+export type TRecordingConfigItem = z.infer<typeof recordingConfigItemSchema>;
 export {};

package/types/types/VapixEvents.d.ts

@@ -0,0 +1,15 @@
+export type TVapixEventMessage = {
+    apiVersion: string;
+    method: string;
+    params: {
+        notification: {
+            timestamp: number;
+            topic: string;
+            message: {
+                source: Record<string, string>;
+                data: Record<string, string>;
+                key: Record<string, string>;
+            };
+        };
+    };
+};

package/types/types/common.d.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod';
+export declare const booleanSchema: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+export declare const audioChannelSchema: z.ZodUnion<[z.ZodLiteral<"mono">, z.ZodLiteral<"stereo">]>;
+export type TAudioChannel = z.infer<typeof audioChannelSchema>;
+export declare const audioChannelCountSchema: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>]>;
+export type TAudioChannelCount = z.infer<typeof audioChannelCountSchema>;
+export declare const h264ProfileSchema: z.ZodUnion<[z.ZodLiteral<"high">, z.ZodLiteral<"main">, z.ZodLiteral<"baseline">]>;
+export type TH264Profile = z.infer<typeof h264ProfileSchema>;
+export declare const flashStorageTypeSchema: z.ZodLiteral<"FLASH">;
+export declare const sdCardStorageTypeSchema: z.ZodLiteral<"SD_DISK">;
+export declare const storageTypeSchema: z.ZodUnion<[z.ZodLiteral<"SD_DISK">, z.ZodLiteral<"FLASH">]>;
+export type TStorageType = z.infer<typeof storageTypeSchema>;
+export declare const networkCameraListSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    ip: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    ip: string;
+}, {
+    name: string;
+    ip: string;
+}>, "many">;
+export type TNetworkCameraList = z.infer<typeof networkCameraListSchema>;
+export type TNetworkCamera = z.infer<typeof networkCameraListSchema>[number];
+export declare const keyboardShortcutSchema: z.ZodNullable<z.ZodString>;
+export declare const keyboardShortcutsSchema: z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>;
+export type TKeyboardShortcut = z.infer<typeof keyboardShortcutSchema>;
+export type TKeyboardShortcuts = z.infer<typeof keyboardShortcutsSchema>;
+export type TProxyTarget = {
+    ip: string;
+    mdnsName: string;
+    port: number;
+    user: string;
+    pass: string;
+};
+export type TProxyParams = {
+    path: string;
+    target: TProxyTarget;
+};
+export type THttpRequestOptions = {
+    timeout?: number;
+    proxyParams?: TProxyParams;
+};
+export type TCameraImageConfig = {
+    camera?: string;
+    resolution?: string;
+    compression?: number;
+    overlays?: string;
+    [key: string]: string | number | undefined;
+};
+export declare const bitrateModeSchema: z.ZodUnion<[z.ZodLiteral<"VBR">, z.ZodLiteral<"MBR">, z.ZodLiteral<"ABR">]>;
+export type TBitrateMode = z.infer<typeof bitrateModeSchema>;
+export declare const bitrateVapixParamsSchema: z.ZodObject<{
+    bitrateMode: z.ZodUnion<[z.ZodLiteral<"VBR">, z.ZodLiteral<"MBR">, z.ZodLiteral<"ABR">]>;
+    maximumBitRate: z.ZodNumber;
+    retentionTime: z.ZodNumber;
+    bitRateLimit: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    bitrateMode: "VBR" | "MBR" | "ABR";
+    maximumBitRate: number;
+    retentionTime: number;
+    bitRateLimit: number;
+}, {
+    bitrateMode: "VBR" | "MBR" | "ABR";
+    maximumBitRate: number;
+    retentionTime: number;
+    bitRateLimit: number;
+}>;
+export type TBitrateVapixParams = z.infer<typeof bitrateVapixParamsSchema>;
+export type FileLike = typeof File extends {
+    prototype: infer T;
+} ? T : {
+    name: string;
+    size: number;
+    type: string;
+};
+export declare const fileSchema: z.ZodType<File, z.ZodTypeDef, File>;

package/types/types/ws/CamOverlayEvents.d.ts

@@ -0,0 +1,88 @@
+import { z } from 'zod';
+export declare const coEventsSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"init">;
+    data: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"authorization">;
+        state: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "authorization";
+        state: string;
+    }, {
+        type: "authorization";
+        state: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"ServiceStart">;
+        serviceId: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: "ServiceStart";
+        serviceId: number;
+    }, {
+        type: "ServiceStart";
+        serviceId: number;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"ServiceStop">;
+        serviceId: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        type: "ServiceStop";
+        serviceId: number;
+    }, {
+        type: "ServiceStop";
+        serviceId: number;
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    type: "init";
+    data: {
+        type: "authorization";
+        state: string;
+    } | {
+        type: "ServiceStart";
+        serviceId: number;
+    } | {
+        type: "ServiceStop";
+        serviceId: number;
+    };
+}, {
+    type: "init";
+    data: {
+        type: "authorization";
+        state: string;
+    } | {
+        type: "ServiceStart";
+        serviceId: number;
+    } | {
+        type: "ServiceStop";
+        serviceId: number;
+    };
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"authorization">;
+    state: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "authorization";
+    state: string;
+}, {
+    type: "authorization";
+    state: string;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"ServiceStart">;
+    serviceId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "ServiceStart";
+    serviceId: number;
+}, {
+    type: "ServiceStart";
+    serviceId: number;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"ServiceStop">;
+    serviceId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    type: "ServiceStop";
+    serviceId: number;
+}, {
+    type: "ServiceStop";
+    serviceId: number;
+}>]>;
+export type TCamOverlayEvent = z.infer<typeof coEventsSchema>;
+export type TCamOverlayEventType = TCamOverlayEvent['type'];
+export type TCamOverlayEventOfType<T extends TCamOverlayEventType> = Extract<TCamOverlayEvent, {
+    type: T;
+}>;