camstreamerlib 4.0.0-beta.9 → 4.0.0-beta.91

package/cjs/CamStreamerAPI.d.ts

@@ -1,16 +1,590 @@
-import { IClient } from './internal/common';
-import { CamStreamerAPIOptions, TStreamAttributes, TStreamList } from './types/CamStreamerAPI';
-export declare class CamStreamerAPI {
+import { ProxyClient } from './internal/ProxyClient';
+import { IClient, TBlobResponse, TResponse } from './internal/types';
+import { TAudioFile, TAudioFileStorageType, TStream, TStreamList } from './types/CamStreamerAPI/CamStreamerAPI';
+import { THttpRequestOptions, TProxyParams } from './types/common';
+import { TOldStream, TOldStringStream } from './types/CamStreamerAPI/oldStreamSchema';
+export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> {
     private client;
-    constructor(options?: CamStreamerAPIOptions | IClient);
-    getStreamList(): Promise<TStreamList>;
-    getStream(streamID: string): Promise<TStreamAttributes>;
-    getStreamParameter(streamID: string, paramName: string): Promise<string>;
-    setStream(streamID: string, params: Partial<TStreamAttributes>): Promise<void>;
-    setStreamParameter(streamID: string, paramName: string, value: string): Promise<void>;
-    isStreaming(streamID: string): Promise<boolean>;
-    deleteStream(streamID: string): Promise<void>;
-    wsAutoratization(): Promise<string>;
-    getUtcTime(): Promise<number>;
-    private get;
+    constructor(client: Client);
+    static getProxyPath: () => string;
+    getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
+    wsAuthorization(options?: THttpRequestOptions): Promise<string>;
+    getUtcTime(options?: THttpRequestOptions): Promise<number>;
+    getStreamList(options?: THttpRequestOptions): Promise<({
+        type: "facebook";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "hls";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "mpeg_dvb";
+        port: number;
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+        ipAddress: string;
+        standard: "DVB" | "ATSC";
+        nullPacketsPaddingEnabled: boolean;
+        nullPacketsPaddingKbps: number;
+        videoPid: number;
+        audioPid: number;
+        mpegtsStreamId: number;
+        pmtPid: number;
+        pcrPid: number;
+        pcrPeriodMs: number;
+        providerName: string;
+        serviceName: string;
+        statusCameraLed: boolean;
+        statusCameraOutput: string;
+        saveToSdCard: boolean;
+    } | {
+        type: "rtmp";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "sd_card";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "windy";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "youtube";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    })[]>;
+    setStreamList(streamList: TStreamList['streamList'], options?: THttpRequestOptions): Promise<void>;
+    getStream(streamId: number, options?: THttpRequestOptions): Promise<{
+        type: "facebook";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "hls";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "mpeg_dvb";
+        port: number;
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+        ipAddress: string;
+        standard: "DVB" | "ATSC";
+        nullPacketsPaddingEnabled: boolean;
+        nullPacketsPaddingKbps: number;
+        videoPid: number;
+        audioPid: number;
+        mpegtsStreamId: number;
+        pmtPid: number;
+        pcrPid: number;
+        pcrPeriodMs: number;
+        providerName: string;
+        serviceName: string;
+        statusCameraLed: boolean;
+        statusCameraOutput: string;
+        saveToSdCard: boolean;
+    } | {
+        type: "rtmp";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "sd_card";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "windy";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    } | {
+        type: "youtube";
+        enabled: boolean;
+        id: number;
+        active: boolean;
+        title: string;
+        trigger: {
+            type: "manual";
+            ioPort: string | null;
+        } | {
+            type: "onetime";
+            startTime: number;
+            stopTime: number;
+        } | {
+            type: "recurrent";
+            schedule: {
+                start: {
+                    day: number;
+                    timeS: number;
+                };
+                stop: {
+                    day: number;
+                    timeS: number;
+                };
+                isActive: boolean;
+            }[];
+        };
+        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;
+        };
+    }>;
+    setStream(streamId: number, streamData: Partial<TStream>, options?: THttpRequestOptions): Promise<void>;
+    isStreaming(streamId: number, options?: THttpRequestOptions): Promise<boolean>;
+    listFiles(options?: THttpRequestOptions): Promise<{
+        path: string;
+        name: string;
+        storage: "url" | "flash" | "SD0";
+    }[]>;
+    uploadFile(formData: Parameters<Client['post']>[0]['data'], storage: TAudioFileStorageType, options?: THttpRequestOptions): Promise<void>;
+    removeFile(fileParams: TAudioFile, options?: THttpRequestOptions): Promise<void>;
+    getFileStorage(options?: THttpRequestOptions): Promise<({
+        type: "flash";
+        flash: string;
+    } | {
+        type: "SD0";
+        SD0: string;
+    })[]>;
+    getFileFromCamera(path: string, options?: THttpRequestOptions): Promise<TBlobResponse<Client>>;
+    private _getJson;
+    private _getBlob;
+    private parseBlobResponse;
+    private _postUrlEncoded;
+    private _postJsonEncoded;
+    private _post;
 }
+export declare const parseCameraStreamResponse: (cameraStreamData: TOldStringStream) => TOldStream;