camstreamerlib 1.9.1 → 2.0.0

package/CamOverlayAPI.d.ts

@@ -1,43 +1,11 @@
 /// <reference types="node" />
-/// <reference types="node" />
-import * as EventEmitter from 'events';
-export type CamOverlayOptions = {
-    protocol?: string;
-    tls?: boolean;
-    tlsInsecure?: boolean;
-    ip?: string;
-    port?: number;
-    auth?: string;
-    serviceName?: string;
-    serviceID?: number;
-    camera?: number | number[];
-};
+import { Options } from './common';
+export type CamOverlayOptions = Options;
 export type Field = {
     field_name: string;
     text: string;
     color?: string;
 };
-export type Message = {
-    command: string;
-    params: any[];
-};
-export type CairoResponse = {
-    message: string;
-    call_id: number;
-};
-export type CairoCreateResponse = {
-    var: string;
-    call_id: number;
-};
-export type UploadImageResponse = {
-    var: string;
-    width: number;
-    height: number;
-    call_id: number;
-};
-export type Align = 'A_RIGHT' | 'A_LEFT' | 'A_CENTER';
-export type TextFit = 'TFM_SCALE' | 'TFM_TRUNCATE' | 'TFM_OVERFLOW';
-export type WriteTextParams = [string, string, number, number, number, number, Align, TextFit?];
 export type Service = {
     id: number;
     enabled: number;
@@ -53,44 +21,22 @@ export declare enum ImageType {
     PNG = 0,
     JPEG = 1
 }
-export declare class CamOverlayAPI extends EventEmitter {
+export declare class CamOverlayAPI {
     private tls;
     private tlsInsecure;
     private ip;
     private port;
     private auth;
-    private serviceName;
-    private serviceID;
-    private cameraList;
-    private callId;
-    private sendMessages;
-    private ws;
     constructor(options?: CamOverlayOptions);
-    connect(): Promise<void>;
-    createService(): Promise<number>;
+    updateCGText(serviceID: number, fields: Field[]): Promise<void>;
+    updateCGImagePos(serviceID: number, coordinates?: string, x?: number, y?: number): Promise<void>;
+    updateCGImage(serviceID: number, path: string, coordinates?: string, x?: number, y?: number): Promise<void>;
+    updateInfoticker(serviceID: number, text: string): Promise<void>;
+    setEnabled(serviceID: number, enabled: boolean): Promise<void>;
+    isEnabled(serviceID: number): Promise<boolean>;
     updateServices(servicesJson: ServiceList): Promise<void>;
-    openWebsocket(digestHeader?: string): Promise<void>;
-    cairo(command: string, ...params: any[]): Promise<CairoResponse | CairoCreateResponse>;
-    writeText(...params: WriteTextParams): Promise<CairoResponse>;
-    uploadImageData(imgBuffer: Buffer): Promise<UploadImageResponse>;
-    uploadFontData(fontBuffer: Buffer): Promise<CairoCreateResponse>;
-    showCairoImage(cairoImage: string, posX: number, posY: number): Promise<CairoResponse>;
-    showCairoImageAbsolute(cairoImage: string, posX: number, posY: number, width: number, height: number): Promise<CairoResponse>;
-    removeImage(): Promise<CairoResponse>;
-    private sendMessage;
-    private sendBinaryMessage;
-    private reportMsg;
-    private reportErr;
-    private reportClose;
-    updateCGText(fields: Field[]): Promise<void>;
+    updateCGImageFromData(serviceID: number, imageType: ImageType, imageData: Buffer, coordinates?: string, x?: number, y?: number): Promise<void>;
+    promiseCGUpdate(serviceID: number, action: string, params: string, contentType?: string, data?: Buffer): Promise<void>;
     private formCoordinates;
-    updateCGImage(path: string, coordinates?: string, x?: number, y?: number): Promise<void>;
-    updateCGImageFromData(imageType: ImageType, imageData: Buffer, coordinates?: string, x?: number, y?: number): Promise<void>;
-    updateCGImagePos(coordinates?: string, x?: number, y?: number): Promise<void>;
-    promiseCGUpdate(action: string, params: string, contentType?: string, data?: Buffer): Promise<void>;
-    updateInfoticker(text: string): Promise<void>;
-    setEnabled(enabled: boolean): Promise<void>;
-    isEnabled(): Promise<boolean>;
     private getBaseVapixConnectionParams;
-    private compareCameraList;
 }

package/CamOverlayAPI.js

@@ -10,261 +10,22 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CamOverlayAPI = exports.ImageType = void 0;
-const WebSocket = require("ws");
-const EventEmitter = require("events");
-const Digest_1 = require("./Digest");
-const HTTPRequest_1 = require("./HTTPRequest");
+const HttpRequest_1 = require("./HttpRequest");
 var ImageType;
 (function (ImageType) {
     ImageType[ImageType["PNG"] = 0] = "PNG";
     ImageType[ImageType["JPEG"] = 1] = "JPEG";
 })(ImageType = exports.ImageType || (exports.ImageType = {}));
-class CamOverlayAPI extends EventEmitter {
+class CamOverlayAPI {
     constructor(options) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        super();
-        this.ws = null;
+        var _a, _b, _c, _d, _e;
         this.tls = (_a = options === null || options === void 0 ? void 0 : options.tls) !== null && _a !== void 0 ? _a : false;
-        if ((options === null || options === void 0 ? void 0 : options.tls) === undefined && (options === null || options === void 0 ? void 0 : options.protocol) !== undefined) {
-            this.tls = options.protocol === 'wss';
-        }
         this.tlsInsecure = (_b = options === null || options === void 0 ? void 0 : options.tlsInsecure) !== null && _b !== void 0 ? _b : false;
         this.ip = (_c = options === null || options === void 0 ? void 0 : options.ip) !== null && _c !== void 0 ? _c : '127.0.0.1';
         this.port = (_d = options === null || options === void 0 ? void 0 : options.port) !== null && _d !== void 0 ? _d : (this.tls ? 443 : 80);
         this.auth = (_e = options === null || options === void 0 ? void 0 : options.auth) !== null && _e !== void 0 ? _e : '';
-        this.serviceName = (_f = options === null || options === void 0 ? void 0 : options.serviceName) !== null && _f !== void 0 ? _f : '';
-        this.serviceID = (_g = options === null || options === void 0 ? void 0 : options.serviceID) !== null && _g !== void 0 ? _g : -1;
-        this.cameraList = [0];
-        if (Array.isArray(options === null || options === void 0 ? void 0 : options.camera)) {
-            this.cameraList = options.camera;
-        }
-        else if (typeof (options === null || options === void 0 ? void 0 : options.camera) === 'number') {
-            this.cameraList = [options.camera];
-        }
-        this.callId = 0;
-        this.sendMessages = {};
-        EventEmitter.call(this);
-    }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                if (this.serviceID === -1) {
-                    this.serviceID = yield this.createService();
-                }
-                yield this.openWebsocket();
-                this.emit('open');
-            }
-            catch (err) {
-                this.reportErr(err);
-            }
-        });
-    }
-    createService() {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = this.getBaseVapixConnectionParams();
-            options.method = 'GET';
-            options.path = '/local/camoverlay/api/services.cgi?action=get';
-            const response = (yield (0, HTTPRequest_1.httpRequest)(options));
-            let servicesJson;
-            try {
-                servicesJson = JSON.parse(response);
-                (_a = servicesJson.services) !== null && _a !== void 0 ? _a : (servicesJson.services = []);
-            }
-            catch (_b) {
-                servicesJson = { services: [] };
-            }
-            let service = null;
-            let maxID = -1;
-            let servicesArr = servicesJson.services;
-            for (let s of servicesArr) {
-                if (s.id > maxID) {
-                    maxID = s.id;
-                }
-                if (s.identifier === this.serviceName && s.name === 'scripter') {
-                    service = s;
-                    break;
-                }
-            }
-            if (service !== null) {
-                if (service.cameraList === undefined || !this.compareCameraList(service.cameraList)) {
-                    service.cameraList = this.cameraList;
-                    yield this.updateServices(servicesJson);
-                    return service.id;
-                }
-                else {
-                    return service.id;
-                }
-            }
-            else {
-                let newServiceID = maxID + 1;
-                service = {
-                    id: newServiceID,
-                    enabled: 1,
-                    schedule: '',
-                    name: 'scripter',
-                    identifier: this.serviceName,
-                    cameraList: this.cameraList,
-                };
-                servicesJson.services.push(service);
-                yield this.updateServices(servicesJson);
-                return newServiceID;
-            }
-        });
-    }
-    updateServices(servicesJson) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = this.getBaseVapixConnectionParams();
-            options.method = 'POST';
-            options.path = '/local/camoverlay/api/services.cgi?action=set';
-            yield (0, HTTPRequest_1.httpRequest)(options, JSON.stringify(servicesJson));
-        });
-    }
-    openWebsocket(digestHeader) {
-        let promise = new Promise((resolve, reject) => {
-            const userPass = this.auth.split(':');
-            const protocol = this.tls ? 'wss' : 'ws';
-            const addr = `${protocol}://${this.ip}:${this.port}/local/camoverlay/ws`;
-            const options = {
-                auth: this.auth,
-                rejectUnauthorized: !this.tlsInsecure,
-                headers: {},
-            };
-            if (digestHeader !== undefined) {
-                options.headers['Authorization'] = Digest_1.Digest.getAuthHeader(userPass[0], userPass[1], 'GET', '/local/camoverlay/ws', digestHeader);
-            }
-            this.ws = new WebSocket(addr, 'cairo-api', options);
-            this.ws.binaryType = 'arraybuffer';
-            this.ws.isAlive = true;
-            const pingTimer = setInterval(() => {
-                if (this.ws.readyState !== this.ws.OPEN || this.ws.isAlive === false) {
-                    return this.ws.terminate();
-                }
-                this.ws.isAlive = false;
-                this.ws.ping();
-            }, 30000);
-            this.ws.on('open', () => {
-                this.reportMsg('Websocket opened');
-                resolve();
-            });
-            this.ws.on('pong', () => {
-                this.ws.isAlive = true;
-            });
-            this.ws.on('message', (data) => {
-                let dataJSON = JSON.parse(data);
-                if (dataJSON.hasOwnProperty('call_id') && dataJSON['call_id'] in this.sendMessages) {
-                    if (dataJSON.hasOwnProperty('error')) {
-                        this.sendMessages[dataJSON['call_id']].reject(new Error(dataJSON.error));
-                    }
-                    else {
-                        this.sendMessages[dataJSON['call_id']].resolve(dataJSON);
-                    }
-                    delete this.sendMessages[dataJSON['call_id']];
-                }
-                if (dataJSON.hasOwnProperty('error')) {
-                    this.reportErr(new Error(dataJSON.error));
-                }
-                else {
-                    this.reportMsg(data);
-                }
-            });
-            this.ws.on('unexpected-response', (req, res) => __awaiter(this, void 0, void 0, function* () {
-                if (res.statusCode === 401 && res.headers['www-authenticate'] !== undefined)
-                    this.openWebsocket(res.headers['www-authenticate']).then(resolve, reject);
-                else {
-                    reject('Error: status code: ' + res.statusCode + ', ' + res.data);
-                }
-            }));
-            this.ws.on('error', (error) => {
-                this.reportErr(error);
-                reject(error);
-            });
-            this.ws.on('close', () => {
-                clearInterval(pingTimer);
-                this.reportClose();
-            });
-        });
-        return promise;
-    }
-    cairo(command, ...params) {
-        return this.sendMessage({ command: command, params: params });
-    }
-    writeText(...params) {
-        return this.sendMessage({ command: 'write_text', params: params });
-    }
-    uploadImageData(imgBuffer) {
-        return this.sendBinaryMessage({
-            command: 'upload_image_data',
-            params: [],
-        }, imgBuffer);
-    }
-    uploadFontData(fontBuffer) {
-        return this.sendBinaryMessage({
-            command: 'upload_font_data',
-            params: [fontBuffer.toString('base64')],
-        }, fontBuffer);
-    }
-    showCairoImage(cairoImage, posX, posY) {
-        return this.sendMessage({
-            command: 'show_cairo_image',
-            params: [this.serviceID, cairoImage, posX, posY],
-        });
-    }
-    showCairoImageAbsolute(cairoImage, posX, posY, width, height) {
-        return this.sendMessage({
-            command: 'show_cairo_image',
-            params: [this.serviceID, cairoImage, -1.0 + (2.0 / width) * posX, -1.0 + (2.0 / height) * posY],
-        });
-    }
-    removeImage() {
-        return this.sendMessage({ command: 'remove_image', params: [this.serviceID] });
-    }
-    sendMessage(msgJson) {
-        return new Promise((resolve, reject) => {
-            try {
-                this.sendMessages[this.callId] = { resolve, reject };
-                msgJson['call_id'] = this.callId++;
-                this.ws.send(JSON.stringify(msgJson));
-            }
-            catch (err) {
-                this.reportErr(new Error(`Send message error: ${err}`));
-            }
-        });
-    }
-    sendBinaryMessage(msgJson, data) {
-        return new Promise((resolve, reject) => {
-            try {
-                this.sendMessages[this.callId] = { resolve, reject };
-                msgJson['call_id'] = this.callId++;
-                const jsonBuffer = Buffer.from(JSON.stringify(msgJson));
-                const header = new ArrayBuffer(5);
-                const headerView = new DataView(header);
-                headerView.setInt8(0, 1);
-                headerView.setInt32(1, jsonBuffer.byteLength);
-                const msgBuffer = Buffer.concat([Buffer.from(header), jsonBuffer, data]);
-                this.ws.send(msgBuffer);
-            }
-            catch (err) {
-                this.reportErr(new Error(`Send binary message error: ${err}`));
-            }
-        });
     }
-    reportMsg(msg) {
-        this.emit('msg', msg);
-    }
-    reportErr(err) {
-        var _a;
-        (_a = this.ws) === null || _a === void 0 ? void 0 : _a.terminate();
-        this.emit('error', err);
-    }
-    reportClose() {
-        for (const callId in this.sendMessages) {
-            this.sendMessages[callId].reject(new Error('Connection lost'));
-        }
-        this.sendMessages = {};
-        this.emit('close');
-    }
-    updateCGText(fields) {
+    updateCGText(serviceID, fields) {
         let field_specs = '';
         for (let field of fields) {
             const name = field.field_name;
@@ -273,67 +34,75 @@ class CamOverlayAPI extends EventEmitter {
                 field_specs += `&${name}_color=${field.color}`;
             }
         }
-        return this.promiseCGUpdate('update_text', field_specs);
+        return this.promiseCGUpdate(serviceID, 'update_text', field_specs);
     }
-    formCoordinates(coordinates, x, y) {
-        return coordinates !== '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
-    }
-    updateCGImage(path, coordinates = '', x = 0, y = 0) {
-        const coord = this.formCoordinates(coordinates, x, y);
-        const update = `&image=${path}`;
-        return this.promiseCGUpdate('update_image', update + coord);
-    }
-    updateCGImageFromData(imageType, imageData, coordinates = '', x = 0, y = 0) {
+    updateCGImagePos(serviceID, coordinates = '', x = 0, y = 0) {
         const coord = this.formCoordinates(coordinates, x, y);
-        const contentType = imageType === ImageType.PNG ? 'image/png' : 'image/jpeg';
-        return this.promiseCGUpdate('update_image', coord, contentType, imageData);
+        return this.promiseCGUpdate(serviceID, 'update_image', coord);
     }
-    updateCGImagePos(coordinates = '', x = 0, y = 0) {
+    updateCGImage(serviceID, path, coordinates = '', x = 0, y = 0) {
         const coord = this.formCoordinates(coordinates, x, y);
-        return this.promiseCGUpdate('update_image', coord);
-    }
-    promiseCGUpdate(action, params, contentType, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const options = this.getBaseVapixConnectionParams();
-            options.method = 'POST';
-            options.path = encodeURI(`/local/camoverlay/api/customGraphics.cgi?action=${action}&service_id=${this.serviceID}${params}`);
-            if (contentType && data) {
-                options.headers = { 'Content-Type': contentType };
-            }
-            yield (0, HTTPRequest_1.httpRequest)(options, data);
-        });
+        const update = `&image=${path}`;
+        return this.promiseCGUpdate(serviceID, 'update_image', update + coord);
     }
-    updateInfoticker(text) {
+    updateInfoticker(serviceID, text) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'GET';
-            options.path = `/local/camoverlay/api/infoticker.cgi?service_id=${this.serviceID}&text=${text}`;
-            yield (0, HTTPRequest_1.httpRequest)(options);
+            options.path = `/local/camoverlay/api/infoticker.cgi?service_id=${serviceID}&text=${text}`;
+            yield (0, HttpRequest_1.httpRequest)(options);
         });
     }
