Class Analytics

Analytics service

Hierarchy (View Summary)

default
- Analytics

Constructors

constructor

new Analytics(onvif: Onvif, service: keyof OnvifServices): Analytics
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns Analytics
Overrides default.constructor
- Defined in analytics.ts:35

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createAnalyticsModules

createAnalyticsModules(options: CreateAnalyticsModules): Promise<void>
Creates analytics modules on a video analytics configuration.
Parameters
- options: CreateAnalyticsModules
Returns Promise<void>
- Defined in analytics.ts:174

createRules

createRules(options: CreateRules): Promise<void>
Creates one or more rules on a video analytics configuration.
Parameters
- options: CreateRules
Returns Promise<void>
- Defined in analytics.ts:84

deleteAnalyticsModules

deleteAnalyticsModules(options: DeleteAnalyticsModules): Promise<void>
Deletes analytics modules from a video analytics configuration.
Parameters
- options: DeleteAnalyticsModules
Returns Promise<void>
- Defined in analytics.ts:187

deleteRules

deleteRules(options: DeleteRules): Promise<void>
Deletes rules from a video analytics configuration.
Parameters
- options: DeleteRules
Returns Promise<void>
- Defined in analytics.ts:97

getAnalyticsModuleOptions

getAnalyticsModuleOptions(
options: GetAnalyticsModuleOptions,
): Promise<ConfigOptions[]>
Returns options for a supported analytics module type.
Parameters
- options: GetAnalyticsModuleOptions
Returns Promise<ConfigOptions[]>
- Defined in analytics.ts:229

getAnalyticsModules

getAnalyticsModules(options: GetAnalyticsModules): Promise<Config[]>
Returns analytics modules configured on a video analytics configuration.
Parameters
- options: GetAnalyticsModules
Returns Promise<Config[]>
- Defined in analytics.ts:200

getRuleOptions

getRuleOptions(options: GetRuleOptions): Promise<ConfigOptions[]>
Returns options for a supported rule type.
Parameters
- options: GetRuleOptions
Returns Promise<ConfigOptions[]>
- Defined in analytics.ts:139

getRules

getRules(options: GetRules): Promise<Config[]>
Returns the rules configured on a video analytics configuration.
Parameters
- options: GetRules
Returns Promise<Config[]>
- Defined in analytics.ts:123

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the analytics service.

Returns Promise<Capabilities>
- Defined in analytics.ts:57

getSupportedAnalyticsModules

getSupportedAnalyticsModules(
options: GetSupportedAnalyticsModules,
): Promise<SupportedAnalyticsModules>
Returns the types of analytics modules supported by the device.
Parameters
- options: GetSupportedAnalyticsModules
Returns Promise<SupportedAnalyticsModules>
- Defined in analytics.ts:156

getSupportedMetadata

getSupportedMetadata(options?: GetSupportedMetadata): Promise<MetadataInfo[]>
Returns sample metadata produced by analytics modules.
Parameters
- options: GetSupportedMetadata = {}
Returns Promise<MetadataInfo[]>
- Defined in analytics.ts:246

getSupportedRules

getSupportedRules(options: GetSupportedRules): Promise<SupportedRules>
Returns the types of rules supported by the device for a video analytics configuration.
Parameters
- options: GetSupportedRules
Returns Promise<SupportedRules>
- Defined in analytics.ts:68

modifyAnalyticsModules

modifyAnalyticsModules(options: ModifyAnalyticsModules): Promise<void>
Modifies analytics modules on a video analytics configuration.
Parameters
- options: ModifyAnalyticsModules
Returns Promise<void>
- Defined in analytics.ts:216

modifyRules

modifyRules(options: ModifyRules): Promise<void>
Modifies rules on a video analytics configuration.
Parameters
- options: ModifyRules
Returns Promise<void>
- Defined in analytics.ts:110

request

request(query: Record<string, any>, options?: LineraseOptions): Promise<any>
Parameters
- query: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<any>
Inherited from default.request
- Defined in service.ts:37