Analytics
Analytics service implementation.
Bases: ONVIFService
0.0.1 2.4 get_analytics_list.py
Analytics service client.
| Property | Details |
|---|---|
| First introduced | ONVIF 2.4 (August 2013) |
| Binding name | AnalyticsEngineBinding (ver20/analytics/wsdl/analytics.wsdl) |
| Operations | analytics.wsdl |
| Spec | Analytics |
Returns the capabilities of the analytics service.
The result is returned in a typed answer.
List all analytics modules that are supported by the given VideoAnalyticsConfiguration.
Add one or more analytics modules to an existing VideoAnalyticsConfiguration.
The available supported types can be retrieved via GetSupportedAnalyticsModules, where the Name of the supported AnalyticsModules correspond to the type of an AnalyticsModule instance.
Pass unique module names which can be later used as reference. The Parameters of the analytics module must match those of the corresponding AnalyticsModuleDescription.
Although this method is mandatory a device implementation may not support adding modules. Instead it can provide a fixed set of predefined configurations via the media service functions GetCompatibleVideoAnalyticsConfigurations and GetAnalyticsConfigurations.
The device shall ensure that a corresponding analytics engine starts operation when a client subscribes directly or indirectly for events produced by the analytics or rule engine or when a client requests the corresponding scene description stream. An analytics module must be attached to a Video source using the media profiles before it can be used. In case differing analytics configurations are attached to the same profile it is undefined which of the analytics module configuration becomes active if no stream is activated or multiple streams with different profiles are activated at the same time.
Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names.
List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.
Return the options for the supported analytics modules that specify an Option attribute.
Modify the settings of one or more analytics modules of a VideoAnalyticsConfiguration.
The modules are referenced by their names. It is allowed to pass only a subset to be modified.
This method provides a computer readable description of the metadata that the selected analytics modules can generate.
The type parameter allows to select a single analytics module. By default the output shall relate to all analytics modules that exist in the device.
The response shall provide a sample XML frame. The sample frame shall include all potentially generated elements by the selected analytics modules. Note that this e.g. does not need to include all possible class type enumerations.