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:543

Properties

`Readonly`accessControl

accessControl: AccessControl

AccessControl namespace for accesscontrol v1.0 methods

Example

const list = await onvif.accessControl.getAccessPointInfoList();
console.log(list);

`Readonly`accessRules

accessRules: AccessRules

AccessRules namespace for accessrules v1.0 methods

Example

const list = await onvif.accessRules.getAccessProfileInfoList();
console.log(list);

`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

activeSources

activeSources: ActiveSource[] = []

`Readonly`advancedSecurity

advancedSecurity: AdvancedSecurity

AdvancedSecurity namespace for advancedsecurity v1.0 methods

Example

const caps = await onvif.advancedSecurity.getServiceCapabilities();
console.log(caps);

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);

`Readonly`analyticsDevice

analyticsDevice: AnalyticsDevice

AnalyticsDevice namespace for analytics device v1.0 methods

Example

const controls = await onvif.analyticsDevice.getAnalyticsEngineControls();
console.log(controls);

capabilities

capabilities: Capabilities

`Readonly`credential

credential: Credential

Credential namespace for credential v1.0 methods

Example

const list = await onvif.credential.getCredentialInfoList();
console.log(list);

`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);

`Optional`lastResponseXml

lastResponseXml?: string

Raw SOAP XML from the most recent Onvif.request. Used by the v0.x compatibility layer for the third callback argument.

`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);

media2Support

media2Support: boolean = false

Set during connect when the device advertises ONVIF Media2 (Profile T).

`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

profiles

profiles: Profile[] = []

Media1 profiles filled during connect (also copied onto Media when that module loads).

`Readonly`provisioning

provisioning: Provisioning

Provisioning namespace for provisioning v1.0 methods

Example

const caps = await onvif.provisioning.getServiceCapabilities();
console.log(caps);

`Readonly`ptz

ptz: PTZ

PTZ namespace for ptz v1.0 methods

Example

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

`Readonly`receiver

receiver: Receiver

Receiver namespace for receiver v1.0 methods

Example

const receivers = await onvif.receiver.getReceivers();
console.log(receivers);

`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);

`Readonly`schedule

schedule: Schedule

Schedule namespace for schedule v1.0 methods

Example

const list = await onvif.schedule.getScheduleInfoList();
console.log(list);

`Readonly`search

search: Search

Search namespace for search v1.0 methods

Example

const summary = await onvif.search.getRecordingSummary();
console.log(summary);

secureOptions

secureOptions: ConnectionOptions

Secure options for the connection

services

services: Service[] = []

Filled by connect Device.getServices without loading the full Device module.

`Readonly`thermal

thermal: Thermal

Thermal namespace for thermal v1.0 methods

Example

const thermal = await onvif.thermal.getConfigurations();
console.log(thermal);

timeout

timeout: number

`Optional`timeShift

timeShift?: number

Clock offset between the device and this host (ms), set during time sync.

uri

uri: OnvifServices

`Optional` `Readonly`urn

urn?: string

`Optional`username

username?: string

Username for the connection

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)

videoSources

videoSources: VideoSource[] = []

Media1 video sources filled during connect.

`Optional`xaddrs

xaddrs?: URL[]

All XAddrs from WS-Discovery when this instance was found via Discovery.

Methods

connect

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

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

digestAuth

digestAuth(digestHeadersArray: string[], requestOptions: RequestOptions): string
Build Digest Authorization header. Prefers SHA-256 when both MD5 and SHA-256 challenges are present. Public for v0.x Cam compatibility (digestAuth).
Parameters
- digestHeadersArray: string[]
- requestOptions: RequestOptions
Returns string
- Defined in onvif.ts:819

envelopeBody

envelopeBody(
body: Record<string, any>,
): { $: { "xmlns:xsd": string; "xmlns:xsi": string } }
Parameters
- body: Record<string, any>
Returns { $: { "xmlns:xsd": string; "xmlns:xsi": string } }
- Defined in onvif.ts:608

getActiveSources

getActiveSources(): Promise<void>
Check and find out video configuration for device

Returns Promise<void>
- Defined in onvif.ts:1104

getOnlySystemDateAndTime

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

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

getSystemDateAndTime

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

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

request

request(options: OnvifRequestOptions): OnvifResponse
Parameters
- options: OnvifRequestOptions
Returns OnvifResponse
- Defined in onvif.ts:895

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:1042

updateNC

updateNC(): string
Increment Digest auth nonce count and return the padded nc value. Public for v0.x Cam compatibility (updateNC).

Returns string
- Defined in onvif.ts:934

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(new Date().toLocaleTimeString(), 'new event', msg); });

`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

ReadonlyaccessControl

Example

ReadonlyaccessRules

Example

ReadonlyactionEngine

Example

OptionalactiveSource

activeSources

ReadonlyadvancedSecurity

Example

agent

Readonlyanalytics

Example

ReadonlyanalyticsDevice

Example

capabilities

Readonlycredential

Example

OptionaldefaultProfile

defaultProfiles

Readonlydevice

Example

OptionaldeviceInformation

ReadonlydeviceIO

Example

Readonlydisplay

Example

ReadonlydoorControl

Example

Readonlyevents

Example

hostname

Readonlyimaging

Example

OptionallastResponseXml

Readonlymedia

Example

Readonlymedia2

Example

media2Support

Optionalpassword

path

port

preserveAddress

profiles

Readonlyprovisioning

Example

Readonlyptz

Example

Readonlyreceiver

Example

Readonlyrecording

Example

Readonlyreplay

Example

Readonlyschedule

Example

Readonlysearch

Example

secureOptions

services

Readonlythermal

Example

timeout

OptionaltimeShift

uri

Optional Readonlyurn

Optionalusername

`Readonly`accessControl

`Readonly`accessRules

`Readonly`actionEngine

`Optional`activeSource

`Readonly`advancedSecurity

`Readonly`analytics

`Readonly`analyticsDevice

`Readonly`credential

`Optional`defaultProfile

`Readonly`device

`Optional`deviceInformation

`Readonly`deviceIO

`Readonly`display

`Readonly`doorControl

`Readonly`events

`Readonly`imaging

`Optional`lastResponseXml

`Readonly`media

`Readonly`media2

`Optional`password

`Readonly`provisioning

`Readonly`ptz

`Readonly`receiver

`Readonly`recording

`Readonly`replay

`Readonly`schedule

`Readonly`search

`Readonly`thermal

`Optional`timeShift

`Optional` `Readonly`urn

`Optional`username

`Optional`xaddrs

`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