Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ONVIF::AnalyticONVIF::UseryContributedfPerl:DocumentationnalyticsEnginePort(3)

NAME
       ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort - SOAP
       Interface for the Analytics Web Service

SYNOPSIS
	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();

DESCRIPTION
       SOAP Interface for the Analytics	web service located at
       http://www.examples.com/Analytics/.

SERVICE	Analytics
   Port	AnalyticsEnginePort
METHODS
   General methods
       new

       Constructor.

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

   SOAP	Service	methods
       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.

       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(	{
	 },,
	);

       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.

       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
	 },,
	);

       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.

       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

perl v5.24.1   ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort(3)

NAME | SYNOPSIS | DESCRIPTION | SERVICE Analytics | METHODS | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help