User's Manual

VIVOTEK
User's Manual - 275
© 2020 VIVOTEK INC. All Right Reserved
126
NAME VALUE SECURITY
(get/set)
DESCRIPTION
npx
0 ~ W,0 ~ H,
0 ~ W,0 ~ H,
0 ~ W,0 ~ H
W: 0~ The
current image
width -1
H: 0~ The current
image height -1
position.
(4 points: x0,y0,x1,y1,x2,y2,x3,y3)
* Only available when
"capability_image_c<0~(n-1)>_privacy
mask_wintype" = polygon.
* Only available when px is listed in
"capability_image_c<0~(n-1)>_privacy
mask_windomain".
win_i<0~(m-1)>_polygo
nstd
0 ~ 9999,0 ~
9999, 0 ~ 9999,0
~ 9999, 0 ~
9999,0 ~ 9999, 0
~ 9999,0 ~ 9999
4/4 Coordinate of polygon window
position.
(4 points: x0,y0,x1,y1,x2,y2,x3,y3)
* Only available when
"capability_image_c<0~(n-1)>_privacy
mask_wintype" = polygon.
* Only available when std is listed in
"capability_image_c<0~(n-1)>_privacy
mask_windomain".
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)
4/4 Pan position of window
position.
* Only available when bit0 of
© 2020 VIVOTEK INC. All Right Reserved
127
NAME VALUE SECURITY
(get/set)
DESCRIPTION
>_maxpan"
"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
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