ONVIF:...nePort(3pm)

πŸ“¦
version 1.36.37 Β· 5 versions
, in ubuntu resolute, ubuntu stonking

πŸ’– ONVIF:...nePort(3pm) πŸ’–

okay bestie so this is a page from the User Contributed Perl Documentation, and it's literally the manual for ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort. yes that name is a whole paragraph, we don't talk about it πŸ’…. buckle up, we're getting into SOAP.


✨ NAME ✨

ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort β€” it's the SOAP Interface for the Analytics Web Service. that's the whole vibe. no cap.


πŸŽ€ SYNOPSIS πŸŽ€

here's how you actually use this thing, copy-paste friendly fr fr:

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

my $response;
$response = $interface->GetServiceCapabilities();
$response = $interface->GetSupportedAnalyticsModules();
$response = $interface->CreateAnalyticsModules();
$response = $interface->DeleteAnalyticsModules();
$response = $interface->GetAnalyticsModules();
$response = $interface->ModifyAnalyticsModules();

look at her. six whole methods just sitting there waiting for you. main character energy honestly πŸ‘‘


πŸ¦‹ DESCRIPTION πŸ¦‹

so basically: it's a SOAP Interface for the Analytics web service, and the service lives at http://www.examples.com/Analytics/. that's the address, that's the home, that's where it hangs out πŸ’–


🌸 SERVICE Analytics 🌸

πŸ’œ Port AnalyticsEnginePort πŸ’œ

(this is the port. she's the one you're talking to.)


⭐ METHODS ⭐

🫢 General methods 🫢

  • new β€” the constructor, bestie. every single argument you hand it gets forwarded straight to SOAP::WSDL::Client. it's giving "i don't ask questions, i just pass things along" 😌

πŸ”₯ SOAP Service methods πŸ”₯

before we get into the individual methods, there's lore you need to know. read this, it's important:

  • Method synopsis is displayed with hash refs as parameters.
  • 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.
k so the invalid-XML thing is real, don't be reckless. the synopsis is a sketch, not the whole painting πŸ’€

πŸ‘‘ GetServiceCapabilities

Returns the capabilities of the analytics service. The result is returned in a typed answer.

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

$response = $interface->GetServiceCapabilities( {
 },,
);

(yes the ,, is really there. i don't make the rules, i just report them πŸ“)


🌈 GetSupportedAnalyticsModules

List all analytics modules 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::GetSupportedAnalyticsModulesResponse object.

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

πŸ’… CreateAnalyticsModules

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. so like… don't do that πŸ™ˆ

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

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

🧚 DeleteAnalyticsModules

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

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

short and sweet. she knows what she's about πŸ’–


🌸 GetAnalyticsModules

List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.

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

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

✨ ModifyAnalyticsModules

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. (obsessed with the flexibility ngl 🫢)

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

$response = $interface->ModifyAnalyticsModules( {
  ConfigurationToken => $some_value, # ReferenceToken
  AnalyticsModule =>  { # 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. so she's a 2014 baby, vintage if you will πŸ‘‘


and that's the whole page bestie!! before you go: this beauty is running on perl v5.40.1, dated 2026-02-01, and she answers to the name ONVIF:...nePort(3pm). slay, bye πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from