camstreamerlib/types/CamStreamerAPI.d.ts

Helper library for CamStreamer ACAP applications.

import { ProxyClient } from './internal/ProxyClient';
import { IClient, TResponse } from './internal/types';
import { TCameraStream, TStream } from './types/CamStreamerAPI';
import { THttpRequestOptions, TProxyParams } from './types/common';
export declare class CamStreamerAPI<Client extends IClient<TResponse, any>> {
    private client;
    constructor(client: Client);
    getClient(proxyParams?: TProxyParams): Client | ProxyClient<Client>;
    wsAuthorization(options?: THttpRequestOptions): Promise<string>;
    getUtcTime(options?: THttpRequestOptions): Promise<number>;
    getStreamList(options?: THttpRequestOptions): Promise<Record<number, {
        enabled: 0 | 1;
        schedule: string;
        active: 0 | 1;
        audioSource: string;
        avSyncMsec: number;
        internalVapixParameters: string;
        userVapixParameters: string;
        outputParameters: string;
        outputType: "video" | "none" | "images";
        mediaServerUrl: string;
        inputType: "RTSP_URL" | "CSw" | "CRS";
        inputUrl: string;
        forceStereo: 0 | 1;
        streamDelay: number | null;
        statusLed: number;
        statusPort: string;
        callApi: number;
        trigger: string;
        prepareAhead: number;
        startTime: number | null;
        stopTime: number | null;
    }>>;
    getStream(streamId: number, options?: THttpRequestOptions): Promise<{
        enabled: 0 | 1;
        schedule: string;
        active: 0 | 1;
        audioSource: string;
        avSyncMsec: number;
        internalVapixParameters: string;
        userVapixParameters: string;
        outputParameters: string;
        outputType: "video" | "none" | "images";
        mediaServerUrl: string;
        inputType: "RTSP_URL" | "CSw" | "CRS";
        inputUrl: string;
        forceStereo: 0 | 1;
        streamDelay: number | null;
        statusLed: number;
        statusPort: string;
        callApi: number;
        trigger: string;
        prepareAhead: number;
        startTime: number | null;
        stopTime: number | null;
    }>;
    getStreamParameter(streamId: number, paramName: string, options?: THttpRequestOptions): Promise<string>;
    setStream(streamId: number, params: Partial<TStream>, options?: THttpRequestOptions): Promise<void>;
    setStreamParameter(streamId: number, paramName: string, value: string, options?: THttpRequestOptions): Promise<void>;
    isStreaming(streamId: number, options?: THttpRequestOptions): Promise<boolean>;
    deleteStream(streamId: number, options?: THttpRequestOptions): Promise<boolean>;
    private _getJson;
}
export declare const parseCameraStreamResponse: (cameraStreamData: TCameraStream) => TStream;