onvif
    Preparing search index...

    Interface Analytics

    Analytics service — rules and analytics modules on a configuration.

    import { Onvif } from 'onvif';

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

    // Uses activeMediaProfile.videoAnalyticsConfigurationToken when omitted:
    const supportedRules = await onvif.analytics.getSupportedRules();
    const rules = await onvif.analytics.getRules();
    const supportedModules = await onvif.analytics.getSupportedAnalyticsModules();
    const modules = await onvif.analytics.getAnalyticsModules();

    console.log(supportedRules.ruleDescription?.map((r) => r.name));
    console.log(rules.map((r) => r.name), modules.map((m) => m.name));
    console.log(supportedModules.analyticsModuleDescription?.map((m) => m.name));
    interface Analytics {
        onvif: Onvif;
        service: keyof OnvifServices;
        xmlns: string;
        createAnalyticsModules(
            options?: WithOptionalConfigToken<CreateAnalyticsModules>,
        ): Promise<void>;
        createRules(options: WithOptionalConfigToken<CreateRules>): Promise<void>;
        deleteAnalyticsModules(
            options: WithOptionalConfigToken<DeleteAnalyticsModules>,
        ): Promise<void>;
        deleteRules(options: WithOptionalConfigToken<DeleteRules>): Promise<void>;
        getAnalyticsModuleOptions(
            options?: WithOptionalConfigToken<GetAnalyticsModuleOptions>,
        ): Promise<ConfigOptions[]>;
        getAnalyticsModules(
            options?: Partial<GetAnalyticsModules>,
        ): Promise<Config[]>;
        getRuleOptions(
            options?: WithOptionalConfigToken<GetRuleOptions>,
        ): Promise<ConfigOptions[]>;
        getRules(options?: Partial<GetRules>): Promise<Config[]>;
        getServiceCapabilities(): Promise<Capabilities>;
        getSupportedAnalyticsModules(
            options?: Partial<GetSupportedAnalyticsModules>,
        ): Promise<SupportedAnalyticsModules>;
        getSupportedMetadata(
            options?: GetSupportedMetadata,
        ): Promise<MetadataInfo[]>;
        getSupportedRules(
            options?: Partial<GetSupportedRules>,
        ): Promise<SupportedRules>;
        modifyAnalyticsModules(
            options?: WithOptionalConfigToken<ModifyAnalyticsModules>,
        ): Promise<void>;
        modifyRules(options: WithOptionalConfigToken<ModifyRules>): Promise<void>;
        request<T = any>(
            body: OnvifSoapBody,
            options?: LineraseOptions,
        ): Promise<T>;
    }

    Hierarchy (View Summary)

    Index
    onvif service xmlns
    createAnalyticsModules createRules deleteAnalyticsModules deleteRules getAnalyticsModuleOptions getAnalyticsModules getRuleOptions getRules getServiceCapabilities getSupportedAnalyticsModules getSupportedMetadata getSupportedRules modifyAnalyticsModules modifyRules request
    onvif: Onvif
    service: keyof OnvifServices
    xmlns: string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods