onvif
    Preparing search index...

    Interface AnalyticsDevice

    Analytics Device service — analytics engines, inputs, and controls.

    import { Onvif } from 'onvif';

    const onvif = new Onvif({ hostname: '192.168.1.13', username: 'admin', password: 'admin' });
    await onvif.connect();

    const engines = await onvif.analyticsDevice.getAnalyticsEngines();
    const controls = await onvif.analyticsDevice.getAnalyticsEngineControls();
    const inputs = await onvif.analyticsDevice.getAnalyticsEngineInputs();
    console.log(engines.map((e) => e.name), controls.length, inputs.length);

    const controlToken = controls[0]?.token;
    if (controlToken) {
      const state = await onvif.analyticsDevice.getAnalyticsState({
        analyticsEngineControlToken: controlToken,
      });
      const uri = await onvif.analyticsDevice.getAnalyticsDeviceStreamUri({
        analyticsEngineControlToken: controlToken,
        streamSetup: { stream: 'RTP-Unicast', transport: { protocol: 'RTSP' } },
      });
      console.log(state, uri);
    }
    interface AnalyticsDevice {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        createAnalyticsEngineControl(
            options: CreateAnalyticsEngineControl,
        ): Promise<AnalyticsEngineInput[]>;
        createAnalyticsEngineInputs(
            options: CreateAnalyticsEngineInputs,
        ): Promise<AnalyticsEngineInput[]>;
        deleteAnalyticsEngineControl(
            options: DeleteAnalyticsEngineControl,
        ): Promise<void>;
        deleteAnalyticsEngineInputs(
            options: DeleteAnalyticsEngineInputs,
        ): Promise<void>;
        getAnalyticsDeviceStreamUri(
            options: GetAnalyticsDeviceStreamUri,
        ): Promise<string>;
        getAnalyticsEngine(options: GetAnalyticsEngine): Promise<AnalyticsEngine>;
        getAnalyticsEngineControl(
            options: GetAnalyticsEngineControl,
        ): Promise<AnalyticsEngineControl>;
        getAnalyticsEngineControls(): Promise<AnalyticsEngineControl[]>;
        getAnalyticsEngineInput(
            options: GetAnalyticsEngineInput,
        ): Promise<AnalyticsEngineInput>;
        getAnalyticsEngineInputs(): Promise<AnalyticsEngineInput[]>;
        getAnalyticsEngines(): Promise<AnalyticsEngine[]>;
        getAnalyticsState(
            options: GetAnalyticsState,
        ): Promise<AnalyticsStateInformation>;
        getServiceCapabilities(): Promise<Capabilities>;
        getVideoAnalyticsConfiguration(
            options: GetVideoAnalyticsConfiguration,
        ): Promise<VideoAnalyticsConfiguration>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
        setAnalyticsEngineControl(
            options: SetAnalyticsEngineControl,
        ): Promise<void>;
        setAnalyticsEngineInput(options: SetAnalyticsEngineInput): Promise<void>;
        setVideoAnalyticsConfiguration(
            options: SetVideoAnalyticsConfiguration,
        ): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    createAnalyticsEngineControl createAnalyticsEngineInputs deleteAnalyticsEngineControl deleteAnalyticsEngineInputs getAnalyticsDeviceStreamUri getAnalyticsEngine getAnalyticsEngineControl getAnalyticsEngineControls getAnalyticsEngineInput getAnalyticsEngineInputs getAnalyticsEngines getAnalyticsState getServiceCapabilities getVideoAnalyticsConfiguration request setAnalyticsEngineControl setAnalyticsEngineInput setVideoAnalyticsConfiguration
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods