JSDoc: Class: Cam

new Cam(options, callbackopt)

Camera class

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Default
`hostname`	string
`username`	string	<optional>
`password`	string	<optional>
`port`	number	<optional>	80
`path`	string	<optional>	/onvif/device_service
`timeout`	number	<optional>	120000

callback Cam~ConnectionCallback <optional>

Properties:

Name	Type	Description
`presets`

Source:

cam.js, line 68

Fires:

Cam#event:rawRequest
Cam#event:rawResponse
Cam#event:connect
Cam#event:event

Example

var
  http = require('http'),
  Cam = require('onvif').Cam;

new Cam({
  hostname: <CAMERA_HOST>,
  username: <USERNAME>,
  password: <PASSWORD>
}, function(err) {
  this.absoluteMove({x: 1, y: 1, zoom: 1});
  this.getStreamUri({protocol:'RTSP'}, function(err, stream) {
    http.createServer(function (req, res) {
      res.writeHead(200, {'Content-Type': 'text/html'});
      res.end('<html><body>' +
        '<embed type="application/x-vlc-plugin" target="' + stream.uri + '"></embed>' +
        '</body></html>');
    }).listen(3030);
  });
});

Extends

events.EventEmitter

Members

activeSource :Cam~ActiveSource

Current active video source

Type:

Cam~ActiveSource

Source:

cam.js, line 520

activeSources :Array.<Cam~ActiveSource>

Active video sources

Type:

Array.<Cam~ActiveSource>

Source:

cam.js, line 475

capabilities :Cam~Capabilities

Device capabilities

Type:

Cam~Capabilities

Source:

cam.js, line 380

defaultProfile :Cam~Profile

Default selected profile for the device

Type:

Cam~Profile

Source:

cam.js, line 499

defaultProfiles :Array.<Cam~Profile>

Default profiles for the device

Type:

Array.<Cam~Profile>

Source:

cam.js, line 469

events :object

Events namespace for the device, stores all information about device events

Type:

object

Properties:

Name	Type	Description
`properties`	Cam~EventProperties
`subscription`	Cam~CreatePullPointSubscriptionResponse
`terminationTime`	Date	Time when pull-point subscription is over
`messageLimit`	number	Pull message count

Source:

events.js, line 16

profiles :Array.<Cam~Profile>

Array of all device profiles

Type:

Array.<Cam~Profile>

Source:

media.js, line 462

scopes :undefined|Array.<Cam~Scope>

Device scopes

Type:

undefined | Array.<Cam~Scope>

Source:

cam.js, line 672

services :Array.<Cam~Service>

Supported services and their URLs

Type:

Array.<Cam~Service>

Source:

cam.js, line 572

uri

Device service URIs

Properties:

Name	Type	Attributes
`PTZ`	url	<optional>
`media`	url	<optional>
`imaging`	url	<optional>
`events`	url	<optional>
`device`	url	<optional>

Source:

cam.js, line 388

videoSources :Cam~VideoSource|Array.<Cam~VideoSource>

Video sources

Type:

Cam~VideoSource | Array.<Cam~VideoSource>

Source:

media.js, line 39

Methods

absoluteMove(options, callbackopt)

/PTZ/ absolute move

Parameters:

Name Type Attributes Description

options

object

Properties

Name Type Attributes Default Description

profileToken string <optional> Cam#activeSource.profileToken

x number <optional> Pan, float within -1 to 1

y number <optional> Tilt, float within -1 to 1

zoom number <optional> Zoom, float within 0 to 1

speed

object

If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.

Properties

Name	Type	Attributes	Description
`x`	number	<optional>	Pan speed, float within 0 to 1
`y`	number	<optional>	Tilt speed, float within 0 to 1
`zoom`	number	<optional>	Zoom speed, float within 0 to 1

callback Cam~RequestCallback <optional>

Source:

ptz.js, line 319

connect(callback)

Connect to the camera and fill device information properties

Parameters:

Name	Type	Description
`callback`	Cam~ConnectionCallback

Source:

cam.js, line 89

continuousMove(options, callback)

/PTZ/ Operation for continuous Pan/Tilt and Zoom movements

