camstreamerlib/CamOverlayAPI.d.ts

Helper library for CamStreamer ACAP applications.

/// <reference types="node" />
import { HttpOptions, IClient } from './internal/common';
export type CamOverlayOptions = HttpOptions;
export type TField = {
    field_name: string;
    text: string;
    color?: string;
};
export type TService = Record<string, any>;
export type TServiceList = {
    services: TService[];
};
export type TNetworkCameraList = {
    name: string;
    ip: string;
}[];
export type TImage = {
    name: string;
    path: string;
    storage: string;
};
export declare enum ImageType {
    PNG = 0,
    JPEG = 1
}
export type TCoordinates = 'top_left' | 'top_right' | 'top' | 'bottom_left' | 'bottom_right' | 'bottom' | 'left' | 'right' | 'center' | '';
export declare class CamOverlayAPI {
    private client;
    constructor(options?: CamOverlayOptions | IClient);
    checkCameraTime(): Promise<boolean>;
    listImages(): Promise<TImage[]>;
    uploadImage(file: Buffer, fileName: string): Promise<void>;
    getNetworkCameraList(): Promise<TNetworkCameraList>;
    updateInfoticker(serviceID: number, text: string): Promise<void>;
    setEnabled(serviceID: number, enabled: boolean): Promise<void>;
    isEnabled(serviceID: number): Promise<boolean>;
    getSingleService(serviceId: number): Promise<TService>;
    getServices(): Promise<TService[]>;
    updateSingleService(serviceId: number, serviceJson: TService): Promise<void>;
    updateServices(servicesJson: TServiceList): Promise<void>;
    updateCGText(serviceID: number, fields: TField[]): Promise<void>;
    updateCGImagePos(serviceID: number, coordinates?: TCoordinates, x?: number, y?: number): Promise<void>;
    updateCGImage(serviceID: number, path: string, coordinates?: TCoordinates, x?: number, y?: number): Promise<void>;
    updateCGImageFromData(serviceID: number, imageType: ImageType, imageData: Buffer, coordinates?: TCoordinates, x?: number, y?: number): Promise<void>;
    private promiseCGUpdate;
    private get;
    private post;
}