ONVIF::...ginePort(3)

💅 ONVIF::...ginePort(3) — RuleEnginePort, but make it group-chat

okay so this is a User Contributed Perl Documentation page for ONVIF::...ginePort(3) — yes, the title is abbreviated like that, and the vibe is full SOAP-interface realness. It’s the RuleEnginePort for the Analytics service, and we’re about to make it make sense. 🫶✨

---

🎀 NAME 🎀

ONVIF::Analytics::Interfaces::Analytics::RuleEnginePort — SOAP Interface for the Analytics Web Service. Periodt. 💅

---

✨ SYNOPSIS ✨

use ONVIF::Analytics::Interfaces::Analytics::RuleEnginePort;
my $interface = ONVIF::Analytics::Interfaces::Analytics::RuleEnginePort->new();

my $response;
$response = $interface->GetSupportedRules();
$response = $interface->CreateRules();
$response = $interface->DeleteRules();
$response = $interface->GetRules();
$response = $interface->ModifyRules();

---

🌸 DESCRIPTION 🌸

This is the SOAP Interface for the Analytics web service located at http://www.examples.com/Analytics/. That URL is doing the absolute most, and honestly? Iconic. 🦋

---

🛰️ SERVICE Analytics 🛰️

The service is Analytics, bestie. Keep that in your notes. 📝

🌟 Port RuleEnginePort

The port is RuleEnginePort. Main character energy, no cap. 👑

---

🔥 METHODS 🔥

💬 General methods

new

Constructor. That’s the whole job. 🎀

All arguments are forwarded to SOAP::WSDL::Client.

🧼 SOAP Service methods

Method synopsis is displayed with hash refs as parameters. Yes, that’s the format you’re seeing below — stay with me. 🫶

The commented class names in the method’s parameters denote that objects of the corresponding class can be passed instead of the marked hash ref.

You may pass any combination of objects, hash and list refs to these methods, as long as you meet the structure.

List items (i.e. multiple occurrences) are not displayed in the synopsis. You may generally pass a list ref of hash refs (or objects) instead of a hash ref - this may result in invalid XML if used improperly, though. Note that SOAP::WSDL always expects list references at maximum depth position. ⚠️

XML attributes are not displayed in this synopsis and cannot be set using hash refs. See the respective class’ documentation for additional information.

GetSupportedRules

List all rules that are supported by the given VideoAnalyticsConfiguration. The result of this method may depend on the overall Video analytics configuration of the device, which is available via the current set of profiles.

Returns a ONVIF::Analytics::Elements::GetSupportedRulesResponse object.

$response = $interface->GetSupportedRules( {
   ConfigurationToken => $some_value, # ReferenceToken
 },,
);

CreateRules

The description line here is literally GetCompatibleVideoAnalyticsConfigurations. — yes, that’s what it says. We’re respecting the source material. 🫡

Returns a ONVIF::Analytics::Elements::CreateRulesResponse object.

$response = $interface->CreateRules( {
   ConfigurationToken => $some_value, # ReferenceToken
   Rule =>  { # ONVIF::Analytics::Types::Config
     Parameters =>  { # ONVIF::Analytics::Types::ItemList
       SimpleItem => ,
       ElementItem =>  {
       },
       Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
       },
     },
   },
 },,
);

DeleteRules

Remove one or more rules from a VideoAnalyticsConfiguration.

Returns a ONVIF::Analytics::Elements::DeleteRulesResponse object.

$response = $interface->DeleteRules( {
   ConfigurationToken => $some_value, # ReferenceToken
   RuleName =>  $some_value, # string
 },,
);

GetRules

List the currently assigned set of rules of a VideoAnalyticsConfiguration.

Returns a ONVIF::Analytics::Elements::GetRulesResponse object.

$response = $interface->GetRules( {
   ConfigurationToken => $some_value, # ReferenceToken
 },,
);

ModifyRules

Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names.

Returns a ONVIF::Analytics::Elements::ModifyRulesResponse object.

$response = $interface->ModifyRules( {
   ConfigurationToken => $some_value, # ReferenceToken
   Rule =>  { # ONVIF::Analytics::Types::Config
     Parameters =>  { # ONVIF::Analytics::Types::ItemList
       SimpleItem => ,
       ElementItem =>  {
       },
       Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
       },
     },
   },
 },,
);

---

💌 AUTHOR 💌

Generated by SOAP::WSDL on Tue Jul 15 19:19:50 2014. A little vintage, a little mysterious, very demure. 🎀

---

okay that’s the whole page, bestie. Cute little footer says perl v5.42.3, date 1980-01-01, and page ONVIF::...ginePort(3) — source/version and date wrapped up with a bow. 💖🎀