Parameters:

Name Type Description

options

Properties

Name	Type	Attributes	Default	Description
`profileToken`	string	<optional>	Cam#activeSource.profileToken
`x`	number	<optional>	0	pan velocity, float within 0 to 1
`y`	number	<optional>	0	tilt velocity, float within 0 to 1
`zoom`	number	<optional>	0	zoom velocity, float within 0 to 1
`timeout`	number	<optional>	Infinity	timeout in milliseconds

callback Cam~RequestCallback

Source:

ptz.js, line 349

createProfile(options, callback)

Create an empty new deletable media profile

Parameters:

Name Type Description

options

Properties

Name	Type	Attributes	Description
`name`	string		Profile name
`token`	string	<optional>	Profile token

callback Cam~MessageCallback

Source:

media.js, line 484

createPullPointSubscription(callback)

Create pull-point subscription

Parameters:

Name	Type	Description
`callback`	function

Source:

events.js, line 85

deleteProfile(token, callback)

Delete a profile

Parameters:

Name	Type	Description
`token`	string
`callback`	Cam~MessageCallback

Source:

media.js, line 505

getAudioEncoderConfigurations(callback)

Get all available audio encoder configurations of a device

Parameters:

Name	Type	Description
`callback`

Source:

media.js, line 326

getAudioOutputConfigurations(callback)

Get all existing audio output configurations of a device

Parameters:

Name	Type	Description
`callback`

Source:

media.js, line 392

getAudioOutputs(callback)

Get all available audio outputs of a device

Parameters:

Name	Type	Description
`callback`

Source:

media.js, line 370

getAudioSourceConfigurations(callback)

Get all existing audio source configurations of a device

Parameters:

Name	Type	Description
`callback`

Source:

media.js, line 348

getAudioSources(callback)

Get all available physical audio iutputs of a device

Parameters:

Name	Type	Description
`callback`

Source:

media.js, line 304

getCapabilities(callbackopt)

Receive cam capabilities

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetCapabilitiesCallback	<optional>

Source:

cam.js, line 371

getConfigurationOptions(configurationToken, callback)

/PTZ/ Get options for the PTZ configuration

Parameters:

Name	Type	Description
`configurationToken`	string
`callback`	function

Source:

ptz.js, line 180

getConfigurations(callback)

/PTZ/ Get an array with configuration names

Parameters:

Name	Type	Description
`callback`	function

Source:

ptz.js, line 145

getDeviceInformation(callbackopt)

Receive device information

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetDeviceInformationCallback	<optional>

Source:

cam.js, line 600

getEventProperties(callback)

Get event properties of the device. Sets `events` property of the device

Parameters:

Name	Type	Description
`callback`	Cam~GetEventPropertiesCallback

Source:

events.js, line 51

getEventServiceCapabilities(callback)

Get event service capabilities

Parameters:

Name	Type	Description
`callback`	function

Source:

events.js, line 68

getHostname(callbackopt)

Receive hostname information

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetHostnameCallback	<optional>

Source:

cam.js, line 632

getImagingSettings(optionsopt, callback)

Get the ImagingConfiguration for the requested VideoSource (default - the activeSource)

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`token`	string	<optional>	Cam#activeSource.profileToken

callback Cam~GetImagingSettingsCallback

Source:

imaging.js, line 33

getNodes(callback)

/PTZ/ Returns the properties of the requested PTZ node, if it exists. Use this function to get maximum number of presets, ranges of admitted values for x, y, zoom, iris, focus

Parameters:

Name	Type	Description
`callback`	function

Source:

ptz.js, line 123

getNTP(callback)

Receive NTP information from cam

Parameters:

Name	Type	Description
`callback`	Cam~NTPCallback

Source:

device.js, line 30

getPresets(optionsopt, callbackopt)

Receive cam presets

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`profileToken`	string	<optional>

callback <optional>

Source:

ptz.js, line 20

getProfiles(callbackopt)

/Media/ Receive profiles

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetProfilesCallback	<optional>

Source:

media.js, line 454

getScopes(callback)

Receive the scope parameters of a device

