PRIVACY_REGION

 

Description

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. The following figure illustrates the mask in black on the video image.

The privacy masking function is very from different platform (generation) encoders.

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.
When video resolution was changed, user has to set the privacy mask configurations again.
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.
The text overlay will be disabled automatically if the privacy mask is enabled by this URL.

All PlatformT/K encoders

There are 4 OSD regions for privacy mask and text overlay. Every OSD region could be configured to text overlay or privacy mask. When privacy mask in an OSD region is set, the text overlay function in this OSD region is disabled automatically.
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. This 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.
When video resolution was changed, user has to set the privacy mask configurations again.

For WEB design, the warning massage has to be shown when the video streaming mode was changed to dual streams when the privacy mask was enabled. The warning message is defined in configuration flow of privacy region and streaming mode on WEB page. The privacy configuration on WEB should be hided when the video streaming mode is dual.

With TCM-6630 speed dome, 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.
With zoom lens cameras, the masking size will not adjust when zooming. User should avoid using privacy masking function if zoom function is used in runtime.
In KCM-8111 and KCM-8211 PTZ camera, the privacy mask function in NOT available.

In read command, the return of this URL will list down the settings of all privacy regions.

Dxx, Exx, Bxx and Ixx cameras

There are four privacy mask regions in the camera and used in video stream 1 and 2. When a privacy mask region is enabled, the mask will be applied to video stream 1 and 2. The video stream 1 is used to set the mask location and size. Therefore, the CHANNEL command with this URL is ignored. Firmware scales the mask location and size to fit the video stream 2 if the video resolutions in video stream 1 and 2 are different. When video resolution in video stream 1 or 2 was changed, the firmware will NOT adapt the mask location and size to fit new video resolution. And, the mask function will be disabled if the mask window is out of video resolution. That means user has to set the privacy mask configurations for new video resolution.
The privacy mask function and text overlay function are independent. Enabling privacy mask function will not disable text overlay function.
The mask color in privacy mask region 3 and 4 are the same. Change the one of these two mask region color will change the other one. The mask region 1 and 2 have their own mask color settings.
Overlaying mask regions cause the mask function becomes abnormal. The firmware does not return error when you overlap the masks. You should avoid doing it.

Input Argument

Region,State,Color,sx,sy,ex,ey where
Input argument Possible Value Description
Region 1,2,3,4 the region ID of the privacy mask
In PlatformA, this is fixed to 1.
State 0, 1 0: Disabled, 1: Enabled
Color RRGGBB 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.
sx,sy see Note location in pixel in up-left corner of the privacy mask region
ex,ey see Note location in down-right corner of the privacy mask region
Note:
1. The size of mask has to be larger than 12x18 pixels in PlatformA/T/K devices.
2. The size of mask has to be larger than 1x1 pixels in Dxx, Exx, Bxx and Ixx cameras
3. The mask region has to inside the video image. Due to encoder design limitation, the mask function might not mask whole video image.

Attribute

Return of Message

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'

Applicability

Status

Valid

See Also

OSD_FORMAT

Example

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

Back to

HOME, ENCODER CGI