Type Definitions
AnalyticsModule-xml
Type:
Properties:
| Name |
Type |
Description |
AnalyticsModule |
object
|
This object must be XML.
Properties
| Name |
Type |
Description |
Name |
string
|
Name of the configuration. |
Type |
string
|
The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command. |
Parameters |
array
|
List of configuration parameters as defined in the corresponding description.
Properties
| Name |
Type |
Attributes |
Description |
SimpleItem |
object
|
<optional>
|
Value name pair as defined by the corresponding description.
Properties
| Name |
Type |
Description |
Name |
string
|
Item name. |
Value |
string
|
Item value. The type is defined in the corresponding description. |
|
ElementItem |
object
|
<optional>
|
Complex value structure.
Properties
| Name |
Type |
Description |
Name |
string
|
Item name. |
|
Extension |
object
|
<optional>
|
ItemListExtension |
|
|
- Source:
callback(error, data)
All ONVIF API functions return a Promise, unless an optional callback is supplied.
Parameters:
| Name |
Type |
Description |
error |
Error
|
The error object.
Properties
| Name |
Type |
Description |
message |
string
|
The error message. |
soap |
xml
|
Associated SOAP xml that is cause of the error. |
fault |
object
|
Fault information
Properties
| Name |
Type |
Description |
reason |
string
|
Reason for the error. |
code |
string
|
Code for the error. |
detail |
string
|
Details of the error. |
|
|
data |
data
|
The returned data when there is no error. |
- Source:
Rule-xml
Type:
Properties:
| Name |
Type |
Description |
Rule |
object
|
This object must be XML.
Properties
| Name |
Type |
Description |
Name |
string
|
Name of the configuration. |
Type |
string
|
The Type attribute specifies the type of rule and shall be equal to value of one of Name attributes of ConfigDescription elements returned by GetSupportedRules and GetSupportedAnalyticsModules command. |
Parameters |
array
|
List of configuration parameters as defined in the corresponding description.
Properties
| Name |
Type |
Attributes |
Description |
SimpleItem |
object
|
<optional>
|
Value name pair as defined by the corresponding description.
Properties
| Name |
Type |
Description |
Name |
string
|
Item name. |
Value |
string
|
Item value. The type is defined in the corresponding description. |
|
ElementItem |
object
|
<optional>
|
Complex value structure.
Properties
| Name |
Type |
Description |
Name |
string
|
Item name. |
|
Extension |
object
|
<optional>
|
ItemListExtension |
|
|
- Source: