Skip to content

Commit

Permalink
Version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
@agsh
agsh committed Dec 20, 2022
1 parent 0a1081f commit 32c122a
Show file tree
Hide file tree
Showing 18 changed files with 2,189 additions and 117 deletions.
993 changes: 924 additions & 69 deletions Cam_.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Discovery_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion cam.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion cam.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1092,7 +1092,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
734 changes: 734 additions & 0 deletions device.js.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion discovery.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion discovery.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
8 changes: 6 additions & 2 deletions events.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,11 @@ <h1 class="page-title">Source: events.js</h1>
this.events.messageLimit = this.events.messageLimit || 10; // setting message limit
if (!this.events.subscription || !this.events.terminationTime || (this.events.terminationTime &lt; Date.now() + this.events.timeout)) {
// if there is no pull-point subscription or it will be dead soon, create new
this.createPullPointSubscription(this._eventPull.bind(this));
this.createPullPointSubscription(function(error) {
if (!error) {
this._eventPull();
}
}.bind(this));
} else {
this._eventPull();
}
Expand Down Expand Up @@ -428,7 +432,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion global.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion imaging.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
30 changes: 15 additions & 15 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,13 @@ <h3> </h3>
<p>This is a wrapper to ONVIF protocol which allows you to get information about your NVT (network video transmitter)
device, its media sources, control PTZ (pan-tilt-zoom) movements and manage presets, detect devices in your network and control its events.
It will also allow you to get information about your NVR (network video recorder) Profile G device and obtain a list of recordings.</p>
<p>The library uses NodeJS.</p>
<p>The library uses NodeJS. And works on the server-side.</p>
<p><a href="http://onvif.org"><img src="https://www.onvif.org/wp-content/themes/onvif-public/images/logo.png" alt="ONVIF"></a></p>
<h2>Installation</h2>
<h3>NPM</h3>
<p><code>npm install onvif</code> - install latest stable version</p>
<p><code>npm install agsh/onvif</code> - install latest version from GitHub</p>
<p><code>npm install agsh/onvif#dev</code> - install latest development version</p>
<p><code>npm install agsh/onvif#v1</code> - install latest development version</p>
<h3>Clone the latest version from github</h3>
<p><code>git clone https://github.com/agsh/onvif.git</code></p>
<h3>Tests</h3>
Expand Down Expand Up @@ -108,7 +108,7 @@ <h2>Troubleshooting</h2>
<p>Different cameras have different ONVIF implementation. I've tested this module only with a couple of devices. So if you got different problems with this library, please let me know via e-mail. Else please just send the model of your
camera to me.</p>
<h1>API</h1>
<p>This page and API class documentation you can found here: <a href="http://agsh.github.io/onvif/">http://agsh.github.io/onvif/</a></p>
<h2>You can find this page and full API class documentation here: <a href="http://agsh.github.io/onvif/">http://agsh.github.io/onvif/</a></h2>
<p>Old concise docs are below.</p>
<h2>Discovery</h2>
<p>Since 0.2.7 version library supports WS-Discovery of NVT devices. Currently it uses only <code>Probe</code> SOAP method that just works well.
Expand Down Expand Up @@ -294,9 +294,9 @@ <h3>gotoHomePosition(options, callback)</h3>
<li>
<p><code>speed</code> An object with properties</p>
<ul>
<li><code>x</code> Pan speed</li>
<li><code>y</code> Tilt speed</li>
<li><code>zoom</code> Zoom speed</li>
<li><code>x</code> Pan speed, float within 0 to 1</li>
<li><code>y</code> Tilt speed, float within 0 to 1</li>
<li><code>zoom</code> Zoom speed, float within 0 to 1</li>
</ul>
<p>If the speed option is omitted, the default speed set by the PTZConfiguration will be used.</p>
</li>
Expand All @@ -322,14 +322,14 @@ <h3>relativeMove(options, callback)</h3>
<p><code>y</code> Tilt, number or a string within -1 to 1, optional</p>
</li>
<li>
<p><code>zoom</code> Zoom, number or a string within -1 to 1, optional</p>
<p><code>zoom</code> Zoom, number or a string within 0 to 1, optional</p>
</li>
<li>
<p><code>speed</code> An object with properties</p>
<ul>
<li><code>x</code> Pan speed</li>
<li><code>y</code> Tilt speed</li>
<li><code>zoom</code> Zoom speed</li>
<li><code>x</code> Pan speed, float within 0 to 1</li>
<li><code>y</code> Tilt speed, float within 0 to 1</li>
<li><code>zoom</code> Zoom speed, float within 0 to 1</li>
</ul>
<p>If the speed option is omitted, the default speed set by the PTZConfiguration will be used.</p>
</li>
Expand All @@ -346,14 +346,14 @@ <h3>absoluteMove(options, callback)</h3>
<p><code>y</code> Tilt, number or a string within -1 to 1, optional</p>
</li>
<li>
<p><code>zoom</code> Zoom, number or a string within -1 to 1, optional</p>
<p><code>zoom</code> Zoom, number or a string within 0 to 1, optional</p>
</li>
<li>
<p><code>speed</code> An object with properties</p>
<ul>
<li><code>x</code> Pan speed</li>
<li><code>y</code> Tilt speed</li>
<li><code>zoom</code> Zoom speed</li>
<li><code>x</code> Pan speed, float within 0 to 1</li>
<li><code>y</code> Tilt speed, float within 0 to 1</li>
<li><code>zoom</code> Zoom speed, float within 0 to 1</li>
</ul>
<p>If the speed option is omitted, the default speed set by the PTZConfiguration will be used.</p>
</li>
Expand Down Expand Up @@ -465,7 +465,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
37 changes: 20 additions & 17 deletions media.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1276,7 +1276,9 @@ <h1 class="page-title">Source: media.js</h1>
* @param {Object} options.OSDToken
* @param {string} [options.videoSourceConfigurationToken] Token of the Video Source Configuration, which has associated OSDs. Defaults to Active Source
* @param {string} [options.plaintext] Text to overlay
* @param {string} [options.position] UpperLeft, UpperRight, LowerLeft or LowerRight. Default LowerLeft (custom mode currently not implemented)
* @param {object|string} [options.position] String options: UpperLeft, UpperRight, LowerLeft or LowerRight. Default LowerLeft. Or an object with x and y position
* @param {number} [options.position.x] x position of OSD, range: -1 to 1, counting from left to right
* @param {number} [options.position.y] y position of OSD, range: -1 to 1, counting from up to down
* @param {Cam~GetOSDOptionsCallback} callback
*/
Cam.prototype.setOSD = function(options, callback) {
Expand All @@ -1286,21 +1288,22 @@ <h1 class="page-title">Source: media.js</h1>
this._request({
service: mediaType
, body: this._envelopeHeader() +
`&lt;wsdl:SetOSD xmlns:wsdl="${mediaNS}" xmlns:sch="http://www.onvif.org/ver10/schema">
&lt;wsdl:OSD token="${options.OSDToken}">
&lt;sch:VideoSourceConfigurationToken>${(options.videoSourceConfiguationToken || this.activeSource.videoSourceConfigurationToken)}&lt;/sch:VideoSourceConfigurationToken>
&lt;sch:Type>Text&lt;/sch:Type>
&lt;sch:Position>
&lt;sch:Type>${options.position || 'LowerLeft'}&lt;/sch:Type>
&lt;/sch:Position>
&lt;sch:TextString IsPersistentText="false">
&lt;sch:Type>Plain&lt;/sch:Type>
&lt;sch:PlainText>${options.plaintext}&lt;/sch:PlainText>
&lt;/sch:TextString>
&lt;/wsdl:OSD>
&lt;/wsdl:SetOSD>` +

this._envelopeFooter()
`&lt;wsdl:SetOSD xmlns:wsdl="${mediaNS}" xmlns:sch="http://www.onvif.org/ver10/schema">
&lt;wsdl:OSD token="${options.OSDToken}">
&lt;sch:VideoSourceConfigurationToken>${(options.videoSourceConfigurationToken || this.activeSource.videoSourceConfigurationToken)}&lt;/sch:VideoSourceConfigurationToken>
&lt;sch:Type>Text&lt;/sch:Type>
&lt;sch:Position>
&lt;sch:Type>${typeof(options.position) === "object" ? "Custom" : (options.position ? options.position : "LowerLeft")}&lt;/sch:Type>
${typeof(options.position) === "object" ? ("&lt;sch:Pos x=\"" + options.position.x + "\" y=\"" + options.position.y + "\"/>") : ""}
&lt;/sch:Position>
&lt;sch:TextString IsPersistentText="false">
&lt;sch:Type>Plain&lt;/sch:Type>
&lt;sch:PlainText>${options.plaintext}&lt;/sch:PlainText>
&lt;/sch:TextString>
&lt;/wsdl:OSD>
&lt;/wsdl:SetOSD>` +

this._envelopeFooter()
}, function(err, data, xml) {
if (callback) {
callback.call(this, err, err ? null : linerase(data), xml);
Expand Down Expand Up @@ -1402,7 +1405,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion onvif.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
8 changes: 4 additions & 4 deletions ptz.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -480,9 +480,9 @@ <h1 class="page-title">Source: ptz.js</h1>
* /PTZ/ Operation for continuous Pan/Tilt and Zoom movements
* @param options
* @param {string} [options.profileToken=Cam#activeSource.profileToken]
* @param {number} [options.x=0] pan velocity, float within 0 to 1
* @param {number} [options.y=0] tilt velocity, float within 0 to 1
* @param {number} [options.zoom=0] zoom velocity, float within 0 to 1
* @param {number} [options.x=0] pan velocity, float within -1 to 1
* @param {number} [options.y=0] tilt velocity, float within -1 to 1
* @param {number} [options.zoom=0] zoom velocity, float within -1 to 1
* @param {boolean} [options.onlySendPanTilt] Only send the Pan and Tilt values in the ONVIF XML. Zoom not sent in the XML
* @param {boolean} [options.onlySendZoom] 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
Expand Down Expand Up @@ -578,7 +578,7 @@ <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="cam.ht
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Sun Mar 13 2022 15:47:52 GMT+0300 (Moscow Standard Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Tue Dec 20 2022 09:47:51 GMT+0300 (Moscow Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 32c122a

Please sign in to comment.