Skip to content

AnalyticsDevice

AnalyticsDevice service implementation.

AnalyticsDevice

Bases: ONVIFService

0.0.1 2.0

The AnalyticsDevice service (AnalyticsDeviceBinding) aka 'Video Analytics Device' has been marked as obsolete since ONVIF 18.12.

Its functionality has largely been merged into the Analytics service and, in some cases Media/Media2.

This class is kept here only for backward compatibility with older devices (pre-2019) that may still expose an AnalyticsDevice XAddr.

In modern ONVIF-compliant devices, you should prefer using the Analytics or Media/Media2 services. If the device does not list AnalyticsDevice in GetServices response, then this service is not available on the device and calling this class will result in SOAP faults.

Property Details
First introduced ONVIF 2.0 (November 2010)
Deprecated ONVIF 18.12 (December 2018)
Binding name AnalyticsDeviceBinding (ver10/analyticsdevice.wsdl)
Successor Analytics Service (ver20/analytics/wsdl/analytics.wsdl)
Operations analyticsdevice.wsdl
Spec Video Analytics Device

GetServiceCapabilities

GetServiceCapabilities()

Returns the capabilities of the analytics device service.

The result is returned in a typed answer.

DeleteAnalyticsEngineControl

DeleteAnalyticsEngineControl(ConfigurationToken)

DeleteAnalyticsEngineControl shall delete a control object .

CreateAnalyticsEngineControl

CreateAnalyticsEngineControl(Configuration)

CreateAnalyticsEngineControl shall create a new control object.

SetAnalyticsEngineControl

SetAnalyticsEngineControl(Configuration, ForcePersistence)

This command modifies the AnalyticsEngineControl configuration.

GetAnalyticsEngineControl

GetAnalyticsEngineControl(ConfigurationToken)

The GetAnalyticsEngineControl command fetches the analytics engine control if the analytics engine control token is known.

GetAnalyticsEngineControls

GetAnalyticsEngineControls()

This operation lists all available analytics engine controls for the device.

GetAnalyticsEngine

GetAnalyticsEngine(ConfigurationToken)

The GetAnalyticsEngine command fetches the analytics engine configuration if the token is known.

GetAnalyticsEngines

GetAnalyticsEngines()

This operation lists all available analytics engine configurations for the device.

SetVideoAnalyticsConfiguration

SetVideoAnalyticsConfiguration(
    Configuration, ForcePersistence
)

A video analytics configuration is modified using this command.

SetAnalyticsEngineInput

SetAnalyticsEngineInput(Configuration, ForcePersistence)

This command modifies the analytics engine input configuration.

GetAnalyticsEngineInput

GetAnalyticsEngineInput(ConfigurationToken)

The GetAnalyticsEngineInput command fetches the input configuration if the analytics engine input configuration token is known.

GetAnalyticsEngineInputs

GetAnalyticsEngineInputs()

This operation lists all available analytics engine input configurations for the device.

GetAnalyticsDeviceStreamUri

GetAnalyticsDeviceStreamUri(
    StreamSetup, AnalyticsEngineControlToken
)

This operation requests a URI that can be used to initiate a live stream using RTSP as the control protocol if the token of the AnalyticsEngineControl is known.

GetVideoAnalyticsConfiguration

GetVideoAnalyticsConfiguration(ConfigurationToken)

The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics configuration token is known.

CreateAnalyticsEngineInputs

CreateAnalyticsEngineInputs(
    Configuration, ForcePersistence
)

This command generates one or more analytics engine input configurations.

DeleteAnalyticsEngineInputs

DeleteAnalyticsEngineInputs(ConfigurationToken)

This command deletes analytics engine input configurations if the tokens are known.

GetAnalyticsState

GetAnalyticsState(AnalyticsEngineControlToken)

GetAnalyticsState returns status information of the referenced AnalyticsEngineControl object.