User Manual

VIVOTEK
User's Manual - 259
© 2019 VIVOTEK INC. All Right Reserved
116
7.26 3D Privacy Mask
Group: privacymask3d_c<0~(n-1)> for n channel products and m privacy mask window.
(capability_image_c<0~(n-1)>_privacymask_wintype = 3Drectangle)
n denotes the value of "capability_nvideoin" and m denotes the value of
"capability_videoin_c<0~(n-1)>_nprivacymask"
NAME VALUE SECURITY
(get/set)
DESCRIPTION
enable <boolean> 4/4 Enable the 3D privacy mask
color 0~"
capability_image_c<0~(n-
1)>_privacymask_ncolor"
-1
4/4 Privacy mask color
win_i<0~(m-1)>_name string[40] 4/4 Name of the privacy mask
window.
win_i<0~(m-1)>_pan "capability_ptz_c<0~(n-1)
>_minpan" ~
"capability_ptz_c<0~(n-1)
>_maxpan"
4/4 Pan position of window
position.
* Only available when bit0 of
"capability_camctrl_c<0~(n-1)>_
buildinpt" is "1"
win_i<0~(m-1)>_tilt "capability_ptz_c<0~(n-1)
>_mintilt" ~
"capability_ptz_c<0~(n-1)
>_maxtilt"
4/4 Tilt position of window position.
* Only available when bit1 of
"capability_camctrl_c<0~(n-1)>_
buildinpt" is "1"
win_i<0~(m-1)>_zoom "capability_ptz_c<0~(n-1)
>_minzoom" ~
"capability_ptz_c<0~(n-1)
>_maxzoom"
4/4 Zoom position of window
position.
win_i<0~(m-1)>_fliped <boolean> 4/4 Flip side of window position.
0: Non-flip side
1: Flip side
© 2019 VIVOTEK INC. All Right Reserved
117
7.27 Capability
Group: capability
NAME VALUE SECURITY
(get/set)
DESCRIPTION
api_httpversion <string>
This number start
with 0301a.
0/7 The version of VIVOTEK WebAPI with
4 integers plus 1 alphabet, There are
composed by "major version", "minor
version", "revision","_platform". ex:
0301a_1
Major version
Increase the major version when
change, remove the old
features/interfaces or the firmware
has substantially change in
architecture and not able to roll back
to previous version. This may cause
incompatibility with supporting
software.
Minor version
Increase the minor version when add
new features/interfaces without
change the old features and
interfaces.
Revision
Increase the revision when fix bugs
without change any features of the
output.
_platform
This is a constant, it is used to
distinguish between different
platforms
API version format:
MMmmr_k
Where "MM" is the major version,
"mm" is the minor version and "r" is
the revision.