Parameters:

Name	Type	Description
`callback`	Cam~getScopesCallback

Source:

cam.js, line 661

getServiceCapabilities(callbackopt)

Returns the capabilities of the device service

Parameters:

Name	Type	Attributes	Description
`callback`		<optional>

Source:

cam.js, line 424

getServices(callbackopt)

Receive services

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetServicesCallback	<optional>

Source:

cam.js, line 561

getSnapshotUri(optionsopt, callbackopt)

Receive snapshot URI

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Description
`profileToken`	string	<optional>

callback Cam~ResponseUriCallback <optional>

Source:

media.js, line 560

getStatus(optionsopt, callback)

/PTZ/ Receive cam status

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`profileToken`	string	<optional>	Cam#activeSource.profileToken

callback Cam~GetPTZStatusCallback

Source:

ptz.js, line 91

getStreamUri(optionsopt, callbackopt)

Receive stream URI

Parameters:

Name Type Attributes Description

options

Object

Properties

Name	Type	Attributes	Description
`stream`	string	<optional>
`protocol`	string	<optional>

callback Cam~ResponseUriCallback <optional>

Source:

media.js, line 532

getSystemDateAndTime(callback)

Receive date and time from cam

Parameters:

Name	Type	Description
`callback`	Cam~DateTimeCallback

Source:

cam.js, line 211

getVideoEncoderConfiguration(tokenopt, callback)

Get existing video encoder configuration by its token If token is omitted tries first from #videoEncoderConfigurations array

Parameters:

Name	Type	Attributes	Description
`token`	string	<optional>	Token of the requested video encoder configuration
`callback`	Cam~VideoEncoderConfigurationCallback

Source:

media.js, line 156

getVideoEncoderConfigurations(callback)

Get all existing video encoder configurations of a device

Parameters:

Name	Type	Description
`callback`	Cam~VideoEncoderConfigurationsCallback

Source:

media.js, line 183

getVideoSourceConfigurations(callbackopt)

Receive video sources

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetVideoSourceConfigurationsCallback	<optional>

Source:

media.js, line 76

getVideoSources(callbackopt)

Receive video sources

Parameters:

Name	Type	Attributes	Description
`callback`	Cam~GetVideoSourcesCallback	<optional>

Source:

media.js, line 31

gotoPreset(options, callback)

/PTZ/ Go to preset

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Description
`profileToken`	string	<optional>
`preset`	string		PresetName from Cam#presets property

callback function

Source:

ptz.js, line 55

pullMessages(options, callback)

Pull messages from pull-point subscription

Parameters:

Name Type Description

options

Properties

Name	Type	Attributes	Default	Description
`timeout`	number	<optional>	30000
`messageLimit`	number	<optional>	1

callback Cam~PullMessagesResponse

Source:

events.js, line 130

Throws:

Cam#events.subscription must exists
Type Error

relativeMove(options, callbackopt)

/PTZ/ relative move

Parameters:

Name Type Attributes Description

options

object

Properties

Name Type Attributes Default Description

profileToken string <optional> Cam#activeSource.profileToken

x number <optional> 0 Pan, float within -1 to 1

y number <optional> 0 Tilt, float within -1 to 1

zoom number <optional> 0 Zoom, float within 0 to 1

speed

object

If the speed argument is omitted, the default speed set by the PTZConfiguration will be used.

Properties

Name	Type	Attributes	Description
`x`	number	<optional>	Pan speed, float within 0 to 1
`y`	number	<optional>	Tilt speed, float within 0 to 1
`zoom`	number	<optional>	Zoom speed, float within 0 to 1

callback Cam~RequestCallback <optional>

Source:

ptz.js, line 286

setImagingSettings(options, callback)

Set the ImagingConfiguration for the requested VideoSource (default - the activeSource)

Parameters:

Name	Type	Description
`options`	Cam~ImagingSetting
`callback`

Source:

imaging.js, line 66

setNTP(options, callbackopt)

