Class ActionEngine

Action Engine service

Example

await cam.connect();
const caps = await cam.actionEngine.getServiceCapabilities();
const supported = await cam.actionEngine.getSupportedActions();
const actions = await cam.actionEngine.getActions();
const triggers = await cam.actionEngine.getActionTriggers();

Hierarchy (View Summary)

default
- ActionEngine

Index

Constructors

constructor

new ActionEngine(onvif: Onvif, service: keyof OnvifServices): ActionEngine
Parameters
- onvif: Onvif
- service: keyof OnvifServices
Returns ActionEngine
Overrides default.constructor
- Defined in actionengine.ts:43

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createActions

createActions(__namedParameters: CreateActions): Promise<Action[]>
Creates one or more actions.
Parameters
- __namedParameters: CreateActions
Returns Promise<Action[]>
- Defined in actionengine.ts:146

createActionTriggers

createActionTriggers(
__namedParameters: CreateActionTriggers,
): Promise<ActionTrigger[]>
Creates one or more action triggers.
Parameters
- __namedParameters: CreateActionTriggers
Returns Promise<ActionTrigger[]>
- Defined in actionengine.ts:191

deleteActions

deleteActions(__namedParameters: DeleteActions): Promise<void>
Deletes one or more actions.
Parameters
- __namedParameters: DeleteActions
Returns Promise<void>
- Defined in actionengine.ts:161

deleteActionTriggers

deleteActionTriggers(__namedParameters: DeleteActionTriggers): Promise<void>
Deletes one or more action triggers.
Parameters
- __namedParameters: DeleteActionTriggers
Returns Promise<void>
- Defined in actionengine.ts:220

getActions

getActions(_options?: GetActions): Promise<Action[]>
Returns the configured actions.
Parameters
- _options: GetActions = {}
Returns Promise<Action[]>
- Defined in actionengine.ts:138

getActionTriggers

getActionTriggers(_options?: GetActionTriggers): Promise<ActionTrigger[]>
Returns the configured action triggers.
Parameters
- _options: GetActionTriggers = {}
Returns Promise<ActionTrigger[]>
- Defined in actionengine.ts:183

getServiceCapabilities

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

Returns Promise<Capabilities>
- Defined in actionengine.ts:116

getSupportedActions

getSupportedActions(_options?: GetSupportedActions): Promise<SupportedActions>
Returns the action types supported by the device.
Parameters
- _options: GetSupportedActions = {}
Returns Promise<SupportedActions>
- Defined in actionengine.ts:127

modifyActions

modifyActions(__namedParameters: ModifyActions): Promise<void>
Modifies one or more actions.
Parameters
- __namedParameters: ModifyActions
Returns Promise<void>
- Defined in actionengine.ts:172

modifyActionTriggers

modifyActionTriggers(__namedParameters: ModifyActionTriggers): Promise<void>
Modifies one or more action triggers.
Parameters
- __namedParameters: ModifyActionTriggers
Returns Promise<void>
- Defined in actionengine.ts:209

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

Class ActionEngine

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ActionEngine

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

createActions

Parameters

Returns Promise<Action[]>

createActionTriggers

Parameters

Returns Promise<ActionTrigger[]>

deleteActions

Parameters

Returns Promise<void>

deleteActionTriggers

Parameters

Returns Promise<void>

getActions

Parameters

Returns Promise<Action[]>

getActionTriggers

Parameters

Returns Promise<ActionTrigger[]>

getServiceCapabilities

Returns Promise<Capabilities>

getSupportedActions

Parameters

Returns Promise<SupportedActions>

modifyActions

Parameters

Returns Promise<void>

modifyActionTriggers

Parameters

Returns Promise<void>

request

Parameters

Returns Promise<any>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns