camstreamerlib 4.0.0-beta.99 → 4.0.2

package/cjs/types/VapixAPI.d.ts

@@ -45,7 +45,7 @@ export declare const applicationListSchema: z.ZodArray<z.ZodObject<{
     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">]>>;
+    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;
@@ -53,7 +53,7 @@ export declare const applicationListSchema: z.ZodArray<z.ZodObject<{
     Version: string;
     License: string;
     Status: string;
-    appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | null;
+    appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | "CamOverlayHtmlplugin" | null;
     ApplicationID?: string | undefined;
     ConfigurationPage?: string | undefined;
     VendorHomePage?: string | undefined;
@@ -65,16 +65,18 @@ export declare const applicationListSchema: z.ZodArray<z.ZodObject<{
     Version: string;
     License: string;
     Status: string;
-    appId: "CamStreamer" | "CamSwitcher" | "CamOverlay" | "CamScripter" | "PlaneTracker" | "Ndihxplugin" | "SportTracker" | null;
+    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", "SportTracker"];
+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 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;
@@ -89,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;
@@ -106,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;
@@ -120,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;
@@ -205,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>;
@@ -1717,19 +1719,19 @@ export declare const portStatusSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     name: string;
     port: string;
+    direction: "output" | "input";
     state: "open" | "closed";
     configurable: boolean;
     usage: string;
-    direction: "input" | "output";
     normalState: "open" | "closed";
     readonly?: boolean | undefined;
 }, {
     name: string;
     port: string;
+    direction: "output" | "input";
     state: "open" | "closed";
     configurable: boolean;
     usage: string;
-    direction: "input" | "output";
     normalState: "open" | "closed";
     readonly?: boolean | undefined;
 }>;
@@ -1740,7 +1742,7 @@ export declare const getPortsResponseSchema: z.ZodObject<{
     method: z.ZodLiteral<"getPorts">;
     data: z.ZodObject<{
         numberOfPorts: z.ZodNumber;
-        items: z.ZodArray<z.ZodObject<{
+        items: z.ZodOptional<z.ZodArray<z.ZodObject<{
             port: z.ZodString;
             state: z.ZodEnum<["open", "closed"]>;
             configurable: z.ZodBoolean;
@@ -1752,60 +1754,60 @@ export declare const getPortsResponseSchema: z.ZodObject<{
         }, "strip", z.ZodTypeAny, {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
         }, {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
-        }>, "many">;
+        }>, "many">>;
     }, "strip", z.ZodTypeAny, {
         numberOfPorts: number;
-        items: {
+        items?: {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
-        }[];
+        }[] | undefined;
     }, {
         numberOfPorts: number;
-        items: {
+        items?: {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
-        }[];
+        }[] | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
     data: {
         numberOfPorts: number;
-        items: {
+        items?: {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
-        }[];
+        }[] | undefined;
     };
     apiVersion: string;
     context: string;
@@ -1813,16 +1815,16 @@ export declare const getPortsResponseSchema: z.ZodObject<{
 }, {
     data: {
         numberOfPorts: number;
-        items: {
+        items?: {
             name: string;
             port: string;
+            direction: "output" | "input";
             state: "open" | "closed";
             configurable: boolean;
             usage: string;
-            direction: "input" | "output";
             normalState: "open" | "closed";
             readonly?: boolean | undefined;
-        }[];
+        }[] | undefined;
     };
     apiVersion: string;
     context: string;
@@ -1839,15 +1841,15 @@ export declare const portSetSchema: z.ZodObject<{
     port: string;
     state: "open" | "closed";
     name?: string | undefined;
+    direction?: "output" | "input" | undefined;
     usage?: string | undefined;
-    direction?: "input" | "output" | undefined;
     normalState?: "open" | "closed" | undefined;
 }, {
     port: string;
     state: "open" | "closed";
     name?: string | undefined;
+    direction?: "output" | "input" | undefined;
     usage?: string | undefined;
-    direction?: "input" | "output" | undefined;
     normalState?: "open" | "closed" | undefined;
 }>;
 export type TPortSetSchema = z.infer<typeof portSetSchema>;
@@ -1855,11 +1857,28 @@ export declare const portSequenceStateSchema: z.ZodObject<{
     state: z.ZodEnum<["open", "closed"]>;
     time: z.ZodNumber;
 }, "strip", z.ZodTypeAny, {
-    time: number;
     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/cjs/types/VapixAPI.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.portSequenceStateSchema = exports.portSetSchema = exports.getPortsResponseSchema = exports.portStatusSchema = exports.audioSampleRatesResponseSchema = exports.timeZoneSchema = exports.dateTimeinfoSchema = exports.maxFpsResponseSchema = exports.audioDeviceRequestSchema = exports.audioDeviceSchema = exports.audioDeviceInputOutputSchema = exports.audioDeviceConnectionTypeSchema = exports.audioDeviceSignalingTypeSchema = exports.audioDeviceSignalingChannelTypeSchema = exports.cameraPTZItemSchema = exports.cameraPTZItemDataSchema = exports.ptzOverviewSchema = exports.sdCardInfoSchema = exports.sdCardWatchedStatuses = exports.guardTourSchema = exports.APP_IDS = exports.applicationListSchema = exports.applicationSchema = void 0;
+exports.recordingConfigItemSchema = exports.portSequenceStateSchema = exports.portSetSchema = exports.getPortsResponseSchema = exports.portStatusSchema = exports.audioSampleRatesResponseSchema = exports.timeZoneSchema = exports.dateTimeinfoSchema = exports.maxFpsResponseSchema = exports.audioDeviceRequestSchema = exports.audioDeviceSchema = exports.audioDeviceInputOutputSchema = exports.audioDeviceConnectionTypeSchema = exports.audioDeviceSignalingTypeSchema = exports.audioDeviceSignalingChannelTypeSchema = exports.cameraPTZItemSchema = exports.cameraPTZItemDataSchema = exports.ptzOverviewSchema = exports.sdCardInfoSchema = exports.sdCardWatchedStatuses = exports.guardTourSchema = exports.ALL_APP_IDS = exports.APP_IDS = exports.applicationListSchema = exports.applicationSchema = void 0;
 const zod_1 = require("zod");
 const transformers_1 = require("../internal/transformers");
 exports.applicationSchema = zod_1.z.object({
@@ -25,6 +25,7 @@ exports.applicationListSchema = zod_1.z.array(exports.applicationSchema.extend({
         zod_1.z.literal('PlaneTracker'),
         zod_1.z.literal('Ndihxplugin'),
         zod_1.z.literal('SportTracker'),
+        zod_1.z.literal('CamOverlayHtmlplugin'),
     ])
         .nullable(),
 }));
@@ -35,8 +36,8 @@ exports.APP_IDS = [
     'CamScripter',
     'PlaneTracker',
     'Ndihxplugin',
-    'SportTracker',
 ];
+exports.ALL_APP_IDS = [...exports.APP_IDS, 'SportTracker', 'CamOverlayHtmlplugin'];
 exports.guardTourSchema = zod_1.z.object({
     id: zod_1.z.string(),
     camNbr: zod_1.z.unknown(),
@@ -171,7 +172,7 @@ exports.getPortsResponseSchema = zod_1.z.object({
     method: zod_1.z.literal('getPorts'),
     data: zod_1.z.object({
         numberOfPorts: zod_1.z.number(),
-        items: zod_1.z.array(exports.portStatusSchema),
+        items: zod_1.z.array(exports.portStatusSchema).optional(),
     }),
 });
 exports.portSetSchema = zod_1.z.object({
@@ -186,3 +187,9 @@ exports.portSequenceStateSchema = zod_1.z.object({
     state: zod_1.z.enum(['open', 'closed']),
     time: zod_1.z.number().min(0).max(65535),
 });
+exports.recordingConfigItemSchema = zod_1.z.object({
+    diskid: zod_1.z.string(),
+    eventid: zod_1.z.string(),
+    options: zod_1.z.record(zod_1.z.string()),
+    profile: zod_1.z.string(),
+});

package/cjs/types/common.d.ts

@@ -48,3 +48,30 @@ export type TCameraImageConfig = {
     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/cjs/types/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.keyboardShortcutsSchema = exports.keyboardShortcutSchema = exports.networkCameraListSchema = exports.storageTypeSchema = exports.sdCardStorageTypeSchema = exports.flashStorageTypeSchema = exports.h264ProfileSchema = exports.audioChannelCountSchema = exports.audioChannelSchema = exports.booleanSchema = void 0;
+exports.fileSchema = exports.bitrateVapixParamsSchema = exports.bitrateModeSchema = exports.keyboardShortcutsSchema = exports.keyboardShortcutSchema = exports.networkCameraListSchema = exports.storageTypeSchema = exports.sdCardStorageTypeSchema = exports.flashStorageTypeSchema = exports.h264ProfileSchema = exports.audioChannelCountSchema = exports.audioChannelSchema = exports.booleanSchema = void 0;
 const zod_1 = require("zod");
 exports.booleanSchema = zod_1.z.union([zod_1.z.literal(0), zod_1.z.literal(1)]);
 exports.audioChannelSchema = zod_1.z.union([zod_1.z.literal('mono'), zod_1.z.literal('stereo')]);
@@ -15,3 +15,15 @@ exports.networkCameraListSchema = zod_1.z.array(zod_1.z.object({
 }));
 exports.keyboardShortcutSchema = zod_1.z.string().nullable();
 exports.keyboardShortcutsSchema = zod_1.z.record(exports.keyboardShortcutSchema);
+exports.bitrateModeSchema = zod_1.z.union([zod_1.z.literal('VBR'), zod_1.z.literal('MBR'), zod_1.z.literal('ABR')]);
+exports.bitrateVapixParamsSchema = zod_1.z.object({
+    bitrateMode: exports.bitrateModeSchema,
+    maximumBitRate: zod_1.z.number(),
+    retentionTime: zod_1.z.number(),
+    bitRateLimit: zod_1.z.number(),
+});
+exports.fileSchema = typeof File !== 'undefined'
+    ? zod_1.z.instanceof(File)
+    : zod_1.z.custom((val) => {
+        return val !== null && typeof val === 'object' && 'name' in val && 'size' in val && 'type' in val;
+    });