Class Onvif

Hierarchy

EventEmitter<OnvifEvents>
- Onvif

Constructors

constructor

new Onvif(options: OnvifOptions): Onvif
Parameters
- options: OnvifOptions
Returns Onvif
Overrides EventEmitter<OnvifEvents>.constructor
- Defined in onvif.ts:396

Properties

`Readonly`actionEngine

actionEngine: ActionEngine

ActionEngine namespace for actionengine v1.0 methods

Example

const actionEngine = await onvif.actionEngine.getActionEngineConfiguration();
console.log(actionEngine);

`Optional`activeSource

activeSource?: ActiveSource

agent

agent: boolean | Agent | Agent

`Readonly`analytics

analytics: Analytics

Analytics namespace for analytics v1.0 methods

Example

const analytics = await onvif.analytics.getAnalyticsConfiguration();
console.log(analytics);

capabilities

capabilities: Capabilities

`Optional`defaultProfile

defaultProfile?: Profile

defaultProfiles

defaultProfiles: Profile[] = []

`Readonly`device

device: Device

Core device namespace for device v1.0 methods

Example

const date = await onvif.device.getSystemDateAndTime();
console.log(date.toLocaleString());

`Optional`deviceInformation

deviceInformation?: GetDeviceInformationResponse

`Readonly`deviceIO

deviceIO: DeviceIO

DeviceIO namespace for deviceio v1.0 methods

Example

const deviceIO = await onvif.deviceIO.getDeviceIOConfiguration();
console.log(deviceIO);

`Readonly`display

display: Display

Display namespace for display v1.0 methods

Example

const display = await onvif.display.getDisplayConfiguration();
console.log(display);

`Readonly`doorControl

doorControl: DoorControl

DoorControl namespace for doorcontrol v1.0 methods

Example

const doorControl = await onvif.doorControl.getDoorControlConfiguration();
console.log(doorControl);

`Readonly`events

events: Events

Events namespace for events v1.0 methods

Example

onvif.on('event', (msg) => { console.log('-> request was', xml); });

hostname

hostname: string

Hostname of the ONVIF device

`Readonly`imaging

imaging: Imaging

Imaging namespace for imaging v1.0 methods

Example

const imaging = await onvif.imaging.getImagingSettings();
console.log(imaging);

`Readonly`media

media: Media

Media namespace for media v1.0 methods

Example

const profiles = await onvif.media.getProfiles();
console.log(profiles);

`Readonly`media2

media2: Media2

Media2 namespace for media2 v1.0 methods

Example

const profiles = await onvif.media2.getProfiles();
console.log(profiles);

`Optional`password

password?: string

Password for the connection

path

path: string

Path for the connection

port

port: number

Port for the connection

preserveAddress

preserveAddress: boolean = false

`Readonly`ptz

ptz: PTZ

PTZ namespace for ptz v1.0 methods

Example

const ptz = await onvif.ptz.getPTZStatus();
console.log(ptz);

`Readonly`recording

recording: Recording

Recording namespace for recording v1.0 methods

Example

const recording = await onvif.recording.getRecordingConfiguration();
console.log(recording);

`Readonly`replay

replay: Replay

Replay namespace for replay v1.0 methods

Example

const replay = await onvif.replay.getReplayConfiguration();
console.log(replay);

secureOptions

secureOptions: SecureContextOptions

Secure options for the connection

timeout

timeout: number

uri

uri: OnvifServices

`Optional` `Readonly`urn

urn?: string

`Optional`username

username?: string

Username for the connection

`Readonly`useSecure

useSecure: boolean

Indicates if the device is using secure connection

useWSSecurity

useWSSecurity: boolean

Use WS-Security for the connection (this is the default and adds security headers in the SOAP messages)

Methods

connect

connect(): Promise<Onvif>
Connect to the camera and fill device information properties

Returns Promise<Onvif>
- Defined in onvif.ts:935

envelopeBody

envelopeBody(): { _: string; $: { "xmlns:xsd": string; "xmlns:xsi": string } }
Returns { _: string; $: { "xmlns:xsd": string; "xmlns:xsi": string } }
- Defined in onvif.ts:448

getOnlySystemDateAndTime

getOnlySystemDateAndTime(): Promise<Date>
Receive only date and time from cam (old behaviour, returns only Date object)

Returns Promise<Date>
- Defined in onvif.ts:765

getSystemDateAndTime

getSystemDateAndTime(): Promise<SystemDateTimeExtended>
Receive date and time from cam

