Skip to content

RuleEngine

Analytics (RuleEngine) service implementation.

RuleEngine

Bases: ONVIFService

0.0.1 2.4

Analytics (RuleEngine) service client.

Property Details
First introduced ONVIF 2.4 (August 2013)
Binding name RuleEngineBinding (ver20/analytics/wsdl/analytics.wsdl)
Operations analytics.wsdl
Spec Analytics

GetSupportedRules

GetSupportedRules(ConfigurationToken)

List all rules that are supported by the given VideoAnalyticsConfiguration.

CreateRules

CreateRules(ConfigurationToken, Rule)

Add one or more rules to an existing VideoAnalyticsConfiguration.

The available supported types can be retrieved via GetSupportedRules, where the Name of the supported rule correspond to the type of an rule instance.

Pass unique module names which can be later used as reference. The Parameters of the rules must match those of the corresponding description.

Although this method is mandatory a device implementation must not support adding rules. Instead it can provide a fixed set of predefined configurations via the media service function GetCompatibleVideoAnalyticsConfigurations.

DeleteRules

DeleteRules(ConfigurationToken, RuleName)

Remove one or more rules from a VideoAnalyticsConfiguration.

GetRules

GetRules(ConfigurationToken)

List the currently assigned set of rules of a VideoAnalyticsConfiguration.

GetRuleOptions

GetRuleOptions(ConfigurationToken, RuleType=None)

Return the options for the supported rules that specify an Option attribute.

ModifyRules

ModifyRules(ConfigurationToken, Rule)

Modify one or more rules of a VideoAnalyticsConfiguration.

The rules are referenced by their names.