.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::RuleEnginePort 3pm"
.TH ONVIF::Analytics::Interfaces::Analytics::RuleEnginePort 3pm 2024-03-12 "perl v5.38.2" "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::RuleEnginePort \- SOAP Interface for the Analytics Web Service
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& 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();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
SOAP Interface for the Analytics web service
located at http://www.examples.com/Analytics/.
.SH "SERVICE Analytics"
.IX Header "SERVICE Analytics"
.SS "Port RuleEnginePort"
.IX Subsection "Port RuleEnginePort"
.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 "SOAP 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 XML if used improperly, though. Note that
SOAP::WSDL always expects list references at maximum depth position.
.PP
XML attributes are not displayed in this synopsis and cannot be set using
hash refs. See the respective class' documentation for additional information.
.PP
\fIGetSupportedRules\fR
.IX Subsection "GetSupportedRules"
.PP
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.
.PP
Returns a ONVIF::Analytics::Elements::GetSupportedRulesResponse object.
.PP
.Vb 4
\& $response = $interface\->GetSupportedRules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&  },,
\& );
.Ve
.PP
\fICreateRules\fR
.IX Subsection "CreateRules"
.PP
GetCompatibleVideoAnalyticsConfigurations.
.PP
Returns a ONVIF::Analytics::Elements::CreateRulesResponse object.
.PP
.Vb 10
\& $response = $interface\->CreateRules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    Rule =>  { # ONVIF::Analytics::Types::Config
\&      Parameters =>  { # ONVIF::Analytics::Types::ItemList
\&        SimpleItem => ,
\&        ElementItem =>  {
\&        },
\&        Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
\&        },
\&      },
\&    },
\&  },,
\& );
.Ve
.PP
\fIDeleteRules\fR
.IX Subsection "DeleteRules"
.PP
Remove one or more rules from a VideoAnalyticsConfiguration.
.PP
Returns a ONVIF::Analytics::Elements::DeleteRulesResponse object.
.PP
.Vb 5
\& $response = $interface\->DeleteRules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    RuleName =>  $some_value, # string
\&  },,
\& );
.Ve
.PP
\fIGetRules\fR
.IX Subsection "GetRules"
.PP
List the currently assigned set of rules of a VideoAnalyticsConfiguration.
.PP
Returns a ONVIF::Analytics::Elements::GetRulesResponse object.
.PP
.Vb 4
\& $response = $interface\->GetRules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&  },,
\& );
.Ve
.PP
\fIModifyRules\fR
.IX Subsection "ModifyRules"
.PP
Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names.
.PP
Returns a ONVIF::Analytics::Elements::ModifyRulesResponse object.
.PP
.Vb 10
\& $response = $interface\->ModifyRules( {
\&    ConfigurationToken => $some_value, # ReferenceToken
\&    Rule =>  { # ONVIF::Analytics::Types::Config
\&      Parameters =>  { # ONVIF::Analytics::Types::ItemList
\&        SimpleItem => ,
\&        ElementItem =>  {
\&        },
\&        Extension =>  { # ONVIF::Analytics::Types::ItemListExtension
\&        },
\&      },
\&    },
\&  },,
\& );
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Generated by SOAP::WSDL on Tue Jul 15 19:19:50 2014