Get or Set the configurations of privacy mask.
In privacy mask, the encoder could mask a specific area to become unreadable. This could protect the privacy in security monitoring application. This specific area is a rectangle region which it masks the original image. This is done in the camera DSP.
All PlatformA encoders
The region is fixed to 1 in all PlatformA encoders because it just has one region for privacy mask. And this region is shared with text overlay functions.
With PTZ cameras, the privacy mask location and masking size do not adapt with the pan, tilt and zoom movement. Therefore, the privacy mask should not be used in PTZ cameras.
All PlatformT encoders
In PlatformT encoders, there are 4 regions for privacy mask. These 4 regions are shared with text overlay functions. Because the privacy mask is only available in the media 1 stream, the privacy region is only be functional when the streaming mode is single. This protects the mask regions could be seen from media 2 stream. Be aware of that the text overlay is only available in media 1 stream but it could be enabled in dual streaming mode.
The URL will not check the video streaming mode is single or dual. The users have to take care this security issue when privacy mask is enabled. The firmware will NOT disable the privacy regions when it is in dual stream mode.
For WEB design, the warning massage has to be shown when the video streaming mode was changed to dual streams and the privacy mask was enabled. The warning message is defined in PlatformTOSD.pdf. The privacy configuration on WEB should be hided when the video streaming mode is dual.
Here is the configuration flow of privacy region and streaming mode on WEB page.
With speed dome cameras, the privacy mask location and masking size do not adapt with the pan, tilt and zoom movement. Therefore, the privacy mask should not be used in speed dome cameras.
In read command, the return of this URL will list down the settings of all privacy regions.
In PlatformA and PlatformT encoders, because the text overlay and privacy mask shared the OSD window, the text overlay should be disabled automatically if the privacy mask is enabled by this URL.
The color of the privacy mask region could be defined by users. The format of color is RRGGBB where RR, GG and BB are the color level of red, green and blue. The values in RR, GG and BB are hexadecimal. For example, ff0000 is for red, ffffff is for black.
Region,State,Color,sx,sy,ex,ey where
Region: the region ID of the privacy mask. It should be in the range of 1 ~ 4.
State: 0:Disable, 1:Enable.
Color: RRGGBB (0x00~0xFF for each color level)
(sx,sy): location in up-left corner of the privacy mask region
(ex,ey): location in down-right corner of the privacy mask region
PRIVACY_REGION='1,1,ffffff,48,64,96,128'
OK: PRIVACY_REGION='1,1,ffffff,48,64,96,128'
or
ERROR: PRIVACY_REGION='1,1,ffffff,48,64,96,128'
Valid
OSD_FORMAT
http://ip:port/cgi-bin/encoder?USER=Admin&PWD=123456&PRIVACY_REGION
or
http://ip:port/cgi-bin/cmd/encoder?PRIVACY_REGION
http://ip:port/cgi-bin/encoder?USER=Admin&PWD=123456&PRIVACY_REGION=1,1,ffffff,48,64,96,128
or
http://ip:port/cgi-bin/cmd/encoder?PRIVACY_REGION=1,1,ffffff,48,64,96,128
HOME, ENCODER CGI