-    setEnabled(enabled) {
+    setEnabled(serviceID, enabled) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'POST';
-            options.path = encodeURI(`/local/camoverlay/api/enabled.cgi?id_${this.serviceID}=${enabled ? 1 : 0}`);
-            yield (0, HTTPRequest_1.httpRequest)(options);
+            options.path = encodeURI(`/local/camoverlay/api/enabled.cgi?id_${serviceID}=${enabled ? 1 : 0}`);
+            yield (0, HttpRequest_1.httpRequest)(options);
         });
     }
-    isEnabled() {
+    isEnabled(serviceID) {
         return __awaiter(this, void 0, void 0, function* () {
             const options = this.getBaseVapixConnectionParams();
             options.method = 'GET';
             options.path = '/local/camoverlay/api/services.cgi?action=get';
-            const response = (yield (0, HTTPRequest_1.httpRequest)(options));
+            const response = (yield (0, HttpRequest_1.httpRequest)(options));
             const data = JSON.parse(response);
             for (let service of data.services) {
-                if (service.id === this.serviceID) {
+                if (service.id === serviceID) {
                     return service.enabled === 1;
                 }
             }
             throw new Error('Service not found.');
         });
     }
+    updateServices(servicesJson) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'POST';
+            options.path = '/local/camoverlay/api/services.cgi?action=set';
+            yield (0, HttpRequest_1.httpRequest)(options, JSON.stringify(servicesJson));
+        });
+    }
+    updateCGImageFromData(serviceID, imageType, imageData, coordinates = '', x = 0, y = 0) {
+        const coord = this.formCoordinates(coordinates, x, y);
+        const contentType = imageType === ImageType.PNG ? 'image/png' : 'image/jpeg';
+        return this.promiseCGUpdate(serviceID, 'update_image', coord, contentType, imageData);
+    }
+    promiseCGUpdate(serviceID, action, params, contentType, data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = this.getBaseVapixConnectionParams();
+            options.method = 'POST';
+            options.path = encodeURI(`/local/camoverlay/api/customGraphics.cgi?action=${action}&service_id=${serviceID}${params}`);
+            if (contentType && data) {
+                options.headers = { 'Content-Type': contentType };
+            }
+            yield (0, HttpRequest_1.httpRequest)(options, data);
+        });
+    }
+    formCoordinates(coordinates, x, y) {
+        return coordinates !== '' ? `&coord_system=${coordinates}&pos_x=${x}&pos_y=${y}` : '';
+    }
     getBaseVapixConnectionParams() {
         return {
             protocol: this.tls ? 'https:' : 'http:',
@@ -343,9 +112,5 @@ class CamOverlayAPI extends EventEmitter {
             rejectUnauthorized: !this.tlsInsecure,
         };
     }
-    compareCameraList(cameraList) {
-        return (this.cameraList.length === cameraList.length &&
-            this.cameraList.every((element, index) => element === cameraList[index]));
-    }
 }
 exports.CamOverlayAPI = CamOverlayAPI;