Returns Promise<SystemDateTimeExtended>
- Defined in onvif.ts:731

request

request(options: OnvifRequestOptions): Promise<[Record<string, any>, string]>
Parameters
- options: OnvifRequestOptions
Returns Promise<[Record<string, any>, string]>
- Defined in onvif.ts:668

setSystemDateAndTime

setSystemDateAndTime(
options: SetSystemDateAndTimeExtended,
): Promise<SystemDateTimeExtended>
Set the device system date and time Supports two possible date and time values: UTCDateTime(ONVIF types) or dateTime(js Date-object, preferred)
Parameters
- options: SetSystemDateAndTimeExtended
Returns Promise<SystemDateTimeExtended>
- Defined in onvif.ts:805

Events

`Static` `Readonly`CONNECT

CONNECT: "connect" = 'connect'

Indicates successfully connection connect

Example

onvif.on('connect', () => console.log('connected!'));

`Static` `Readonly`ERROR

ERROR: "error" = 'error'

Indicates any errors except events errors error

Example

onvif.on('error', console.error);

`Static` `Readonly`EVENT

EVENT: "event" = 'event'

Indicates any event from Onvif device. event

Example

onvif.on('event', (msg) => { console.log('-> request was', xml); });

`Static` `Readonly`EVENTS_ERROR

EVENTS_ERROR: "eventsError" = 'eventsError'

Indicates events errors eventsError

Example

onvif.on('eventsError', console.error);

`Static` `Readonly`RAW_REQUEST

RAW_REQUEST: "rawRequest" = 'rawRequest'

Indicates raw xml request to device. rawRequest

Example

onvif.on('rawRequest', (xml) => { console.log('-> request was', xml); });

`Static` `Readonly`RAW_RESPONSE

RAW_RESPONSE: "rawResponse" = 'rawResponse'

Indicates raw xml response from device. rawResponse

Example

onvif.on('rawResponse', (xml) => { console.log('<- response was', xml); });

`Static` `Readonly`REQUEST_BODY

REQUEST_BODY: "requestBody" = 'requestBody'

Shows body of request

`Static` `Readonly`WARN

WARN: "warn" = 'warn'

Indicates any warnings warn

Example

onvif.on('warn', console.warn);

Class Onvif

Hierarchy

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Returns Onvif

Properties

ReadonlyactionEngine

Example

OptionalactiveSource

agent

Readonlyanalytics

Example

capabilities

OptionaldefaultProfile

defaultProfiles

Readonlydevice

Example

OptionaldeviceInformation

ReadonlydeviceIO

Example

Readonlydisplay

Example

ReadonlydoorControl

Example

Readonlyevents

Example

hostname

Readonlyimaging

Example

Readonlymedia

Example

Readonlymedia2

Example

Optionalpassword

path

port

preserveAddress

Readonlyptz

Example

Readonlyrecording

Example

Readonlyreplay

Example

secureOptions

timeout

uri

Optional Readonlyurn

Optionalusername

ReadonlyuseSecure

useWSSecurity

Methods

connect

Returns Promise<Onvif>

envelopeBody

Returns { _: string; $: { "xmlns:xsd": string; "xmlns:xsi": string } }

getOnlySystemDateAndTime

Returns Promise<Date>

getSystemDateAndTime

Returns Promise<SystemDateTimeExtended>

request

Parameters

Returns Promise<[Record<string, any>, string]>

setSystemDateAndTime

Parameters

Returns Promise<SystemDateTimeExtended>

Events

Static ReadonlyCONNECT

Example

Static ReadonlyERROR

Example

Static ReadonlyEVENT

Example

Static ReadonlyEVENTS_ERROR

Example

`Readonly`actionEngine

`Optional`activeSource

`Readonly`analytics

`Optional`defaultProfile

`Readonly`device

`Optional`deviceInformation

`Readonly`deviceIO

`Readonly`display

`Readonly`doorControl

`Readonly`events

`Readonly`imaging

`Readonly`media

`Readonly`media2

`Optional`password

`Readonly`ptz

`Readonly`recording

`Readonly`replay

`Optional` `Readonly`urn

`Optional`username

`Readonly`useSecure

`Static` `Readonly`CONNECT

`Static` `Readonly`ERROR

`Static` `Readonly`EVENT

`Static` `Readonly`EVENTS_ERROR

`Static` `Readonly`RAW_REQUEST

`Static` `Readonly`RAW_RESPONSE

`Static` `Readonly`REQUEST_BODY

`Static` `Readonly`WARN