camstreamerlib 4.0.0-beta.97 → 4.0.1

package/cjs/types/CamStreamerAPI/streamCommonTypes.d.ts

@@ -1,199 +1,37 @@
 import { z } from 'zod';
-export declare const streamTypeSchema: z.ZodUnion<[z.ZodLiteral<"youtube">, z.ZodLiteral<"facebook">, z.ZodLiteral<"sd_card">, z.ZodLiteral<"windy">, z.ZodLiteral<"mpeg_dvb">, z.ZodLiteral<"rtmp">, z.ZodLiteral<"dailymotion">, z.ZodLiteral<"ibm">, z.ZodLiteral<"hls_pull">, z.ZodLiteral<"hls_push">, z.ZodLiteral<"wowza">, z.ZodLiteral<"microsoft_stream">, z.ZodLiteral<"microsoft_azure">, z.ZodLiteral<"vimeo">, z.ZodLiteral<"twitch">, z.ZodLiteral<"church">, z.ZodLiteral<"srt">, z.ZodLiteral<"da_cast">, z.ZodLiteral<"game_changer">]>;
-export type TStreamType = z.infer<typeof streamTypeSchema>;
-declare const scheduleSchema: z.ZodObject<{
-    start: z.ZodObject<{
-        day: z.ZodNumber;
-        timeS: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        day: number;
-        timeS: number;
-    }, {
-        day: number;
-        timeS: number;
-    }>;
-    stop: z.ZodObject<{
-        day: z.ZodNumber;
-        timeS: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        day: number;
-        timeS: number;
-    }, {
-        day: number;
-        timeS: number;
-    }>;
-    isActive: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    start: {
-        day: number;
-        timeS: number;
-    };
-    stop: {
-        day: number;
-        timeS: number;
-    };
-    isActive: boolean;
-}, {
-    start: {
-        day: number;
-        timeS: number;
-    };
-    stop: {
-        day: number;
-        timeS: number;
-    };
-    isActive: boolean;
-}>;
-export declare const streamTriggerSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-    type: z.ZodLiteral<"manual">;
-    ioPort: z.ZodNullable<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    type: "manual";
-    ioPort: string | null;
-}, {
-    type: "manual";
-    ioPort: string | null;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"onetime">;
-    startTime: z.ZodNumber;
-    stopTime: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    type: "onetime";
-    startTime: number;
-    stopTime: number;
-}, {
-    type: "onetime";
-    startTime: number;
-    stopTime: number;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"recurrent">;
-    schedule: z.ZodArray<z.ZodObject<{
-        start: z.ZodObject<{
-            day: z.ZodNumber;
-            timeS: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            day: number;
-            timeS: number;
-        }, {
-            day: number;
-            timeS: number;
-        }>;
-        stop: z.ZodObject<{
-            day: z.ZodNumber;
-            timeS: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            day: number;
-            timeS: number;
-        }, {
-            day: number;
-            timeS: number;
-        }>;
-        isActive: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        start: {
-            day: number;
-            timeS: number;
-        };
-        stop: {
-            day: number;
-            timeS: number;
-        };
-        isActive: boolean;
-    }, {
-        start: {
-            day: number;
-            timeS: number;
-        };
-        stop: {
-            day: number;
-            timeS: number;
-        };
-        isActive: boolean;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    type: "recurrent";
-    schedule: {
-        start: {
-            day: number;
-            timeS: number;
-        };
-        stop: {
-            day: number;
-            timeS: number;
-        };
-        isActive: boolean;
-    }[];
-}, {
-    type: "recurrent";
-    schedule: {
-        start: {
-            day: number;
-            timeS: number;
-        };
-        stop: {
-            day: number;
-            timeS: number;
-        };
-        isActive: boolean;
-    }[];
-}>]>;
-export type TStreamTrigger = z.infer<typeof streamTriggerSchema>;
-export type TStreamTriggerType = TStreamTrigger['type'];
-export type TTriggerSchedule = z.infer<typeof scheduleSchema>;
-export declare const streamInputTypeSchema: z.ZodUnion<[z.ZodLiteral<"CSw">, z.ZodLiteral<"CRS">, z.ZodLiteral<"RTSP_URL">]>;
-export type TStreamInputType = z.infer<typeof streamInputTypeSchema>;
-export declare const internalVapixParametersSchema: z.ZodObject<{
-    camera: z.ZodString;
-    resolution: z.ZodOptional<z.ZodString>;
-    compression: z.ZodOptional<z.ZodNumber>;
-    fps: z.ZodOptional<z.ZodNumber>;
-    videobitrate: z.ZodOptional<z.ZodNumber>;
-    videomaxbitrate: z.ZodOptional<z.ZodNumber>;
-    audio: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
-}, "strip", z.ZodTypeAny, {
-    camera: string;
-    resolution?: string | undefined;
-    compression?: number | undefined;
-    audio?: 0 | 1 | undefined;
-    fps?: number | undefined;
-    videobitrate?: number | undefined;
-    videomaxbitrate?: number | undefined;
-}, {
-    camera: string;
-    resolution?: string | undefined;
-    compression?: number | undefined;
-    audio?: 0 | 1 | undefined;
-    fps?: number | undefined;
-    videobitrate?: number | undefined;
-    videomaxbitrate?: number | undefined;
-}>;
-export type TInternalVapixParameters = z.infer<typeof internalVapixParametersSchema>;
 export declare const streamCommonSchema: z.ZodObject<{
-    id: z.ZodNumber;
+    streamId: z.ZodString;
     enabled: z.ZodBoolean;
     active: z.ZodBoolean;
     title: z.ZodString;
+    callApi: z.ZodBoolean;
     trigger: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
         type: z.ZodLiteral<"manual">;
-        ioPort: z.ZodNullable<z.ZodString>;
+        port: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         type: "manual";
-        ioPort: string | null;
+        port?: number | undefined;
     }, {
         type: "manual";
-        ioPort: string | null;
+        port?: number | undefined;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"onetime">;
         startTime: z.ZodNumber;
         stopTime: z.ZodNumber;
+        everActivated: z.ZodBoolean;
+        prepareAheadS: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         type: "onetime";
         startTime: number;
         stopTime: number;
+        everActivated: boolean;
+        prepareAheadS?: number | undefined;
     }, {
         type: "onetime";
         startTime: number;
         stopTime: number;
+        everActivated: boolean;
+        prepareAheadS?: number | undefined;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"recurrent">;
         schedule: z.ZodArray<z.ZodObject<{
@@ -239,6 +77,7 @@ export declare const streamCommonSchema: z.ZodObject<{
             };
             isActive: boolean;
         }>, "many">;
+        prepareAheadS: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         type: "recurrent";
         schedule: {
@@ -252,6 +91,7 @@ export declare const streamCommonSchema: z.ZodObject<{
             };
             isActive: boolean;
         }[];
+        prepareAheadS?: number | undefined;
     }, {
         type: "recurrent";
         schedule: {
@@ -265,45 +105,259 @@ export declare const streamCommonSchema: z.ZodObject<{
             };
             isActive: boolean;
         }[];
+        prepareAheadS?: number | undefined;
+    }>]>;
+    video: z.ZodObject<{
+        output: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"video">;
+            url: z.ZodNullable<z.ZodString>;
+            parameters: z.ZodString;
+            saveToSdCard: z.ZodOptional<z.ZodObject<{
+                ruleId: z.ZodString;
+                configurationId: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                ruleId: string;
+                configurationId: string;
+            }, {
+                ruleId: string;
+                configurationId: string;
+            }>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        }, {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"images">;
+            url: z.ZodNullable<z.ZodString>;
+            imageIntervalS: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        }, {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"none">;
+            saveToSdCard: z.ZodObject<{
+                ruleId: z.ZodString;
+                configurationId: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                ruleId: string;
+                configurationId: string;
+            }, {
+                ruleId: string;
+                configurationId: string;
+            }>;
+        }, "strip", z.ZodTypeAny, {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        }, {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        }>]>;
+        input: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"RTSP_URL">;
+            url: z.ZodString;
+            internalVapixParameters: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        }, {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"CSw">;
+            internalVapixParameters: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "CSw";
+            internalVapixParameters: string;
+        }, {
+            type: "CSw";
+            internalVapixParameters: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"CRS">;
+            internalVapixParameters: z.ZodString;
+            userVapixParameters: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        }, {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        }>]>;
+        delayS: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        output: {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        } | {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        } | {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        };
+        input: {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        } | {
+            type: "CSw";
+            internalVapixParameters: string;
+        } | {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        };
+        delayS?: number | undefined;
+    }, {
+        output: {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        } | {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        } | {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        };
+        input: {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        } | {
+            type: "CSw";
+            internalVapixParameters: string;
+        } | {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        };
+        delayS?: number | undefined;
+    }>;
+    audio: z.ZodDiscriminatedUnion<"source", [z.ZodObject<{
+        source: z.ZodLiteral<"none">;
+    }, "strip", z.ZodTypeAny, {
+        source: "none";
+    }, {
+        source: "none";
+    }>, z.ZodObject<{
+        source: z.ZodLiteral<"microphone">;
+        audioChannelNbr: z.ZodNumber;
+        forceStereo: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        source: "microphone";
+        audioChannelNbr: number;
+        forceStereo: boolean;
+    }, {
+        source: "microphone";
+        audioChannelNbr: number;
+        forceStereo: boolean;
+    }>, z.ZodObject<{
+        source: z.ZodLiteral<"file">;
+        name: z.ZodString;
+        path: z.ZodString;
+        forceStereo: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        name: string;
+        source: "file";
+        forceStereo: boolean;
+    }, {
+        path: string;
+        name: string;
+        source: "file";
+        forceStereo: boolean;
+    }>, z.ZodObject<{
+        source: z.ZodLiteral<"url">;
+        name: z.ZodString;
+        url: z.ZodString;
+        avSyncMsec: z.ZodNumber;
+        forceStereo: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        url: string;
+        source: "url";
+        forceStereo: boolean;
+        avSyncMsec: number;
+    }, {
+        name: string;
+        url: string;
+        source: "url";
+        forceStereo: boolean;
+        avSyncMsec: number;
     }>]>;
-    inputType: z.ZodUnion<[z.ZodLiteral<"CSw">, z.ZodLiteral<"CRS">, z.ZodLiteral<"RTSP_URL">]>;
-    internalVapixParameters: z.ZodObject<{
-        camera: z.ZodString;
-        resolution: z.ZodOptional<z.ZodString>;
-        compression: z.ZodOptional<z.ZodNumber>;
-        fps: z.ZodOptional<z.ZodNumber>;
-        videobitrate: z.ZodOptional<z.ZodNumber>;
-        videomaxbitrate: z.ZodOptional<z.ZodNumber>;
-        audio: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    status: z.ZodObject<{
+        led: z.ZodBoolean;
+        port: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
-        camera: string;
-        resolution?: string | undefined;
-        compression?: number | undefined;
-        audio?: 0 | 1 | undefined;
-        fps?: number | undefined;
-        videobitrate?: number | undefined;
-        videomaxbitrate?: number | undefined;
+        led: boolean;
+        port?: number | undefined;
     }, {
-        camera: string;
-        resolution?: string | undefined;
-        compression?: number | undefined;
-        audio?: 0 | 1 | undefined;
-        fps?: number | undefined;
-        videobitrate?: number | undefined;
-        videomaxbitrate?: number | undefined;
+        led: boolean;
+        port?: number | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
+    status: {
+        led: boolean;
+        port?: number | undefined;
+    };
+    streamId: string;
     enabled: boolean;
-    id: number;
     active: boolean;
     title: string;
+    callApi: boolean;
     trigger: {
         type: "manual";
-        ioPort: string | null;
+        port?: number | undefined;
     } | {
         type: "onetime";
         startTime: number;
         stopTime: number;
+        everActivated: boolean;
+        prepareAheadS?: number | undefined;
     } | {
         type: "recurrent";
         schedule: {
@@ -317,29 +371,79 @@ export declare const streamCommonSchema: z.ZodObject<{
             };
             isActive: boolean;
         }[];
+        prepareAheadS?: number | undefined;
     };
-    inputType: "RTSP_URL" | "CSw" | "CRS";
-    internalVapixParameters: {
-        camera: string;
-        resolution?: string | undefined;
-        compression?: number | undefined;
-        audio?: 0 | 1 | undefined;
-        fps?: number | undefined;
-        videobitrate?: number | undefined;
-        videomaxbitrate?: number | undefined;
+    video: {
+        output: {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        } | {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        } | {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        };
+        input: {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        } | {
+            type: "CSw";
+            internalVapixParameters: string;
+        } | {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        };
+        delayS?: number | undefined;
+    };
+    audio: {
+        source: "none";
+    } | {
+        source: "microphone";
+        audioChannelNbr: number;
+        forceStereo: boolean;
+    } | {
+        path: string;
+        name: string;
+        source: "file";
+        forceStereo: boolean;
+    } | {
+        name: string;
+        url: string;
+        source: "url";
+        forceStereo: boolean;
+        avSyncMsec: number;
     };
 }, {
+    status: {
+        led: boolean;
+        port?: number | undefined;
+    };
+    streamId: string;
     enabled: boolean;
-    id: number;
     active: boolean;
     title: string;
+    callApi: boolean;
     trigger: {
         type: "manual";
-        ioPort: string | null;
+        port?: number | undefined;
     } | {
         type: "onetime";
         startTime: number;
         stopTime: number;
+        everActivated: boolean;
+        prepareAheadS?: number | undefined;
     } | {
         type: "recurrent";
         schedule: {
@@ -353,17 +457,124 @@ export declare const streamCommonSchema: z.ZodObject<{
             };
             isActive: boolean;
         }[];
+        prepareAheadS?: number | undefined;
     };
-    inputType: "RTSP_URL" | "CSw" | "CRS";
-    internalVapixParameters: {
-        camera: string;
-        resolution?: string | undefined;
-        compression?: number | undefined;
-        audio?: 0 | 1 | undefined;
-        fps?: number | undefined;
-        videobitrate?: number | undefined;
-        videomaxbitrate?: number | undefined;
+    video: {
+        output: {
+            type: "video";
+            url: string | null;
+            parameters: string;
+            saveToSdCard?: {
+                ruleId: string;
+                configurationId: string;
+            } | undefined;
+        } | {
+            type: "images";
+            url: string | null;
+            imageIntervalS: number;
+        } | {
+            type: "none";
+            saveToSdCard: {
+                ruleId: string;
+                configurationId: string;
+            };
+        };
+        input: {
+            type: "RTSP_URL";
+            url: string;
+            internalVapixParameters: string;
+        } | {
+            type: "CSw";
+            internalVapixParameters: string;
+        } | {
+            type: "CRS";
+            internalVapixParameters: string;
+            userVapixParameters: string;
+        };
+        delayS?: number | undefined;
+    };
+    audio: {
+        source: "none";
+    } | {
+        source: "microphone";
+        audioChannelNbr: number;
+        forceStereo: boolean;
+    } | {
+        path: string;
+        name: string;
+        source: "file";
+        forceStereo: boolean;
+    } | {
+        name: string;
+        url: string;
+        source: "url";
+        forceStereo: boolean;
+        avSyncMsec: number;
     };
 }>;
 export type TCommonStream = z.infer<typeof streamCommonSchema>;
-export {};
+export type TStreamAudio = TCommonStream['audio'];
+export type TStreamAudioSource = NonNullable<TStreamAudio>['source'];
+export type TAudioOfSource<T extends TStreamAudioSource> = {
+    audio: Extract<TStreamAudio, {
+        source: T;
+    }>;
+};
+export type TStreamTrigger = TCommonStream['trigger'];
+export type TStreamTriggerType = TStreamTrigger['type'];
+export type TTriggerSchedule = Extract<TStreamTrigger, {
+    type: 'recurrent';
+}>['schedule'];
+export type TStreamVideo = TCommonStream['video'];
+export type TStreamInputType = TStreamVideo['input']['type'];
+export type TStreamOutputType = TStreamVideo['output']['type'];
+export declare const internalVapixParametersSchema: z.ZodObject<{
+    bitrateMode: z.ZodUnion<[z.ZodLiteral<"VBR">, z.ZodLiteral<"MBR">, z.ZodLiteral<"ABR">]>;
+    maximumBitRate: z.ZodNumber;
+    retentionTime: z.ZodNumber;
+    bitRateLimit: z.ZodNumber;
+} & {
+    camera: z.ZodString;
+    resolution: z.ZodString;
+    fps: z.ZodNumber;
+    compression: z.ZodNumber;
+    govLength: z.ZodNumber;
+    videoCodec: z.ZodUnion<[z.ZodLiteral<"h264">, z.ZodLiteral<"h265">, z.ZodLiteral<"av1">]>;
+    h264Profile: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"high">, z.ZodLiteral<"main">, z.ZodLiteral<"baseline">]>>;
+    audio: z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>]>;
+    nbrOfChannels: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    overlays: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"all">, z.ZodLiteral<"text">, z.ZodLiteral<"image">, z.ZodLiteral<"application">, z.ZodLiteral<"off">]>>;
+}, "strip", z.ZodTypeAny, {
+    camera: string;
+    resolution: string;
+    compression: number;
+    bitrateMode: "VBR" | "MBR" | "ABR";
+    maximumBitRate: number;
+    retentionTime: number;
+    bitRateLimit: number;
+    audio: 0 | 1;
+    fps: number;
+    govLength: number;
+    videoCodec: "h264" | "h265" | "av1";
+    overlays?: "text" | "all" | "image" | "application" | "off" | undefined;
+    h264Profile?: "high" | "main" | "baseline" | undefined;
+    nbrOfChannels?: 1 | 2 | undefined;
+}, {
+    camera: string;
+    resolution: string;
+    compression: number;
+    bitrateMode: "VBR" | "MBR" | "ABR";
+    maximumBitRate: number;
+    retentionTime: number;
+    bitRateLimit: number;
+    audio: 0 | 1;
+    fps: number;
+    govLength: number;
+    videoCodec: "h264" | "h265" | "av1";
+    overlays?: "text" | "all" | "image" | "application" | "off" | undefined;
+    h264Profile?: "high" | "main" | "baseline" | undefined;
+    nbrOfChannels?: 1 | 2 | undefined;
+}>;
+export type TInternalVapixParameters = z.infer<typeof internalVapixParametersSchema>;
+export type TVideoCodec = TInternalVapixParameters['videoCodec'];
+export type TOverlays = TInternalVapixParameters['overlays'];