Class: Cam

Cam(options, callbackopt)

new Cam(options, callbackopt)

Camera class
Parameters:
Name Type Attributes Description
options Cam~Options
callback Cam~ConnectionCallback <optional>
Properties:
Name Type Description
presets
Source:
Fires:
Example
var
  http = require('http'),
  Cam = require('onvif').Cam;

new Cam({
  useSecure: <IS_SECURE>,
  secureOpts: {...<SECURE_OPTIONS>}
  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:
Source:

activeSources :Array.<Cam~ActiveSource>

Active video sources
Type:
Source:

capabilities :Cam~Capabilities

Device capabilities
Type:
Source:

defaultProfile :Cam~Profile

Default selected profile for the device
Type:
Source:

defaultProfiles :Array.<Cam~Profile>

Default profiles for the device
Type:
Source:

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:

preserveAddress :boolean

Force using hostname and port from constructor for the services
Type:
  • boolean
Source:

profiles :Array.<Cam~Profile>

Array of all device profiles
Type:
Source:

profiles :Array.<Cam~Profile>

Array of all device profiles
Type:
Source:

recordingItem :Cam~RecordingItem|Array.<Cam~RecordingItem>

Recording Item
Type:
Source:

recordingJobItems :Cam~RecordingJobItem|Array.<Cam~RecordingJobItem>

Recording Job Items
Type:
  • Cam~RecordingJobItem | Array.<Cam~RecordingJobItem>
Source:

scopes :undefined|Array.<Cam~Scope>

Device scopes
Type:
Source:

services :Array.<Cam~Service>

Device services
Type:
Source:

uri

Device service URIs
Properties:
Name Type Attributes Description
PTZ url <optional>
media url <optional>
imaging url <optional>
events url <optional>
device url <optional>
Source:

uri

Device service URIs
Properties:
Name Type Attributes Description
PTZ url <optional>
media url <optional>
media2 url <optional>
imaging url <optional>
events url <optional>
device url <optional>
Source:

useWSSecurity :boolean

Use WS-Security SOAP header
Type:
  • boolean
Source:

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

Video sources
Type:
Source:

xaddrs :Array.<Url>

All available XAddr fields from discovery
Type:
  • Array.<Url>
Source:

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

addAudioEncoderConfiguration(options, callback)

This operation adds an AudioEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile.
Parameters:
Name Type Description
options object
Properties
Name Type Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the AudioSourceConfiguration to add
callback Cam~AddAudioEncoderConfigurationCallback
Source:

addAudioSourceConfiguration(options, callback)

This operation adds an AudioSourceConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent.
Parameters:
Name Type Description
options object
Properties
Name Type Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the AudioSourceConfiguration to add
callback Cam~AddAudioSourceConfigurationCallback
Source:

addVideoEncoderConfiguration(options, callback)

This operation adds a VideoEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible VideoEncoderConfiguration to a Profile containing a VideoSourceConfiguration and shall support streaming video data of such a profile.
Parameters:
Name Type Description
options object
Properties
Name Type Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the VideoEncoderConfiguration to add
callback Cam~AddVideoEncoderConfigurationCallback
Source:

addVideoSourceConfiguration(options, callback)

This operation adds a VideoSourceConfiguration to an existing media profile. If such a configuration exists in the media profile, it will be replaced. The change shall be persistent.
Parameters:
Name Type Description
options object
Properties
Name Type Description
profileToken string Reference to the profile where the configuration should be added
configurationToken string Contains a reference to the VideoSourceConfiguration to add
callback Cam~AddVideoSourceConfigurationCallback
Source:

connect(callback)

Connect to the camera and fill device information properties
Parameters:
Name Type Description
callback Cam~ConnectionCallback
Source:

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 -1 to 1
y number <optional>
 0 tilt velocity, float within -1 to 1
zoom number <optional>
 0 zoom velocity, float within -1 to 1
onlySendPanTilt boolean <optional>
 Only send the Pan and Tilt values in the ONVIF XML. Zoom not sent in the XML
onlySendZoom boolean <optional>
 Only send the Zoom values in the ONVIF XML. PanTilt not sent in the XML Somy cameras do not accept X and Y and Zoom all at the same time
timeout number <optional>
 Infinity timeout in milliseconds
callback Cam~RequestCallback
Source:

createOSD(optionsopt, callback)

CreateOSD ONVIF can handle custom positons, date/time, text, font sizes, transparency, images etc. Support - Plain Text, DateAndTime, Font size and Font color.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
videoSourceConfigurationToken string <optional>
 Token of the Video Source Configuration, which has associated OSDs. Defaults to Active Source
position object | string <optional>
 String options: UpperLeft, UpperRight, LowerLeft or LowerRight. Default LowerLeft. Or an object with x and y position
Properties
Name Type Attributes Description
x number <optional>
 x position of OSD, range: -1 to 1, counting from left to right
y number <optional>
 y position of OSD, range: -1 to 1, counting from up to down
plaintext string <optional>
 Plain text to overlay
dateFormat string <optional>
 Date to overlay. Must be used with timeFormat, otherwise plaintext will be used.
timeFormat string <optional>
 Time to overlay. Must be used with dateFormat, otherwise plaintext will be used.
fontSize number <optional>
 The text font size.
colorspace string <optional>
 Colorspace - RGB or YCbCr. Default RGB.
fontColor object <optional>
 The color of the text font (OSDColor), should be object with properties - X, Y, Z.
Properties
Name Type Attributes Description
X float <optional>
 For RGB means R value, For YCbCr means Y value.
Y float <optional>
 For RGB means G value, For YCbCr means Cb value.
Z float <optional>
 For RGB means B value, For YCbCr means Cr value.
callback Cam~GetOSDOptionsCallback
Source:
Example
await cam.createOSD({
          position: "LowerLeft",
          timeFormat: "HH:mm:ss",
          dateFormat: "YYYY-MM-DD",
          fontSize: 1,
          colorspace: "RGB",
          fontColor: {
            X: 1,
            Y: 0.7,
            Z: 0.9,
          }
});

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:

createPullPointSubscription(callback)

Create pull-point subscription
Parameters:
Name Type Description
callback function
Source:

createRecordingJob(options, callbackopt)

Parameters:
Name Type Attributes Description
options Object
Properties
Name Type Attributes Description
scheduleToken String <optional>
recordingToken String <optional>
mode String <optional>
priority Number <optional>
source.sourceToken.type String <optional>
source.sourceToken.token String <optional>
source.autoCreateReceiver Boolean <optional>
source.tracks.sourceTag String <optional>
source.extension String <optional>
extension Object <optional>
callback Cam~GetRecordingsCallback <optional>
Source:

createUsers(users, callbackopt)

Create one or more users
Parameters:
Name Type Attributes Description
users Array.<Cam~User>
callback Cam~GetUsersCallback <optional>
Source:

deleteOSD(token, callback)

Delete OSD
Parameters:
Name Type Description
token string
callback Cam~MessageCallback
Source:

deleteProfile(token, callback)

Delete a profile
Parameters:
Name Type Description
token string
callback Cam~MessageCallback
Source:

deleteUsers(users, callbackopt)

Delete one or more users by their Username
Parameters:
Name Type Attributes Description
users Array.<Cam~User> | Array.<string>
callback Cam~GetUsersCallback <optional>
Source:

getAudioEncoderConfiguration(tokenopt, callback)

Get existing audio encoder configuration by its token If token is omitted tries first from #audioEncoderConfigurations array
Parameters:
Name Type Attributes Description
token string <optional>
 Token of the requested audio encoder configuration
callback Cam~AudioEncoderConfigurationCallback
Source:

getAudioEncoderConfigurationOptions(tokenopt, callback)

Get existing audio encoder configuration options by its token If token is omitted tries first from #audioEncoderConfigurations array
Parameters:
Name Type Attributes Description
token string <optional>
 Token of the requested audio encoder configuration
callback Cam~AudioEncoderConfigurationOptionsCallback
Source:

getAudioEncoderConfigurations(callback)

Get all available audio encoder configurations of a device
Parameters:
Name Type Description
callback
Source:

getAudioOutputConfigurations(callback)

Get all existing audio output configurations of a device
Parameters:
Name Type Description
callback
Source:

getAudioOutputs(callback)

Get all available audio outputs of a device
Parameters:
Name Type Description
callback
Source:

getAudioSourceConfigurations(callback)

Get all existing audio source configurations of a device
Parameters:
Name Type Description
callback
Source:

getAudioSources(callback)

Get all available physical audio iutputs of a device
Parameters:
Name Type Description
callback
Source:

getCapabilities(callbackopt)

This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods.
Parameters:
Name Type Attributes Description
callback Cam~GetCapabilitiesCallback <optional>
Source:

getConfigurationOptions(configurationToken, callback)

/PTZ/ Get options for the PTZ configuration
Parameters:
Name Type Description
configurationToken string
callback function
Source:

getConfigurations(callback)

/PTZ/ Get an object with configuration names and details
Parameters:
Name Type Description
callback function
Source:

getCurrentImagingPreset(optionsopt, callback)

Get the last Imaging Preset applied
Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Description
token string <optional>
 Reference token to the VideoSource where the current Imaging Preset should be requested
callback Cam~GetCurrentImagingPresetCallback
Source:

getDNS(callbackopt)

Get DNS information
Parameters:
Name Type Attributes Description
callback Cam~GetDNSCallback <optional>
Source:

getDeviceInformation(callbackopt)

Receive device information
Parameters:
Name Type Attributes Description
callback Cam~GetDeviceInformationCallback <optional>
Source:

getEventProperties(callback)

Get event properties of the device. Sets `events` property of the device
Parameters:
Name Type Description
callback Cam~GetEventPropertiesCallback
Source:

getEventServiceCapabilities(callback)

Get event service capabilities
Parameters:
Name Type Description
callback function
Source:

getHostname(callbackopt)

Receive hostname information
Parameters:
Name Type Attributes Description
callback Cam~GetHostnameCallback <optional>
Source:

getImagingServiceCapabilities()

Returns the capabilities of the imaging service
Properties:
Type Description
Cam~GetImagingServiceCapabilitiesCallback
Source:

getImagingSettings(optionsopt, callback)

Get the ImagingConfiguration for the requested VideoSource (default - the activeSource)
Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Description
token string <optional>
 Cam#activeSource.profileToken
callback Cam~GetImagingSettingsCallback
Source:

getMediaServiceCapabilities(callback)

Returns the capabilities of the media service. The result is returned in a typed answer.
Parameters:
Name Type Description
callback Cam~GetServiceCapabilitiesCallback
Source:

getNTP(callback)

Receive NTP information from cam
Parameters:
Name Type Description
callback Cam~NTPCallback
Source:

getNetworkDefaultGateway(callbackopt)

Get network default gateway information
Parameters:
Name Type Attributes Description
callback Cam~GetNetworkDefaultGatewayCallback <optional>
Source:

getNetworkInterfaces(callbackopt)

Receive network interfaces information
Parameters:
Name Type Attributes Description
callback Cam~GetNetworkInterfacesCallback <optional>
Source:

getNetworkProtocols(callbackopt)

Receive network protocols information
Parameters:
Name Type Attributes Description
callback Cam~GetNetworkProtocolsCallback <optional>
Source:

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:

getOSDOptions(optionsopt, callback)

Get the OSD Options.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
videoSourceConfigurationToken string <optional>
 Token of the Video Source Configuration, which has associated OSDs
callback Cam~GetOSDOptionsCallback
Source:

getOSDs(tokenopt, callback)

Get the OSDs.
Parameters:
Name Type Attributes Description
token string <optional>
 Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs.
callback Cam~GetOSDsCallback
Source:

getPresets(optionsopt, callbackopt)

Receive cam presets
Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Description
profileToken string <optional>
callback <optional>
Source:

getProfiles(callbackopt)

/Media/ Receive profiles
Parameters:
Name Type Attributes Description
callback Cam~GetProfilesCallback <optional>
Source:

getRecordingJobs(callbackopt)

Get Recording Job Items
Parameters:
Name Type Attributes Description
callback Cam~GetRecordingsCallback <optional>
Source:

getRecordings(callbackopt)

Get Recording Items (links Video Sources to Recording Tracks)
Parameters:
Name Type Attributes Description
callback Cam~GetRecordingsCallback <optional>
Source:

getReplayUri(optionsopt, callbackopt)

Receive Replay Stream URI
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
stream string <optional>
protocol string <optional>
recordingToken string <optional>
callback Cam~ResponseUriCallback <optional>
Source:

getScopes(callback)

Receive the scope parameters of a device
Parameters:
Name Type Description
callback Cam~getScopesCallback
Source:

getServiceCapabilities(callbackopt)

Returns the capabilities of the device service
Parameters:
Name Type Attributes Description
callback <optional>
Source:

getServices(includeCapabilityopt, callbackopt)

Returns information about services on the device.
Parameters:
Name Type Attributes Default Description
includeCapability boolean <optional>
 true Indicates if the service capabilities (untyped) should be included in the response.
callback Cam~GetServicesCallback <optional>
Source:

getSnapshotUri(optionsopt, callbackopt)

Receive snapshot URI
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
profileToken string <optional>
callback Cam~ResponseUriCallback <optional>
Source:

getStatus(optionsopt, callback)

/PTZ/ Receive cam status
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
profileToken string <optional>
 Cam#activeSource.profileToken
callback Cam~GetPTZStatusCallback
Source:

getStreamUri(optionsopt, callbackopt)

Receive stream URI
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
stream string <optional>
protocol string <optional>
profileToken string <optional>
callback Cam~ResponseUriCallback <optional>
Source:

getSystemDateAndTime(callback)

Receive date and time from cam
Parameters:
Name Type Description
callback Cam~DateTimeCallback
Source:

getUsers(callbackopt)

Get the list of Username and their User level.
Parameters:
Name Type Attributes Description
callback Cam~GetUsersCallback <optional>
Source:

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:

getVideoEncoderConfigurationOptions(optionsopt, callback)

Get video encoder configuration options by video encoder configuration token or media profile token If options is omitted, returns camera generic video encoder configuration options If both token are set, returns video encoder configuration options compatible with both If options is a string it is considered as configurationToken (for backward compatibility)
Parameters:
Name Type Attributes Description
options object | string <optional>
Properties
Name Type Attributes Description
configurationToken string <optional>
 The video encoder configuration token
profileToken string <optional>
 The media profile token
callback Cam~VideoEncoderConfigurationOptionsCallback
Source:

getVideoEncoderConfigurations(callback)

Get all existing video encoder configurations of a device
Parameters:
Name Type Description
callback Cam~VideoEncoderConfigurationsCallback
Source:

getVideoSourceConfigurations(callbackopt)

Receive video sources
Parameters:
Name Type Attributes Description
callback Cam~GetVideoSourceConfigurationsCallback <optional>
Source:

getVideoSourceOptions(callbackopt)

Get the video source options for a given video source
Parameters:
Name Type Attributes Description
options.token Object videoSourceToken
callback function <optional>
Source:

getVideoSources(callbackopt)

Receive video sources
Parameters:
Name Type Attributes Description
callback Cam~GetVideoSourcesCallback <optional>
Source:

gotoHomePosition(options, callback)

/PTZ/ Go to home position
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
profileToken string <optional>
speed object <optional>
 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 function
Source:

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
speed string
callback function
Source:

imagingGetMoveOptions(options, callbackopt)

Get the move options to be used in the focus move command for a given video source
Parameters:
Name Type Attributes Description
options Object
Properties
Name Type Attributes Default Description
token string <optional>
 Cam#activeSource.sourceToken videoSourceToken
callback function <optional>
Source:

imagingGetStatus(options, callbackopt)

Get the current status of the move operation
Parameters:
Name Type Attributes Description
options Object
Properties
Name Type Attributes Default Description
token string <optional>
 Cam#activeSource.sourceToken videoSourceToken
callback function <optional>
Source:

imagingMove(options, callback)

The command moves the focus lens in an absolute, a relative, or in a continuous manner from its current position.
Parameters:
Name Type Description
options object The supported move options are signaled via the GetMoveOptions command
Properties
Name Type Attributes Default Description
token string <optional>
 Cam#activeSource.sourceToken videoSourceToken
absolute object <optional>
 Absolute movement
Properties
Name Type Attributes Description
position number <optional>
 Min and Max values defined by the GetMoveOptions if support the absolute movement
speed number <optional>
 If the speed argument is omitted, the default speed set by the ImagingSetting will be used.
relative object <optional>
 Relative movement
Properties
Name Type Attributes Description
distance number <optional>
 Min and Max values defined by the GetMoveOptions if support the relative movement
speed number <optional>
 If the speed argument is omitted, the default speed set by the ImagingSetting will be used.
continuous object <optional>
 Continuous move until the focus lens reaches its limits or gets a stop command
Properties
Name Type Attributes Description
speed number <optional>
 Min and Max values defined by the GetMoveOptions if support the continuous movement
callback
Source:

imagingStop(options, callback)

Stop the ongoing focus movements for a given video source
Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Default Description
token string <optional>
 Cam#activeSource.sourceToken videoSourceToken
callback
Source:

parseEventXML()

Helper Function to Parse XML Event data received by an external TCP port and a camera in Event PUSH mode (ie not in subscribe mode)
Source:

ptzSendAuxiliaryCommand(options, callback)

PTZ Service Send Auxiliary Command
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Default Description
profileToken string <optional>
 Cam#activeSource.profileToken
data string <optional>
callback function
Source:

pullMessages(options, callback)

Pull messages from pull-point subscription
Parameters:
Name Type Description
options
Properties
Name Type Attributes Default Description
messageLimit number <optional>
 10
callback Cam~PullMessagesResponse
Source:
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. Min and Max values defined by the Space used (often -1 to +1)
y number <optional>
 0 Tilt, float. Min and Max values defined by the Space used (often -1 to +1)
xyspace number <optional>
 Optional geometry space to be used when not using the default space
zoom number <optional>
 0 Zoom, float. Min and Max values defined by the Space used (often -1 to +1)
zoomspace number <optional>
 Optional geometry space to be used when not using the default space
speed object <optional>
 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. Min and Max values defined by the Space used (often -0 to +1)
y number <optional>
 Tilt speed, float. Min and Max values defined by the Space used (often -0 to +1)
zoom number <optional>
 Zoom speed, float. Min and Max values defined by the Space used (often -0 to +1)
callback Cam~RequestCallback <optional>
Source:

removeAudioEncoderConfiguration(profileToken, callback)

This operation removes an AudioEncoderConfiguration from an existing media profile. If the media profile does not contain an AudioEncoderConfiguration, the operation has no effect. The removal shall be persistent.
Parameters:
Name Type Description
profileToken string Contains a reference to the media profile from which the AudioEncoderConfiguration shall be removed.
callback Cam~RemoveAudioEncoderConfigurationCallback
Source:

removeAudioSourceConfiguration(profileToken, callback)

This operation removes an AudioSourceConfiguration from an existing media profile. If the media profile does not contain an AudioSourceConfiguration, the operation has no effect. The removal shall be persistent. Audio source configurations should only be removed after removing an AudioEncoderConfiguration from the media profile.
Parameters:
Name Type Description
profileToken string Contains a reference to the media profile from which the AudioOutputConfiguration shall be removed.
callback Cam~RemoveAudioSourceConfigurationCallback
Source:

removePreset(options, callback)

/PTZ/ Remove preset
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
profileToken string <optional>
presetToken string
callback function
Source:

renew(optionsopt, callback)

Renew pull-point subscription
Parameters:
Name Type Attributes Description
options Object | function <optional>
callback function
Source:

sendAuxiliaryCommand(options, callback)

Send supported auxiliary commands
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
data string <optional>
callback function
Source:

setAudioEncoderConfiguration(options, callback)

Set the device audio encoder configuration
Parameters:
Name Type 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.
name string <optional>
 User readable name.
useCount number <optional>
 Number of internal references (read-only)
encoding string <optional>
 { 'G711', 'G726', 'AAC' }
bitrate number <optional>
 The output bitrate in kbps.
sampleRate number <optional>
 The output sample rate in kHz.
multicast object <optional>
Properties
Name Type Attributes Description
address object | number <optional>
 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>
sessionTimeout string
callback Cam~AudioEncoderConfigurationCallback
Source:

setCurrentImagingPreset(options, callback)

Set the ImagingConfiguration for the requested or current VideoSource
Parameters:
Name Type Description
options
Properties
Name Type Attributes Description
token string <optional>
 Reference token to the VideoSource to which the specified Imaging Preset should be applied.
presetToken string Reference token to the Imaging Preset to be applied to the specified Video Source
callback Cam~RequestCallback
Source:

setDNS(options, callbackopt)

Set DNS information
Parameters:
Name Type Attributes Description
options Cam~DNSInformation
callback Cam~GetDNSCallback <optional>
Source:

setHomePosition(options, callback)

/PTZ/ Set home position
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
profileToken string <optional>
callback function
Source:

setImagingSettings(options, callback)

Set the ImagingConfiguration for the requested VideoSource (default - the activeSource)
Parameters:
Name Type Description
options Cam~ImagingSetting
callback
Source:

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
NTPManual Array.<Cam~NTPManual> <optional>
 List of NTP addresses
callback Cam~RequestCallback <optional>
Source:

setNetworkDefaultGateway(options, callbackopt)

Set network default gateway information
Parameters:
Name Type Attributes Description
options Cam~NetworkGateway
callback Cam~GetNetworkDefaultGatewayCallback <optional>
Source:

setNetworkInterfaces(options, callbackopt)

Set network interfaces information
Parameters:
Name Type Attributes Description
options object
Properties
Name Type Description
interfaceToken string Network interface token
networkInteface Cam~NetworkInterfaceSetConfiguration Network interface
callback Cam~SetNetworkInterfacesCallback <optional>
Source:

setOSD(options, callback)

SetOSD ONVIF can handle custom positons, date/time, text, font sizes, transparency, images etc. Support - Plain Text, DateAndTime, Font size and Font color.
Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Description
OSDToken Object
videoSourceConfigurationToken string <optional>
 Token of the Video Source Configuration, which has associated OSDs. Defaults to Active Source
position object | string <optional>
 String options: UpperLeft, UpperRight, LowerLeft or LowerRight. Default LowerLeft. Or an object with x and y position
Properties
Name Type Attributes Description
x number <optional>
 x position of OSD, range: -1 to 1, counting from left to right
y number <optional>
 y position of OSD, range: -1 to 1, counting from up to down
plaintext string <optional>
 Plain text to overlay
dateFormat string <optional>
 Date to overlay. Must be used with timeFormat, otherwise plaintext will be used.
timeFormat string <optional>
 Time to overlay. Must be used with dateFormat, otherwise plaintext will be used.
fontSize number <optional>
 The text font size.
colorspace string <optional>
 Colorspace - RGB or YCbCr. Default RGB.
fontColor object <optional>
 The color of the text font (OSDColor), should be object with properties - X, Y, Z.
Properties
Name Type Attributes Description
X float <optional>
 For RGB means R value, For YCbCr means Y value.
Y float <optional>
 For RGB means G value, For YCbCr means Cb value.
Z float <optional>
 For RGB means B value, For YCbCr means Cr value.
callback Cam~GetOSDOptionsCallback
Source:
See:
  • {Cam~createOSD}

setPreset(options, callback)

/PTZ/ Set preset
Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
profileToken string <optional>
presetName string
presetToken string <optional>
callback function
Source:

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:

setSynchronizationPoint(optionsopt, callbackopt)

Set Synchronization Point (keyframe / i-frame)
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
profileToken string <optional>
callback Cam~SetSynchronizationPointCallback <optional>
Source:

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:

setSystemFactoryDefault(hardopt, callback)

Reset camera to factory default
Parameters:
Name Type Attributes Default Description
hard boolean <optional>
 false Reset network settings
callback Cam~SetSystemFactoryDefaultCallback
Source:

setUsers(users, callbackopt)

Set the Password and User level of one or more users by their Username
Parameters:
Name Type Attributes Description
users Array.<Cam~User>
callback Cam~GetUsersCallback <optional>
Source:

setVideoEncoderConfiguration(options, callback)

Set the device video encoder configuration
Parameters:
Name Type 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.
name string <optional>
 User readable name.
useCount number <optional>
 Number of internal references (read-only)
encoding string <optional>
 ( JPEG | H264 | MPEG4 )
resolution object <optional>
 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
quality number Relative value for the video quantizers and the quality of the video
rateControl object <optional>
 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
MPEG4 object <optional>
Properties
Name Type Description
govLength number Determines the interval in which the I-Frames will be coded
profile string the Mpeg4 profile ( SP | ASP )
H264 object <optional>
Properties
Name Type Description
govLength number Group of Video frames length
profile string the H.264 profile ( Baseline | Main | Extended | High )
multicast object <optional>
Properties
Name Type Attributes Description
address object | number <optional>
 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>
sessionTimeout string
callback Cam~VideoEncoderConfigurationCallback
Source:

stop(optionsopt, callbackopt)

Stop ongoing pan, tilt and zoom movements of absolute relative and continuous type
Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Description
profileToken string <optional>
panTilt boolean | string <optional>
zoom boolean | string <optional>
callback Cam~RequestCallback <optional>
Source:

subscribe(options, callback)

Create Base Subscription This allows Cameras and NVTs to send events to a URL via a POST message TODO - Add Termination Time
Parameters:
Name Type Description
options object
Properties
Name Type Description
url string
callback function
Source:

systemReboot(callback)

/Device/ Reboot the device
Parameters:
Name Type Description
callback Cam~MessageCallback
Source:

unsubscribe(callbackopt, preserveListenersopt)

Unsubscribe from pull-point subscription
Parameters:
Name Type Attributes Default Description
callback Cam~PullMessagesResponse <optional>
preserveListeners boolean <optional>
 false Don't remove listeners on 'event'
Source:
Throws:
Cam#events.subscription must exists
Type
Error

Type Definitions

ActiveSource

Active source
Type:
  • object
Properties:
Name Type Attributes Description
sourceToken string video source token
profileToken string profile token
videoSourceConfigurationToken string video source configuration token
ptz object <optional>
 PTZ-object
Properties
Name Type Description
name string PTZ configuration name
token string PTZ token
Source:

AddAudioEncoderConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

AddAudioSourceConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

AddVideoEncoderConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

AddVideoSourceConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

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 <optional>
 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 <optional>
 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 <optional>
 I/O capabilities
Properties
Name Type Attributes Description
inputConnectors number Number of input connectors
relayOutputs number Number of relay outputs
extension object <optional>
Properties
Name Type Description
auxiliary boolean
auxiliaryCommands object
security object <optional>
 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 <optional>
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 <optional>
Properties
Name Type Attributes Description
telexCapabilities object <optional>
scdlCapabilities object <optional>
Source:

ConnectionCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
Source:

CreatePullPointSubscriptionResponse

Type:
  • object
Properties:
Name Type Description
subscriptionReference object
Properties
Name Type Description
address string | object
currentTime Date
terminationTime Date
Source:

DNSInformation

Type:
  • object
Properties:
Name Type Description
fromDHCP string Indicates whether or not DNS information is retrieved from DHCP.
searchDomain string Search domain.
DNSFromDHCP Array.<Cam~IPAddress> List of DNS addresses received from DHCP.
DNSManual Array.<Cam~IPAddress> List of manually entered DNS addresses.
Source:

DateTimeCallback()

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

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:

Event

Type:
  • object
Properties:
Name Type Attributes Description
currentTime Date
terminationTime Date
notificationMessage Cam~NotificationMessage | Array.<Cam~NotificationMessage> <optional>
Source:

EventProperties

Event properties object
Type:
  • object
Properties:
Name Type Description
topicNamespaceLocation array
topicSet object
topicExpressionDialect array
Source:

GetCapabilitiesCallback()

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

GetCurrentImagingPresetCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
preset Cam~ImagingPreset
Source:

GetDNSCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
DNSInformation Array.<Cam~DNSInformation> DNS information
xml string Raw SOAP response
Source:

GetDeviceInformationCallback()

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

GetEventPropertiesCallback()

Properties:
Name Type Attributes Description
err Error <nullable>
response Cam~EventProperties
response string xml
Source:

GetHostnameCallback()

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

GetImagingServiceCapabilitiesCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
capabilities Cam~ImagingServiceCapabilities
Source:

GetImagingSettingsCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
status Cam~ImagingSettings
Source:

GetNetworkDefaultGatewayCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
networkGateway Array.<Cam~NetworkGateway> Network Gateway information
xml string Raw SOAP response
Source:

GetNetworkInterfacesCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
networkInterfaces Array.<Cam~NetworkInterface> Network interfaces information
xml string Raw SOAP response
Source:

GetNetworkProtocolsCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
network Array.<Cam~NetworkProtocol> protocols information
xml string Raw SOAP response
Source:

GetPTZStatusCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
status Cam~PTZStatus
Source:

GetProfilesCallback()

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

GetRecordingsCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
recording Cam~RecordingItem | Array.<Cam~RecordingItem> items
xml string Raw SOAP response
Source:

GetServiceCapabilitiesCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
mediaCapabilities Cam~MediaCapabilities The capabilities for the media service is returned in the Capabilities element.
xml string Raw XML response
Source:

GetServicesCallback()

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

GetUsersCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
videoSourceConfigurations Array.<Cam~User>
xml string Raw SOAP response The password is not included in the response even if it is present in Cam~User
Source:

GetVideoSourceConfigurationsCallback()

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

GetVideoSourcesCallback()

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

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:

IPAddress

Type:
  • object
Properties:
Name Type Description
type string Indicates if the address is an IPv4 or IPv6 address. - enum { 'IPv4', 'IPv6' }
IPv4Address string IPv4 address.
IPv6Address string IPv6 address.
Source:

ImagingPreset

Type:
  • object
Properties:
Name Type Description
token string
type string Indicates Imaging Preset Type
Name string Human readable name of the Imaging Preset
Source:

ImagingServiceCapabilities

Type:
  • object
Properties:
Name Type Attributes Description
ImageStabilization boolean Indicates whether or not Image Stabilization feature is supported
Presets boolean <optional>
 Indicates whether or not Imaging Presets feature is supported
Source:

ImagingSetting

Type:
  • object
Properties:
Name Type Description
token string Video source token
brightness number
colorSaturation number
contrast number
exposure object
Properties
Name Type Description
mode string Exposure mode -enum { 'AUTO', 'MANUAL' }
priority string The exposure priority mode (low noise/framerate) -enum { 'LowNoise', 'FrameRate' }
minExposureTime number
maxExposureTime number
minGain number
maxGain number
minIris number
maxIris number
exposureTime number
gain number
iris number
focus object
Properties
Name Type Description
autoFocusMode string Mode of auto focus -enum { 'AUTO', 'MANUAL' }
defaultSpeed number
nearLimit number
farLimit number
sharpness number
irCutFilter string Mode of ir cut filter -enum { 'AUTO', 'ON', 'OFF' }
Source:

ImagingSettings

Type:
  • object
Properties:
Name Type Description
brightness number
colorSaturation number
focus object
Properties
Name Type Description
autoFocusMode string
sharpness number
Source:

MediaCapabilities

Properties:
Name Type Description
$.SnapshotUri boolean Indicates if GetSnapshotUri is supported.
$.Rotation boolean Indicates whether or not Rotation feature is supported.
$.VideoSourceMode boolean Indicates the support for changing video source mode.
$.OSD boolean Indicates if OSD is supported.
$.TemporaryOSDText boolean Indicates the support for temporary osd text configuration.
$.EXICompression boolean Indicates the support for the Efficient XML Interchange (EXI) binary XML format.
profileCapabilities Cam~ProfileCapabilities Media profile capabilities.
streamCapabilities Cam~StreamCapabilities Streaming capabilities.
Source:

MessageCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
message string <nullable>
Source:

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:

NTPFromDHCP

Type:
  • object
Properties:
Name Type Attributes Description
options.type string Network host type: IPv4, IPv6 or DNS. - enum { 'IPv4', 'IPv6', 'DNS' }
options.IPv4Address string <optional>
 IPv4 address
options.IPv6Address string <optional>
 IPv6 address
options.DNSname string <optional>
 DNS name
options.extension string <optional>
Source:

NTPInformation

Type:
  • object
Properties:
Name Type Attributes Description
fromDHCP boolean Indicates if NTP information is to be retrieved by using DHCP
NTPFromDHCP Array.<Cam~NTPFromDHCP> <optional>
 List of NTP addresses retrieved by using DHCP
NTPManual Array.<Cam~NTPManual> <optional>
 List of manually entered NTP addresses
Source:

NTPManual

Type:
  • object
Properties:
Name Type Attributes Description
options.type string Network host type: IPv4, IPv6 or DNS. - enum { 'IPv4', 'IPv6', 'DNS' }
options.IPv4Address string <optional>
 IPv4 address
options.IPv6Address string <optional>
 IPv6 address
options.DNSname string <optional>
 DNS name
options.extension string <optional>
Source:

NetworkGateway

Type:
  • object
Properties:
Name Type Description
IPv4Address string
IPv6Address string
Source:

NetworkInterface

Type:
  • object
Properties:
Name Type Attributes Description
$ object
Properties
Name Type Description
token string Unique identifier referencing the physical entity.
enabled boolean Indicates whether or not an interface is enabled.
info object <optional>
 network interface information
Properties
Name Type Description
name string Network interface name, for example eth0
hwAddress string Network interface MAC address
MTU number Maximum transmission unit.
link object <optional>
 Link configuration.
Properties
Name Type Description
adminSettings object Configured link settings.
Properties
Name Type Description
autoNegotiation boolean Auto negotiation on/off.
speed number
duplex string Duplex type, Half or Full. - enum { 'Full', 'Half' }
operSettings object Current active link settings
Properties
Name Type Description
autoNegotiation boolean Auto negotiation on/off.
speed number
duplex string Duplex type, Half or Full. - enum { 'Full', 'Half' }
interfaceType number Integer indicating interface type, for example: 6 is ethernet.
IPv4 object <optional>
 IPv4 network interface configuration.
Properties
Name Type Description
enabled boolean Indicates whether or not IPv4 is enabled.
config object IPv4 configuration.
Properties
Name Type Attributes Description
manual object <optional>
 List of manually added IPv4 addresses.
Properties
Name Type Description
address string IPv4 address.
prefixLength number Prefix/submask length.
linkLocal object <optional>
 List of manually added IPv4 addresses.
Properties
Name Type Description
address string IPv4 address.
prefixLength number Prefix/submask length.
fromDHCP object <optional>
 IPv4 address configured by using DHCP.
Properties
Name Type Description
address string IPv4 address.
prefixLength number Prefix/submask length.
DHCP boolean Indicates whether or not DHCP is used.
IPv6 object <optional>
 IPv6 network interface configuration.
Properties
Name Type Description
enabled boolean Indicates whether or not IPv6 is enabled.
config object IPv6 configuration.
Properties
Name Type Attributes Description
acceptRouterAdvert boolean <optional>
 Indicates whether router advertisement is used.
DHCP string DHCP configuration. - enum { 'Auto', 'Stateful', 'Stateless', 'Off' }
manual object <optional>
 List of manually added IPv6 addresses.
Properties
Name Type Description
address string IPv6 address.
prefixLength number Prefix/submask length.
linkLocal object <optional>
 List of link local IPv6 addresses.
Properties
Name Type Description
address string IPv6 address.
prefixLength number Prefix/submask length.
fromDHCP object <optional>
 List of IPv6 addresses configured by using DHCP.
Properties
Name Type Description
address string IPv6 address.
prefixLength number Prefix/submask length.
fromRA object <optional>
 List of IPv6 addresses configured by using router advertisement.
Properties
Name Type Description
address string IPv6 address.
prefixLength number Prefix/submask length.
extension object <optional>
 Extension
extension object <optional>
 Extension
Properties
Name Type Attributes Description
interfaceType string
dot3 object <optional>
 Extension point prepared for future 802.3 configuration.
dot11 object <optional>
Properties
Name Type Description
SSID string
mode string enum { 'Ad-hoc', 'Infrastructure', 'Extended' }
alias string
priority string
security object
Properties
Name Type Attributes Description
mode string enum { 'None', 'WEP', 'PSK', 'Dot1X', 'Extended'
algorithm string enum { 'CCMP', 'TKIP', 'Any', 'Extended' }
PSK object
Properties
Name Type Attributes Description
key string According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex Either Key or Passphrase shall be given, if both are supplied Key shall be used by the device and Passphrase ignored.
passphrase string According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. if only Passpharse is supplied the Key shall be derived using the algorithm described in IEEE802.11-2007 section H.4
extension object <optional>
dot1X string <optional>
extension object <optional>
extension object <optional>
Source:

NetworkInterfaceSetConfiguration

Type:
  • object
Properties:
Name Type Attributes Description
enabled boolean <optional>
 Indicates whether or not an interface is enabled.
link object <optional>
 Link configuration
Properties
Name Type Description
autoNegotiation boolean Auto negotiation on/off.
speed number Speed.
duplex string Duplex type, Half or Full. - enum { 'Full', 'Half' }
MTU number <optional>
 Maximum transmission unit.
IPv4 object <optional>
 IPv4 network interface configuration.
Properties
Name Type Attributes Description
enabled boolean <optional>
 Indicates whether or not IPv4 is enabled.
manual object <optional>
 List of manually added IPv4 addresses.
Properties
Name Type Description
address string IPv4 address.
prefixLength number Prefix/submask length.
DHCP boolean <optional>
 Indicates whether or not DHCP is used.
IPv6 object <optional>
 IPv6 network interface configuration.
Properties
Name Type Attributes Description
enabled boolean <optional>
 Indicates whether or not IPv6 is enabled.
acceptRouterAdvert boolean <optional>
 Indicates whether router advertisement is used.
manual object <optional>
 List of manually added IPv6 addresses.
Properties
Name Type Description
address string IPv6 address.
prefixLength number Prefix/submask length.
DHCP string <optional>
 DHCP configuration. - enum { 'Auto', 'Stateful', 'Stateless', 'Off' }
extension object <optional>
Properties
Name Type Attributes Description
Dot3 object <optional>
[Dot11 object
extension].Dot11.SSID string
extension.Dot11.mode string enum { 'Ad-hoc', 'Infrastructure', 'Extended' }
extension.Dot11.alias string
extension.Dot11.priority string
extension.Dot11.security object
Properties
Name Type Attributes Description
mode string enum { 'None', 'WEP', 'PSK', 'Dot1X', 'Extended' }
algorithm string <optional>
 enum { 'CCMP', 'TKIP', 'Any', 'Extended' }
PSK object <optional>
Properties
Name Type Attributes Description
key string <optional>
 According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex Either Key or Passphrase shall be given, if both are supplied Key shall be used by the device and Passphrase ignored.
passphrase string <optional>
 According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. If only Passpharse is supplied the Key shall be derived using the algorithm described in IEEE802.11-2007 section H.4
extension object <optional>
dot1X string <optional>
extension object <optional>
extension.extension object <optional>
Source:

NetworkProtocol

Type:
  • object
Properties:
Name Type Description
name string Network protocol type string. - enum { 'HTTP', 'HTTPS', 'RTSP' }
enabled boolean Indicates if the protocol is enabled or not.
port number The port that is used by the protocol.
extension object
Source:

NotificationMessage

Type:
  • object
Properties:
Name Type Description
subscriptionReference.address string Pull-point address
topic._ string Namespace of message topic
message object Message object
Source:

Options

Properties:
Name Type Attributes Default Description
useSecure boolean <optional>
 Set true if `https:`, defaults to false
secureOpts object <optional>
 Set options for https like ca, cert, ciphers, rejectUnauthorized, secureOptions, secureProtocol, etc.
useWSSecurity boolean <optional>
 Use WS-Security SOAP headers
hostname string
username string <optional>
password string <optional>
port number <optional>
 80
path string <optional>
 /onvif/device_service
timeout number <optional>
 120000
autoconnect boolean <optional>
 true Set false if the camera should not connect automatically. The callback will not be executed.
preserveAddress boolean <optional>
 false Force using hostname and port from constructor for the services
Source:

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:

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:

ProfileCapabilities

Properties:
Name Type Description
$.maximumNumberOfProfiles number Maximum number of profiles supported.
Source:

PullMessagesResponse()

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

RecordingItem

Type:
  • object
Properties:
Name Type Description
$.token string Recording token
configuration.source.sourceid string
configuration.content string
configuration.maximumretentiontime string
tracks.track.tracktoken string
tracks.configuration.tracktype string
tracks.configuration.description string
Source:

RemoveAudioEncoderConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

RemoveAudioSourceConfigurationCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw XML response
Source:

RequestCallback(err, responseopt, xmlopt)

Parameters:
Name Type Attributes Description
err Error
response object <optional>
 message
xml string <optional>
 response
Source:

ResponseUriCallback()

Properties:
Name Type Description
uri string
Source:

ResponseUriCallback()

Properties:
Name Type Description
uri string
Source:

Scope

Type:
  • object
Properties:
Name Type Description
scopeDef string Indicates if the scope is fixed or configurable
scopeItem string Scope item URI
Source:

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:

SetNetworkInterfacesCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
data.rebootNeeded boolean
xml string Raw SOAP response
Source:

SetSystemFactoryDefaultCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
null
xml string Raw SOAP response
Source:

StreamCapabilities

Properties:
Name Type Description
$.RTPMulticast boolean Indicates support for RTP multicast.
$.TRP_TCP boolean Indicates support for RTP over TCP.
$.TRP_RTSP_TCP boolean Indicates support for RTP/RTSP/TCP.
$.NonAggregateControl boolean Indicates support for non aggregate RTSP control.
$.NoRTSPStreaming boolean Indicates the device does not support live media streaming via RTSP.
Source:

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:

User

Type:
  • object
Properties:
Name Type Description
username string
password string
userLevel string 'Administrator', 'Operator', 'User', 'Anonymous' or 'Extended'
Source:

VideoEncoderConfiguration

Type:
  • object
Properties:
Name Type Attributes Description
$.token string Token that uniquely references 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>
 Optional element to configure rate control related parameters
Properties
Name Type Description
frameRateLimit number
encodingInterval number
bitrateLimit number
H264 object <optional>
 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>
 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 Description
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:

VideoEncoderConfigurationCallback()

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

VideoEncoderConfigurationOptions

Type:
  • object
Properties:
Name Type Attributes Description
qualityRange object Range of the quality values. A high value means higher quality
Properties
Name Type Description
min number
max number
JPEG object <optional>
 Optional JPEG encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
MPEG4 object <optional>
 Optional MPEG4 encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
resolutionsAvailable object List of supported resolutions
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
govLengthRange object Range of group of video frames length settings
Properties
Name Type Description
min number
max number
MPEG4ProfilesSupported object List of supported MPEG4 profiles enum {'SP', 'ASP'}
H264 object <optional>
 Optional H.264 encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
govLengthRange object Range of group of video frames length settings
Properties
Name Type Description
min number
max number
H264ProfilesSupported object List of supported H.264 profiles enum {'Baseline', 'Main', 'Extended', 'High'}
extension object <optional>
 Optional encoder extensions
Properties
Name Type Attributes Description
JPEG object <optional>
 Optional JPEG encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
bitrateRange object Range of bitrate settings
Properties
Name Type Description
min number
max number
MPEG4 object <optional>
 Optional MPEG4 encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
resolutionsAvailable object List of supported resolutions
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
govLengthRange object Range of group of video frames length settings
Properties
Name Type Description
min number
max number
MPEG4ProfilesSupported object List of supported MPEG4 profiles enum {'SP', 'ASP'}
bitrateRange object Range of bitrate settings
Properties
Name Type Description
min number
max number
H264 object <optional>
 Optional H.264 encoder settings ranges
Properties
Name Type Description
resolutionsAvailable object List of supported resolutions
Properties
Name Type Description
width number
height number
frameRateRange object Range of frame rate settings
Properties
Name Type Description
min number
max number
encodingIntervalRange object Range of encoding interval settings
encodingInterval.min number
encodingInterval.max number
govLengthRange object Range of group of video frames length settings
Properties
Name Type Description
min number
max number
H264ProfilesSupported object List of supported H.264 profiles enum {'Baseline', 'Main', 'Extended', 'High'}
bitrateRange object Range of bitrate settings
Properties
Name Type Description
min number
max number
extension object <optional>
 Even more optional extensions
Source:

VideoEncoderConfigurationOptionsCallback()

Properties:
Name Type Attributes Description
error Error <nullable>
videoEncoderConfigurationOptions Cam~VideoEncoderConfigurationOptions
xml string Raw SOAP response
Source:

VideoEncoderConfigurationsCallback()

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

VideoSource

Type:
  • object
Properties:
Name Type Description
$.token string Video source token
framerate number
resolution.width number
resolution.height number
Source:

VideoSourceConfiguration

Type:
  • object
Properties:
Name Type Description
token string Token that uniquely references 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:

getScopesCallback()

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

Events

connect

Indicates that device is connected.
Source:

event

Indicates message from device.
Type:
Source:

rawRequest

Indicates raw xml request to device.
Type:
  • Object
Source:

rawResponse

Indicates raw xml response from device.
Type:
  • string
Source:

warning

Indicates any warning.
Type:
  • string
Source: