.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort 3pm"
.TH ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort 3pm "2022-09-24" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ONVIF::Analytics::Interfaces::Analytics::AnalyticsEnginePort \- SOAP Interface for the Analytics Web Service
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& 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();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1SOAP\s0 Interface for the Analytics web service
located at http://www.examples.com/Analytics/.
.SH "SERVICE Analytics"
.IX Header "SERVICE Analytics"
.SS "Port AnalyticsEnginePort"
.IX Subsection "Port AnalyticsEnginePort"
.SH "METHODS"
.IX Header "METHODS"
.SS "General methods"
.IX Subsection "General methods"
\fInew\fR
.IX Subsection "new"
.PP
Constructor.
.PP
All arguments are forwarded to SOAP::WSDL::Client.
.SS "\s-1SOAP\s0 Service methods"
.IX Subsection "SOAP Service methods"
Method synopsis is displayed with hash refs as parameters.
.PP
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.
.PP
You may pass any combination of objects, hash and list refs to these
methods, as long as you meet the structure.
.PP
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 \s-1XML\s0 if used improperly, though. Note that
\&\s-1SOAP::WSDL\s0 always expects list references at maximum depth position.
.PP
\&\s-1XML\s0 attributes are not displayed in this synopsis and cannot be set using
hash refs. See the respective class' documentation for additional information.
.PP
\fIGetServiceCapabilities\fR
.IX Subsection "GetServiceCapabilities"
.PP
Returns the capabilities of the analytics service. The result is returned in a typed answer.
.PP
Returns a ONVIF::Analytics::Elements::GetServiceCapabilitiesResponse object.
.PP
.Vb 3
\& $response = $interface\->GetServiceCapabilities( {
\&  },,
\& );
.Ve
.PP
\fIGetSupportedAnalyticsModules\fR
.IX Subsection "GetSupportedAnalyticsModules"
.PP
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.
.PP
Returns a ONVIF::Analytics::Elements::GetSupportedAnalyticsModulesResponse object.
.PP
.Vb 4
\& $response = $interface\->GetSupportedAnalyticsModules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&  },,
\& );
.Ve
.PP
\fICreateAnalyticsModules\fR
.IX Subsection "CreateAnalyticsModules"
.PP
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.
.PP
Returns a ONVIF::Analytics::Elements::CreateAnalyticsModulesResponse object.
.PP
.Vb 10
\& $response = $interface\->CreateAnalyticsModules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    AnalyticsModule =>  { # ONVIF::Analytics::Types::Config
\&      Parameters =>  { # ONVIF::Analytics::Types::ItemList
\&        SimpleItem => ,
\&        ElementItem =>  {
\&        },
\&        Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
\&        },
\&      },
\&    },
\&  },,
\& );
.Ve
.PP
\fIDeleteAnalyticsModules\fR
.IX Subsection "DeleteAnalyticsModules"
.PP
Returns a ONVIF::Analytics::Elements::DeleteAnalyticsModulesResponse object.
.PP
.Vb 5
\& $response = $interface\->DeleteAnalyticsModules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    AnalyticsModuleName =>  $some_value, # string
\&  },,
\& );
.Ve
.PP
\fIGetAnalyticsModules\fR
.IX Subsection "GetAnalyticsModules"
.PP
List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.
.PP
Returns a ONVIF::Analytics::Elements::GetAnalyticsModulesResponse object.
.PP
.Vb 4
\& $response = $interface\->GetAnalyticsModules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&  },,
\& );
.Ve
.PP
\fIModifyAnalyticsModules\fR
.IX Subsection "ModifyAnalyticsModules"
.PP
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.
.PP
Returns a ONVIF::Analytics::Elements::ModifyAnalyticsModulesResponse object.
.PP
.Vb 10
\& $response = $interface\->ModifyAnalyticsModules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    AnalyticsModule =>  { # ONVIF::Analytics::Types::Config
\&      Parameters =>  { # ONVIF::Analytics::Types::ItemList
\&        SimpleItem => ,
\&        ElementItem =>  {
\&        },
\&        Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
\&        },
\&      },
\&    },
\&  },,
\& );
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Generated by \s-1SOAP::WSDL\s0 on Tue Jul 15 19:19:50 2014