Set the NTP settings on a device

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`fromDHCP`	boolean		Indicate if NTP address information is to be retrieved using DHCP
`type`	string	<optional>	Network host type: IPv4, IPv6 or DNS.
`ipv4Address`	string	<optional>	IPv4 address
`ipv6Address`	string	<optional>	IPv6 address
`dnsName`	string	<optional>	DNS name
`extension`	string	<optional>

callback Cam~RequestCallback <optional>

Source:

device.js, line 56

setScopes(scopes, callback)

Set the scope parameters of a device

Parameters:

Name	Type	Description
`scopes`	Array.<string>	array of scope's uris
`callback`	Cam~getScopesCallback

Source:

cam.js, line 690

setSystemDateAndTime(options, callback)

Set the device system date and time

Parameters:

Name Type Description

options

object

Properties

Name	Type	Attributes	Default	Description
`dateTime`	Date	<optional>
`dateTimeType`	string			(Manual \| NTP)
`daylightSavings`	boolean	<optional>	false

callback Cam~DateTimeCallback

Source:

cam.js, line 250

setVideoEncoderConfiguration(options, callback)

Set the device video encoder configuration

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes	Description
`token`	string	<optional>	Token that uniquely references this configuration.

$.token string <optional> Token that uniquely references this configuration.

options.name string <optional> User readable name.

options.useCount number <optional> Number of internal references (read-only)

options.encoding string <optional> ( JPEG | H264 | MPEG4 )

options.resolution

object

Configured video resolution

Properties

Name	Type	Description
`width`	number	Number of the columns of the Video image
`height`	number	Number of the lines of the Video image

options.quality number Relative value for the video quantizers and the quality of the video

options.rateControl

object

Optional element to configure rate control related parameters

Properties

Name	Type	Description
`frameRateLimit`	number	Maximum output framerate in fps
`encodingInterval`	number	Interval at which images are encoded and transmitted (A value of 1 means that every frame is encoded, a value of 2 means that every 2nd frame is encoded ...)
`bitrateLimit`	number	the maximum output bitrate in kbps

options.MPEG4

object

Properties

Name	Type	Description
`govLength`	number	Determines the interval in which the I-Frames will be coded
`profile`	string	the Mpeg4 profile ( SP \| ASP )

options.H264

object

Properties

Name	Type	Description
`govLength`	number	Group of Video frames length
`profile`	string	the H.264 profile ( Baseline \| Main \| Extended \| High )

options.multicast

object

Properties

Name Type Attributes Description

address

object | number

The multicast address (if this address is set to 0 no multicast streaming is enaled)

Properties

Name	Type	Attributes	Description
`type`	string		Indicates if the address is an IPv4 or IPv6 address ( IPv4 \| IPv6)
`IPv4Address`	string	<optional>
`IPv6Address`	string	<optional>

port number <optional> The RTP mutlicast destination port

TTL number <optional>

autoStart boolean <optional>

options.sessionTimeout string

callback Cam~VideoEncoderConfigurationCallback

Source:

media.js, line 234

stop(optionsopt, callbackopt)

Stop ongoing pan, tilt and zoom movements of absolute relative and continuous type

Parameters:

Name Type Attributes Description

options

object

Properties

Name	Type	Attributes
`profileToken`	string	<optional>
`panTilt`	boolean \| string	<optional>
`zoom`	boolean \| string	<optional>

callback Cam~RequestCallback <optional>

Source:

ptz.js, line 377

systemReboot(callback)

/Device/ Reboot the device

Parameters:

Name	Type	Description
`callback`	Cam~MessageCallback

Source:

cam.js, line 710

Type Definitions

ActiveSource

Active source

Type:

object

Properties:

Name Type Attributes Description

sourceToken string video source token

profileToken string profile token

ptz

object

PTZ-object

Properties

Name	Type	Description
`name`	string	PTZ configuration name
`token`	string	PTZ token

Source:

cam.js, line 447

Capabilities

Capability list

Type:

object

Properties:

Name Type Attributes Description

device

object

Device capabilities

Properties

Name Type Attributes Description

XAddr string Device service URI

network

object

Network capabilities

Properties

Name	Type	Description
`IPFilter`	boolean	Indicates support for IP filtering
`zeroConfiguration`	boolean	Indicates support for zeroconf
`IPVersion6`	boolean	Indicates support for IPv6
`dynDNS`	boolean	Indicates support for dynamic DNS configuration

system

object

System capabilities

Properties

Name	Type	Description
`discoveryResolve`	boolean	Indicates support for WS Discovery resolve requests
`discoveryBye`	boolean	Indicates support for WS-Discovery Bye
`remoteDiscovery`	boolean	Indicates support for remote discovery
`systemBackup`	boolean	Indicates support for system backup through MTOM
`systemLogging`	boolean	Indicates support for retrieval of system logging through MTOM
`firmwareUpgrade`	boolean	Indicates support for firmware upgrade through MTOM
`httpFirmwareUpgrade`	boolean	Indicates support for firmware upgrade through HTTP
`httpSystemBackup`	boolean	Indicates support for system backup through HTTP
`httpSystemLogging`	boolean	Indicates support for retrieval of system logging through HTTP

IO

object

I/O capabilities

Properties

Name Type Attributes Description

inputConnectors number Number of input connectors

relayOutputs number Number of relay outputs

extension

object

Properties

Name	Type	Description
`auxiliary`	boolean
`auxiliaryCommands`	object

security

object

Security capabilities

Properties

Name	Type	Description
`'TLS1.1'`	boolean	Indicates support for TLS 1.1
`'TLS1.2'`	boolean	Indicates support for TLS 1.2
`onboardKeyGeneration`	boolean	Indicates support for onboard key generation
`accessPolicyConfig`	boolean	Indicates support for access policy configuration
`'X.509Token'`	boolean	Indicates support for WS-Security X.509 token
`SAMLToken`	boolean	Indicates support for WS-Security SAML token
`kerberosToken`	boolean	Indicates support for WS-Security Kerberos token
`RELToken`	boolean	Indicates support for WS-Security REL token

events

object

Event capabilities

Properties

Name	Type	Description
`XAddr`	string	Event service URI
`WSSubscriptionPolicySupport`	boolean	Indicates whether or not WS Subscription policy is supported
`WSPullPointSupport`	boolean	Indicates whether or not WS Pull Point is supported
`WSPausableSubscriptionManagerInterfaceSupport`	boolean	Indicates whether or not WS Pausable Subscription Manager Interface is supported

imaging

object

Imaging capabilities

Properties

Name	Type	Description
`XAddr`	string	Imaging service URI

media

object

Media capabilities

Properties

Name Type Description

XAddr string Media service URI

streamingCapabilities

object

Streaming capabilities

Properties

Name	Type	Description
`RTPMulticast`	boolean	Indicates whether or not RTP multicast is supported
`RTP_TCP`	boolean	Indicates whether or not RTP over TCP is supported
`RTP_RTSP_TCP`	boolean	Indicates whether or not RTP/RTSP/TCP is supported
`extension`	object

PTZ

object

PTZ capabilities

Properties

Name	Type	Description
`XAddr`	string	PTZ service URI

extension

object

Properties

Name Type Attributes Description

deviceIO

object

DeviceIO capabilities

Properties

Name	Type	Description
`XAddr`	string	DeviceIO service URI
`videoSources`	number
`videoOutputs`	number
`audioSources`	number
`audioOutputs`	number
`relayOutputs`	number

extensions

object

Properties

Name	Type	Attributes	Description
`telexCapabilities`	object	<optional>
`scdlCapabilities`	object	<optional>

Source:

cam.js, line 296

ConnectionCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>

Source:

cam.js, line 24

CreatePullPointSubscriptionResponse

Type:

object

Properties:

Name Type Description

subscriptionReference

object

Properties

Name	Type	Description
`address`	string

currentTime Date

terminationTime Date

Source:

events.js, line 8

DateTimeCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`dateTime`	Date		Date object of current device's dateTime
`xml`	string		Raw SOAP response

Source:

cam.js, line 200

DeviceInformation

Type:

object

Properties:

Name	Type	Description
`manufacturer`	string	The manufactor of the device
`model`	string	The device model
`firmwareVersion`	string	The firmware version in the device
`serialNumber`	string	The serial number of the device
`hardwareId`	string	The hardware ID of the device

Source:

cam.js, line 580

Event

Type:

object

Properties:

Name	Type	Attributes
`currentTime`	Date
`terminationTime`	Date
`notificationMessage`	Cam~NotificationMessage \| Array.<Cam~NotificationMessage>	<optional>

Source:

events.js, line 101

EventProperties

Event properties object

Type:

object

Properties:

Name	Type	Description
`topicNamespaceLocation`	array
`topicSet`	object
`topicExpressionDialect`	array

Source:

events.js, line 32

GetCapabilitiesCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`capabilities`	Cam~Capabilities
`xml`	string		Raw SOAP response

Source:

cam.js, line 360

GetDeviceInformationCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`deviceInformation`	Cam~DeviceInformation		Device information
`xml`	string		Raw SOAP response

Source:

cam.js, line 589

GetEventPropertiesCallback()

Properties:

Name	Type	Attributes	Description
`err`	Error	<nullable>
`response`	Cam~EventProperties
`response`	string		xml

Source:

events.js, line 40

GetHostnameCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`hostnameInformation`	Cam~HostnameInformation		Hostname information
`xml`	string		Raw SOAP response

Source:

cam.js, line 621

GetImagingSettingsCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`status`	Cam~ImagingSettings

Source:

imaging.js, line 21

GetProfilesCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`profiles`	Array.<Cam~Profile>		Array of device's profiles
`xml`	string		Raw XML response

Source:

media.js, line 443

GetPTZStatusCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`status`	Cam~PTZStatus

Source:

ptz.js, line 79

getScopesCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`scopes`	Array.<Cam~Scope>		Scopes
`xml`	string		Raw SOAP response

Source:

cam.js, line 650

GetServicesCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`services`	Array.<Cam~Service>
`xml`	string		Raw SOAP response

Source:

cam.js, line 550

GetVideoSourceConfigurationsCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`videoSourceConfigurations`	Array.<Cam~VideoSourceConfiguration>
`xml`	string		Raw SOAP response

Source:

media.js, line 65

GetVideoSourcesCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`videoSources`	Cam~VideoSource \| Array.<Cam~VideoSource>
`xml`	string		Raw SOAP response

Source:

media.js, line 20

HostnameInformation

Type:

object

Properties:

Name	Type	Attributes	Description
`fromDHCP`	boolean		Indicates whether the hostname is obtained from DHCP or not
`name`	string	<optional>	Indicates the hostname

Source:

cam.js, line 615

ImagingSetting

Type:

object

Properties:

Name	Type	Description
`token`	string	Video source token
`brightness`	number
`colorSaturation`	number
`contrast`	number
`sharpness`	number

Source:

imaging.js, line 52

ImagingSettings

Type:

object

Properties:

Name Type Description

brightness number

colorSaturation number

focus

object

Properties

Name	Type	Description
`autoFocusMode`	string

sharpness number

Source:

imaging.js, line 12

MessageCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`message`	string	<nullable>

Source:

cam.js, line 18

NotificationMessage

Type:

object

Properties:

Name	Type	Description
`subscriptionReference.address`	string	Pull-point address
`topic._`	string	Namespace of message topic
`message`	object	Message object

Source:

events.js, line 108

NTPCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`NTP`	Cam~NTPInformation		information object of current device's NTP manual
`xml`	string		Raw SOAP response

Source:

device.js, line 19

NTPInformation

Type:

object

Properties:

Name	Type	Attributes	Description
`fromDHCP`	boolean		Indicates if NTP information is to be retrieved by using DHCP
`NTPFromDHCP`	object	<optional>	List of NTP addresses retrieved by using DHCP
`NTPManual`	object	<optional>	List of manually entered NTP addresses

Source:

device.js, line 12

Profile

Type:

object

Properties:

Name Type Description

$

object

Properties

Name	Type	Description
`token`	string	profile token
`fixed`	boolean	is this a system or a user profile

videoSourceConfiguration

object

Properties

Name	Type	Description
`$.token`	string	video source token

videoEncoderConfiguration object

PTZConfiguration

object

Properties

Name	Type	Description
`$.token`	string	PTZ token
`name`	string	PTZ configuration name

Source:

media.js, line 430

PTZStatus

Type:

object

Properties:

Name Type Attributes Description

position

object

Properties

Name	Type	Description
`x`	number
`y`	number
`zoom`	number

moveStatus string

error Error <nullable>

utcTime Date

Source:

ptz.js, line 68

PullMessagesResponse()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`response`	Cam~Event		Message
`xml`	string		Raw SOAP response

Source:

events.js, line 115

RequestCallback(err, response, xml)

Parameters:

Name	Type	Description
`err`	Error
`response`	object	message
`xml`	string	response

Source:

cam.js, line 121

ResponseUriCallback()

Properties:

Name	Type	Description
`uri`	string

Source:

media.js, line 520

Scope

Type:

object

Properties:

Name	Type	Description
`scopeDef`	string	Indicates if the scope is fixed or configurable
`scopeItem`	string	Scope item URI

Source:

cam.js, line 644

Service

Type:

object

Properties:

Name	Type	Description
`namespace`	string	Namespace uri
`XAddr`	string	Uri for requests
`version.minor`	number	Minor version
`version.major`	number	Major version

Source:

cam.js, line 542

SystemDateAndTime

Type:

object

Properties:

Name	Type	Description
`dayTimeType`	string	(Manual \| NTP)
`daylightSavings`	boolean
`timezone`	string	in POSIX 1003.1 format
`hour`	number
`minute`	number
`second`	number
`year`	number
`month`	number
`day`	number

Source:

cam.js, line 228

VideoEncoderConfiguration

Type:

object

Properties:

Name Type Attributes Description

$.token string Token that uniquely refernces this configuration

name string User readable name.

useCount string Number of internal references currently using this configuration

encoding string Used video codec ('JPEG' | 'MPEG4' | 'H264' )

resolution

object

Configured video resolution

Properties

Name	Type	Description
`width`	number
`height`	number

quality number Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality

rateControl

object

Optional element to configure rate control related parameters

Properties

Name	Type	Description
`frameRateLimit`	number
`encodingInterval`	number
`bitrateLimit`	number

H264

object

Optional element to configure H.264 related parameters

Properties

Name	Type	Description
`govLength`	number	Group of Video frames length
`H264profile`	string	the H.264 profile

MPEG4

object

Optional element to configure Mpeg4 related parameters

Properties

Name	Type	Description
`govLength`	number	Determines the interval in which the I-Frames will be coded.
`MPEG4profile`	string	the Mpeg4 profile

multicast

object

Properties

Name	Type	Attributes
`address.type`	string
`address.IPv4Address`	string	<optional>
`address.IPv6Address`	string	<optional>
`port`	number
`TTL`	number
`autoStart`	boolean

sessionTimeout string The rtsp session timeout for the related video stream

Source:

media.js, line 106

VideoEncoderConfigurationCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`videoEncoderConfiguration`	Cam~VideoEncoderConfiguration
`xml`	string		Raw SOAP response

Source:

media.js, line 136

VideoEncoderConfigurationsCallback()

Properties:

Name	Type	Attributes	Description
`error`	Error	<nullable>
`videoEncoderConfigurations`	Array.<Cam~VideoEncoderConfiguration>
`xml`	string		Raw SOAP response

Source:

media.js, line 143

VideoSource

Type:

object

Properties:

Name	Type	Description
`$.token`	string	Video source token
`framerate`	number
`resolution.width`	number
`resolution.height`	number

Source:

media.js, line 12

VideoSourceConfiguration

Type:

object

Properties:

Name Type Description

token string Token that uniquely refernces this configuration

sourceToken string Reference to the physical input

name string User readable name

useCount number Number of internal references currently using this configuration

bounds

object

Properties

Name	Type	Description
`height`	number
`width`	number
`x`	number
`y`	number

Source:

media.js, line 52

Events

event

Indicates message from device.

Type:

Cam~NotificationMessage

Source:

events.js, line 205

rawResponse

Indicates raw xml response from device.

Type:

string

Source:

cam.js, line 166