package/CamOverlayDrawingAPI.d.ts

@@ -0,0 +1,68 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import * as EventEmitter from 'events';
+import { Options } from './common';
+type CamOverlayDrawingOptions = Options & {
+    camera?: number | number[];
+    zIndex?: number;
+};
+export type Message = {
+    command: string;
+    params?: any[];
+};
+export type CairoResponse = {
+    message: string;
+    call_id: number;
+};
+export type CairoCreateResponse = {
+    var: string;
+    call_id: number;
+};
+export type UploadImageResponse = {
+    var: string;
+    width: number;
+    height: number;
+    call_id: number;
+};
+export type Service = {
+    id: number;
+    enabled: number;
+    schedule: string;
+    name: string;
+    identifier: string;
+    cameraList: number[];
+};
+export type ServiceList = {
+    services: Service[];
+};
+export type Align = 'A_RIGHT' | 'A_LEFT' | 'A_CENTER';
+export type TextFit = 'TFM_SCALE' | 'TFM_TRUNCATE' | 'TFM_OVERFLOW';
+export type WriteTextParams = [string, string, number, number, number, number, Align, TextFit?];
+export declare class CamOverlayDrawingAPI extends EventEmitter {
+    private tls;
+    private tlsInsecure;
+    private ip;
+    private port;
+    private auth;
+    private cameraList;
+    private zIndex;
+    private callId;
+    private sendMessages;
+    private ws;
+    constructor(options?: CamOverlayDrawingOptions);
+    connect(): Promise<void>;
+    cairo(command: string, ...params: any[]): Promise<CairoResponse | CairoCreateResponse>;
+    writeText(...params: WriteTextParams): Promise<CairoResponse>;
+    uploadImageData(imgBuffer: Buffer): Promise<UploadImageResponse>;
+    uploadFontData(fontBuffer: Buffer): Promise<CairoCreateResponse>;
+    showCairoImage(cairoImage: string, posX: number, posY: number): Promise<CairoResponse>;
+    showCairoImageAbsolute(cairoImage: string, posX: number, posY: number, width: number, height: number): Promise<CairoResponse>;
+    removeImage(): Promise<CairoResponse>;
+    private openWebsocket;
+    private sendMessage;
+    private sendBinaryMessage;
+    private reportMessage;
+    private reportError;
+    private reportClose;
+}
+export {};