Difference between revisions of "Axis Module"
IVSWikiBlue (talk | contribs) (Created page with "==privacyenabled== ===Usage=== Connects to the axis camera and returns True if the privacy mask is enabled and False if it is not. ===Parameters=== axis.privacyenabled(camera,...") |
IVSWikiBlue (talk | contribs) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
==privacyenabled== | ==privacyenabled== | ||
===Usage=== | ===Usage=== | ||
− | Connects to the | + | Connects to the Axis camera and returns True if the Privacy Mask is Enabled, or False if it is not. |
===Parameters=== | ===Parameters=== | ||
− | axis.privacyenabled(camera,username,password) | + | <pre>axis.privacyenabled(camera,username,password)</pre> |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 12: | Line 12: | ||
|camera | |camera | ||
|String | |String | ||
− | |IP address of the | + | |IP address of the Axis camera. |
|- | |- | ||
|username | |username | ||
Line 23: | Line 23: | ||
|} | |} | ||
===Example=== | ===Example=== | ||
− | if axis.privacyenabled('192.168.0.90','root','pass'): | + | <pre>if axis.privacyenabled('192.168.0.90','root','pass'):</pre> |
+ | |||
==enableprivacy== | ==enableprivacy== | ||
===Usage=== | ===Usage=== | ||
− | Connects to the | + | Connects to the Axis camera and does the following: |
− | * Enables the | + | * Enables the Privacy Mask |
− | * Mutes the | + | * Mutes the Audio |
* Moves the cameras to a Privacy preset. | * Moves the cameras to a Privacy preset. | ||
* Disables PTZ Functionality | * Disables PTZ Functionality | ||
===Parameters=== | ===Parameters=== | ||
− | axis.enabledprivacy(camera,username,password) | + | <pre>axis.enabledprivacy(camera,username,password)</pre> |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 41: | Line 42: | ||
|camera | |camera | ||
|String | |String | ||
− | |IP address of the | + | |IP address of the Axis camera. |
|- | |- | ||
|username | |username | ||
Line 52: | Line 53: | ||
|} | |} | ||
===Example=== | ===Example=== | ||
− | axis.enableprivacy('192.168.0.90','root','pass') | + | <pre>axis.enableprivacy('192.168.0.90','root','pass')</pre> |
+ | |||
==disableprivacy== | ==disableprivacy== | ||
===Usage=== | ===Usage=== | ||
− | Connects to the | + | Connects to the Axis camera and does the following: |
− | * Disables the | + | * Disables the Privacy Mask |
− | * Unmutes the | + | * Unmutes the Audio |
* Enables PTZ Functionality | * Enables PTZ Functionality | ||
===Parameters=== | ===Parameters=== | ||
− | axis.disabledprivacy(camera,username,password) | + | <pre>axis.disabledprivacy(camera,username,password)</pre> |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 69: | Line 71: | ||
|camera | |camera | ||
|String | |String | ||
− | |IP address of the | + | |IP address of the Axis camera. |
|- | |- | ||
|username | |username | ||
Line 80: | Line 82: | ||
|} | |} | ||
===Example=== | ===Example=== | ||
− | axis.disableprivacy('192.168.0.90','root','pass') | + | <pre>axis.disableprivacy('192.168.0.90','root','pass')</pre> |
+ | |||
==gotopreset== | ==gotopreset== | ||
===Usage=== | ===Usage=== | ||
− | Connects to the | + | Connects to the Axis camera and does the following: |
− | * Enables the | + | * Enables the Privacy Mask |
− | * Mutes the | + | * Mutes the Audio |
* Moves the cameras to a Privacy preset. | * Moves the cameras to a Privacy preset. | ||
* Disables PTZ Functionality | * Disables PTZ Functionality | ||
===Parameters=== | ===Parameters=== | ||
− | axis.gotopreset(camera,username,password,preset) | + | <pre>axis.gotopreset(camera,username,password,preset)</pre> |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Line 98: | Line 101: | ||
|camera | |camera | ||
|String | |String | ||
− | |IP address of the | + | |IP address of the Axis camera. |
|- | |- | ||
|username | |username | ||
Line 110: | Line 113: | ||
|preset | |preset | ||
|String | |String | ||
− | |Name of the preset previous defined in the '''camera.''' This is primarily used as part of the | + | |Name of the preset previous defined in the '''camera.''' This is primarily used as part of the Enable Privacy subroutine. |
|} | |} | ||
===Example=== | ===Example=== | ||
− | axis.gotopreset('192.168.0.90','root','pass',"Preset1"): | + | <pre>axis.gotopreset('192.168.0.90','root','pass',"Preset1"):</pre> |
Latest revision as of 11:57, 17 May 2019
Contents
privacyenabled
Usage
Connects to the Axis camera and returns True if the Privacy Mask is Enabled, or False if it is not.
Parameters
axis.privacyenabled(camera,username,password)
Parameter | Type | Value |
camera | String | IP address of the Axis camera. |
username | String | Valt Username |
password | String | Valt Password |
Example
if axis.privacyenabled('192.168.0.90','root','pass'):
enableprivacy
Usage
Connects to the Axis camera and does the following:
- Enables the Privacy Mask
- Mutes the Audio
- Moves the cameras to a Privacy preset.
- Disables PTZ Functionality
Parameters
axis.enabledprivacy(camera,username,password)
Parameter | Type | Value |
camera | String | IP address of the Axis camera. |
username | String | Valt Username |
password | String | Valt Password |
Example
axis.enableprivacy('192.168.0.90','root','pass')
disableprivacy
Usage
Connects to the Axis camera and does the following:
- Disables the Privacy Mask
- Unmutes the Audio
- Enables PTZ Functionality
Parameters
axis.disabledprivacy(camera,username,password)
Parameter | Type | Value |
camera | String | IP address of the Axis camera. |
username | String | Valt Username |
password | String | Valt Password |
Example
axis.disableprivacy('192.168.0.90','root','pass')
gotopreset
Usage
Connects to the Axis camera and does the following:
- Enables the Privacy Mask
- Mutes the Audio
- Moves the cameras to a Privacy preset.
- Disables PTZ Functionality
Parameters
axis.gotopreset(camera,username,password,preset)
Parameter | Type | Value |
camera | String | IP address of the Axis camera. |
username | String | Valt Username |
password | String | Valt Password |
preset | String | Name of the preset previous defined in the camera. This is primarily used as part of the Enable Privacy subroutine. |
Example
axis.gotopreset('192.168.0.90','root','pass',"Preset1"):