Class AnalyticsDevice

Analytics Device service

Hierarchy (View Summary)

default
- AnalyticsDevice

Constructors

constructor

new AnalyticsDevice(onvif: Onvif): AnalyticsDevice
Parameters
- onvif: Onvif
Returns AnalyticsDevice
Overrides default.constructor
- Defined in analyticsdevice.ts:47

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createAnalyticsEngineControl

createAnalyticsEngineControl(
options: CreateAnalyticsEngineControl,
): Promise<AnalyticsEngineInput[]>
Creates an analytics engine control configuration.
Parameters
- options: CreateAnalyticsEngineControl
Returns Promise<AnalyticsEngineInput[]>
- Defined in analyticsdevice.ts:256

createAnalyticsEngineInputs

createAnalyticsEngineInputs(
options: CreateAnalyticsEngineInputs,
): Promise<AnalyticsEngineInput[]>
Creates analytics engine input configurations.
Parameters
- options: CreateAnalyticsEngineInputs
Returns Promise<AnalyticsEngineInput[]>
- Defined in analyticsdevice.ts:236

deleteAnalyticsEngineControl

deleteAnalyticsEngineControl(
options: DeleteAnalyticsEngineControl,
): Promise<void>
Deletes an analytics engine control configuration.
Parameters
- options: DeleteAnalyticsEngineControl
Returns Promise<void>
- Defined in analyticsdevice.ts:224

deleteAnalyticsEngineInputs

deleteAnalyticsEngineInputs(options: DeleteAnalyticsEngineInputs): Promise<void>
Deletes analytics engine input configurations.
Parameters
- options: DeleteAnalyticsEngineInputs
Returns Promise<void>
- Defined in analyticsdevice.ts:409

getAnalyticsDeviceStreamUri

getAnalyticsDeviceStreamUri(
options: GetAnalyticsDeviceStreamUri,
): Promise<string>
Requests a URI for an analytics device stream.
Parameters
- options: GetAnalyticsDeviceStreamUri
Returns Promise<string>
- Defined in analyticsdevice.ts:377

getAnalyticsEngine

getAnalyticsEngine(options: GetAnalyticsEngine): Promise<AnalyticsEngine>
Returns an analytics engine configuration.
Parameters
- options: GetAnalyticsEngine
Returns Promise<AnalyticsEngine>
- Defined in analyticsdevice.ts:306

getAnalyticsEngineControl

getAnalyticsEngineControl(
options: GetAnalyticsEngineControl,
): Promise<AnalyticsEngineControl>
Returns an analytics engine control configuration.
Parameters
- options: GetAnalyticsEngineControl
Returns Promise<AnalyticsEngineControl>
- Defined in analyticsdevice.ts:285

getAnalyticsEngineControls

getAnalyticsEngineControls(): Promise<AnalyticsEngineControl[]>
Returns all analytics engine control configurations.

Returns Promise<AnalyticsEngineControl[]>
- Defined in analyticsdevice.ts:297

getAnalyticsEngineInput

getAnalyticsEngineInput(
options: GetAnalyticsEngineInput,
): Promise<AnalyticsEngineInput>
Returns an analytics engine input configuration.
Parameters
- options: GetAnalyticsEngineInput
Returns Promise<AnalyticsEngineInput>
- Defined in analyticsdevice.ts:356

getAnalyticsEngineInputs

getAnalyticsEngineInputs(): Promise<AnalyticsEngineInput[]>
Returns all analytics engine input configurations.

Returns Promise<AnalyticsEngineInput[]>
- Defined in analyticsdevice.ts:368

getAnalyticsEngines

getAnalyticsEngines(): Promise<AnalyticsEngine[]>
Returns all analytics engine configurations.

Returns Promise<AnalyticsEngine[]>
- Defined in analyticsdevice.ts:318

getAnalyticsState

getAnalyticsState(
options: GetAnalyticsState,
): Promise<AnalyticsStateInformation>
Returns the state of an analytics engine control.
Parameters
- options: GetAnalyticsState
Returns Promise<AnalyticsStateInformation>
- Defined in analyticsdevice.ts:421

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in analyticsdevice.ts:213

getVideoAnalyticsConfiguration

getVideoAnalyticsConfiguration(
options: GetVideoAnalyticsConfiguration,
): Promise<VideoAnalyticsConfiguration>
Returns a video analytics configuration.
Parameters
- options: GetVideoAnalyticsConfiguration
Returns Promise<VideoAnalyticsConfiguration>
- Defined in analyticsdevice.ts:394

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from default.request
- Defined in service.ts:49

setAnalyticsEngineControl

setAnalyticsEngineControl(options: SetAnalyticsEngineControl): Promise<void>
Modifies an analytics engine control configuration.
Parameters
- options: SetAnalyticsEngineControl
Returns Promise<void>
- Defined in analyticsdevice.ts:272

setAnalyticsEngineInput

setAnalyticsEngineInput(options: SetAnalyticsEngineInput): Promise<void>
Modifies an analytics engine input configuration.
Parameters
- options: SetAnalyticsEngineInput
Returns Promise<void>
- Defined in analyticsdevice.ts:343

setVideoAnalyticsConfiguration

setVideoAnalyticsConfiguration(
options: SetVideoAnalyticsConfiguration,
): Promise<void>
Modifies a video analytics configuration.
Parameters
- options: SetVideoAnalyticsConfiguration
Returns Promise<void>
- Defined in analyticsdevice.ts:327