new Cam(options, callbackopt)
Camera class
Parameters:
Name |
Type |
Attributes |
Description |
options |
object
|
|
Properties
Name |
Type |
Attributes |
Default |
Description |
hostname |
string
|
|
|
|
username |
string
|
<optional>
|
|
|
password |
string
|
<optional>
|
|
|
port |
number
|
<optional>
|
80
|
|
path |
string
|
<optional>
|
/onvif/device_service
|
|
timeout |
number
|
<optional>
|
120000
|
|
preserveAddress |
boolean
|
<optional>
|
false
|
Force using hostname and port from constructor for the services |
|
callback |
Cam~ConnectionCallback
|
<optional>
|
|
Properties:
Name |
Type |
Description |
presets |
|
|
- Source:
Fires:
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
Members
Current active video source
Type:
- Source:
Active video sources
Type:
- Source:
Device capabilities
Type:
- Source:
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:
Properties:
- Source:
preserveAddress :boolean
Force using hostname and port from constructor for the services
Type:
- Source:
Array of all device profiles
Type:
- Source:
Recording Item
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:
Video sources
Type:
- Source:
xaddrs :Array.<Url>
All available XAddr fields from discovery
Type:
- 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:
connect(callback)
Connect to the camera and fill device information properties
Parameters:
- 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 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:
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:
deleteProfile(token, callback)
Delete a profile
Parameters:
- 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)
Receive cam capabilities
Parameters:
- 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 array with configuration names
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:
Receive device information
Parameters:
- Source:
getEventProperties(callback)
Get event properties of the device. Sets `events` property of the device
Parameters:
- Source:
getEventServiceCapabilities(callback)
Get event service capabilities
Parameters:
Name |
Type |
Description |
callback |
function
|
|
- Source:
getHostname(callbackopt)
Receive hostname information
Parameters:
- Source:
getImagingServiceCapabilities()
Returns the capabilities of the imaging service
Properties:
- 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:
getNetworkInterfaces(callbackopt)
Receive network interfaces information
Parameters:
- Source:
getNetworkProtocols(callbackopt)
Receive network protocols information
Parameters:
- 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:
getNTP(callback)
Receive NTP information from cam
Parameters:
- 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:
- Source:
getRecordings(callbackopt)
Get Recording Items (links Video Sources to Recording Tracks)
Parameters:
- 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:
- Source:
getServiceCapabilities(callbackopt)
Returns the capabilities of the device service
Parameters:
Name |
Type |
Attributes |
Description |
callback |
|
<optional>
|
|
- Source:
getServices(callbackopt)
Receive services
Parameters:
- 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:
- Source:
getVideoEncoderConfiguration(tokenopt, callback)
Get existing video encoder configuration by its token
If token is omitted tries first from #videoEncoderConfigurations array
Parameters:
- Source:
getVideoEncoderConfigurationOptions(tokenopt, callback)
Get existing video encoder configuration options by its token
If token is omitted tries first from #videoEncoderConfigurations array
Parameters:
- Source:
getVideoEncoderConfigurations(callback)
Get all existing video encoder configurations of a device
Parameters:
- Source:
getVideoSourceConfigurations(callbackopt)
Receive video sources
Parameters:
- Source:
getVideoSources(callbackopt)
Receive video sources
Parameters:
- 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 |
|
callback |
function
|
|
- Source:
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:
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
|
<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:
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:
setImagingSettings(options, callback)
Set the ImagingConfiguration for the requested VideoSource (default - the activeSource)
Parameters:
- 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 |
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:
setScopes(scopes, callback)
Set the scope parameters of a device
Parameters:
- 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 |
'Manual'
|
'NTP'
|
|
|
|
daylightSavings |
boolean
|
<optional>
|
false
|
|
|
callback |
Cam~DateTimeCallback
|
|
- 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:
systemReboot(callback)
/Device/ Reboot the device
Parameters:
- Source:
Type Definitions
ActiveSource
Active source
Type:
Properties:
Name |
Type |
Attributes |
Description |
sourceToken |
string
|
|
video source token |
profileToken |
string
|
|
profile token |
ptz |
object
|
<optional>
|
PTZ-object
Properties
Name |
Type |
Description |
name |
string
|
PTZ configuration name |
token |
string
|
PTZ token |
|
- Source:
Capabilities
Capability list
Type:
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:
Properties:
Name |
Type |
Description |
subscriptionReference |
object
|
Properties
Name |
Type |
Description |
address |
string
|
object
|
|
|
currentTime |
Date
|
|
terminationTime |
Date
|
|
- 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:
Type:
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:
Properties:
- Source:
EventProperties
Event properties object
Type:
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:
- Source:
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:
- Source:
GetImagingSettingsCallback()
Properties:
- Source:
GetNetworkInterfacesCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
network |
Array.<Cam~NetworkInterface>
|
|
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:
GetProfilesCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
profiles |
Array.<Cam~Profile>
|
|
Array of device's profiles |
xml |
string
|
|
Raw XML response |
- Source:
GetPTZStatusCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
status |
Cam~PTZStatus
|
|
|
- Source:
GetRecordingsCallback()
Properties:
- Source:
getScopesCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
scopes |
Array.<Cam~Scope>
|
|
Scopes |
xml |
string
|
|
Raw SOAP response |
- Source:
GetServicesCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
services |
Array.<Cam~Service>
|
|
|
xml |
string
|
|
Raw SOAP response |
- Source:
GetVideoSourceConfigurationsCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
videoSourceConfigurations |
Array.<Cam~VideoSourceConfiguration>
|
|
|
xml |
string
|
|
Raw SOAP response |
- Source:
GetVideoSourcesCallback()
Properties:
- Source:
Type:
Properties:
Name |
Type |
Attributes |
Description |
fromDHCP |
boolean
|
|
Indicates whether the hostname is obtained from DHCP or not |
name |
string
|
<optional>
|
Indicates the hostname |
- Source:
ImagingPreset
Type:
Properties:
Name |
Type |
Description |
token |
string
|
|
type |
string
|
Indicates Imaging Preset Type |
Name |
string
|
Human readable name of the Imaging Preset |
- Source:
ImagingServiceCapabilities
Type:
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:
Properties:
Name |
Type |
Description |
token |
string
|
Video source token |
brightness |
number
|
|
colorSaturation |
number
|
|
contrast |
number
|
|
sharpness |
number
|
|
- Source:
ImagingSettings
Type:
Properties:
Name |
Type |
Description |
brightness |
number
|
|
colorSaturation |
number
|
|
focus |
object
|
Properties
Name |
Type |
Description |
autoFocusMode |
string
|
|
|
sharpness |
number
|
|
- Source:
MessageCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
message |
string
|
<nullable>
|
|
- Source:
NetworkInterface
Type:
Properties:
Name |
Type |
Attributes |
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 advertisment 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 advertisment.
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:
NetworkProtocol
Type:
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:
Properties:
Name |
Type |
Description |
subscriptionReference.address |
string
|
Pull-point address |
topic._ |
string
|
Namespace of message topic |
message |
object
|
Message object |
- 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:
Type:
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:
Profile
Type:
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:
PTZStatus
Type:
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:
PullMessagesResponse()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
response |
Cam~Event
|
|
Message |
xml |
string
|
|
Raw SOAP response |
- Source:
RecordingItem
Type:
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:
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:
Properties:
Name |
Type |
Description |
scopeDef |
string
|
Indicates if the scope is fixed or configurable |
scopeItem |
string
|
Scope item URI |
- Source:
Service
Type:
Properties:
Name |
Type |
Description |
namespace |
string
|
Namespace uri |
XAddr |
string
|
Uri for requests |
version.minor |
number
|
Minor version |
version.major |
number
|
Major version |
- Source:
SystemDateAndTime
Type:
Properties:
Name |
Type |
Description |
dayTimeType |
'Manual'
|
'NTP'
|
(Manual | NTP) |
daylightSavings |
boolean
|
|
timezone |
string
|
in POSIX 1003.1 format |
hour |
number
|
|
minute |
number
|
|
second |
number
|
|
year |
number
|
|
month |
number
|
|
day |
number
|
|
- Source:
VideoEncoderConfiguration
Type:
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>
|
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:
- Source:
VideoEncoderConfigurationOptions
Type:
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:
- Source:
VideoEncoderConfigurationsCallback()
Properties:
Name |
Type |
Attributes |
Description |
error |
Error
|
<nullable>
|
|
videoEncoderConfigurations |
Array.<Cam~VideoEncoderConfiguration>
|
|
|
xml |
string
|
|
Raw SOAP response |
- Source:
VideoSource
Type:
Properties:
Name |
Type |
Description |
$.token |
string
|
Video source token |
framerate |
number
|
|
resolution.width |
number
|
|
resolution.height |
number
|
|
- Source:
VideoSourceConfiguration
Type:
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:
Events
event
Indicates message from device.
Type:
- Source:
rawResponse
Indicates raw xml response from device.
Type:
- Source: