JVC 257VP, 137, 237VP, VN-H57 Setting Privacy Masking to On/Off, Getting Privacy Masking Color

Page 65

Format /api/param?camera.private_mask.status

Example of response camera.private_mask.status=on&200 OK

Interpretation Acquire the on/off status of privacy masking.

Allowed users admin, operator, user

Setting Privacy Masking to On/Off

Format /api/param?camera.private_mask.status=data

Example of Response camera.private_mask.status&202 Accepted(camera.status=save) Interpretation Change the on/off status of privacy masking. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.

Allowed users admin, operator

Getting Privacy Masking Color

Format /api/param?camera.private_mask.color

Example of response camera.private_mask.color=ffffff&200 OK

Interpretation Acquire the color of privacy masking. RGB values are returned as hexadecimal number. For exmaple, ffffff is white, ff0000 is red, 00ff00 is green, and 0000ff is blue.

Allowed users admin, operator, user

Setting Privacy Masking Color

Format /api/param?camera.private_mask.color=data

Example of Response camera.private_mask.color&202 Accepted(camera.status=save)

Interpretation Change the color of privacy masking. Specify RGB values by hexadecimal number. For exmaple,

fffffffor white, ff0000 for red, 00ff00 for green, and 0000ff for blue.The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.

Allowed users admin, operator

Getting Privacy Masking Area

Format /api/param?camera.private_mask.area

Example of response camera.private_mask.area=ffffff,,,f&200 OK

Interpretation Acquire the area of privacy masking. 510 characters are returned as hexadecimal number that show bitmap. A bit for privacy masking is 32x32 pixels block, and 1920x1080 is divided to 60x34 blocks. For example, f means 8 blocks are masked.

Allowed users admin, operator, user

Setting Privacy Masking Color

65

Image 65
Contents VN-H37/137/237/237VP VN-H57/157WP/257/257VP Updates Page Preface JVC API for Alarm FAQ JVC Protocol Jpeg Streaming Basic ProceduresStreaming Protocol Parameter Description API Format StructureRestrictions ResponseFFD9 Jpeg File Format Sent Out by the cameraJVC Protocol H.264 Streaming H.264 Stream Format Send Out by the camera When API is successfully receivedExample of H.264 Stream JVC Protocol MPEG-4 Streaming MPEG-4 Stream Format Send Out by the camera Example of MPEG-4 Stream URI API to Search CameraJpeg H.264Response Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Using API that Requires Basic AuthenticationProcedure Api/param?ParamA.ParamB.ParamC Getting ParameterApi/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE ParamA.ParamB.ParamC=Data&200 OKGetting Camera ID Setting ParameterJVC API for Camera Example of setting /api/param?camera.id=Camera01 Setting Camera IDGetting Current Scene File Number As follows. /api/param?camera.id=Comment%20In%20JPEGGetting Current Scene File Name Getting Preset Data of Scene FileLoading/Saving/Initializing Scene File Setting Color Level of a Scene File Setting Auto Exposure Reference of a Scene FileGetting Auto Exposure Reference of a Scene File Getting Color Level of a Scene FileSetting 3DDNR of a Scene File Setting Enhance of a Scene FileGetting Enhance of a Scene File Getting 3DDNR of a Scene FileSetting R-Gain of White Balance of a Scene File Setting White Balance of a Scene FileGetting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene FileSetting AGC of a Scene File Setting B-Gain of White Balance of a Scene FileSetting Limit of Sense Up of a Scene File Getting AGC of a Scene FileSetting Shutter Speed of a Scene File Setting ALC priority of Scene FileGetting ALC priority of Scene File Getting Shutter Speed of a Scene FilePage Setting Clvi of a Scene File Setting Back Light Compensation of a Scene FileGetting Back Light Compensation of a Scene File Getting Clvi of a Scene FileGetting Resolution Frame Size Setting Compression FormatJVC API for Encode Getting Compression FormatSetting Rate Control Setting Resolution Frame SizeGetting Rate Control Setting Getting Jpeg File Size Setting Setting H.264 or MPEG-4 bitrateSetting Jpeg File Size Getting H.264 or MPEG-4 I-Frame Interval SettingGetting Frame Rate Setting Setting H.264 or MPEG-4 I-Frame IntervalSetting Frame Rate Setting Monitor Out StatusSetting Audio Duplex Mode Getting Audio Duplex ModeSetting Mike Gain JVC API for Audio VN-H57/157WP/257/257VPGetting Mike Power Supply setting JVC API for AlarmSetting Mike Power Supply Getting On/Off of Alarm ActionFormat /api/param?application.eventNumber.action Getting Alarm ActionApi/param?application.event1.action Example of Response Example of Response application.event1.action=&200 OKReturned. Segments are indicated by Format /api/param?application.eventNumber.action=Data Setting Alarm ActionSetting Example To add JPEG, specify objectNumber instead of none Setting Alarm Filter Getting Alarm Filter SettingSetting Alarm Filter Time Getting Alarm Filter TimeSetting Alarm Filter Type Getting Alarm Filter TypeSetting Alarm Trigger Getting Alarm TriggerFormat /api/param?application.eventNumber.trigger Format /api/param?application.eventNumber.trigger=dataSetting Example /api/param?application.event6.trigger=i1500 JVC API for Alarm EnvironmentSetting Example /api/param?application.event1.trigger=v1 Setting Smtp Server Address Getting Smtp Server Address SettingGetting Smtp Server Port Number Setting Setting Smtp Server Port NumberGetting POP before Smtp Setting Setting Sender Mail AddressSetting POP before Smtp Getting POP Server Address SettingGetting POP Server Port Number Setting Setting POP Server AddressSetting POP Server Port Number Getting POP Server User Name SettingGetting FTP Server Address Setting Setting POP Server PasswordSetting FTP Server Address Example of Response application.pop.user&200 OKSetting FTP Server Path Getting FTP Server Path SettingGetting FTP Server User Name Setting Setting FTP Server User NameSetting File Naming of Periodic FTP Setting FTP Server PasswordApi/param?application.ftp.password=%00 Getting File Naming of Periodic FTPGetting Parameters of Pre/Post Recording for FTP Setting User Define Name of File NamingGetting User Define Name of File Naming Getting SD Card Status Setting Parameters of Pre/Post Recording for FTPJVC API for SD Card Record Setting SD Card Constant Recording On/Off Setting SD Card to Use/DisableGetting Status of SD Card formatting Formatting SD CardGetting SD Card Capacity Setting Encoder No. for SD Card RecordingGetting SD Card Recording Status Getting Encoder No. for SD Card RecordingJVC API for Digital PTZ Getting Auto Return ModeSetting Auto Return Mode Setting Timeout of Auto Return Getting Timeout of Auto ReturnSetting Auto Return Status Getting Speed of Going to Preset PositionSetting Direction of Pan Operation Setting Speed of Going to Preset PositionGetting Pan Position Moving to Specified Pan PositionGetting Pan Operation Status Setting Speed of Pan OperationGetting Tilt Position Moving to Specified Tilt PositionSetting Speed of Tilt Operation Setting Direction of Tilt OperationGetting Tilt Operation Status Getting Zoom PositionSetting Speed of Zoom Operation Setting Direction of Zoom OperationZoom Operation Getting Zoom Operation StatusGetting Status of Specified Preset Position Getting Current Preset PositionRegister Current Position as Preset Position Initialize Preset PositionJVC API for Auto Patrol Setting Preset Postion Number of Auto Patrol Getting Preset Postion Number of Auto PatrolSetting Duarion of Auto Patrol Getting Duration of Auto PatrolSaving Preset Position Number/Duarion of Auto Patrol Setting Speed of Auto PatrolJVC API for Privacy Masking Getting Speed of Auto PatrolSetting Privacy Masking Color Setting Privacy Masking to On/OffGetting Privacy Masking Color Getting Privacy Masking AreaGetting Motion Detect Sensitivity Setting Motion Detect to On/OffSetting Motion Detect Sensitivity Getting Motion Detect Mask Setting Motion Detect MaskJVC API for Tampering Detect Setting Tampering Detect Sensitivity Setting Tampering Detect to On/OffGetting Tampering Detect On/Off Status Getting Tampering Detect SensitivityGetting Dhcp Setting Enabling Network Setting ChangesSetting Dhcp Allowed user adminSetting Subnet Mask Setting IP AddressGetting Default Gateway Getting IP AddressSetting Host Name Setting Default GatewaySetting DNS Server Status to On/Off, or Validate Changes Getting Host NameSetting IPv6 status Setting DNS Server IP AddressGetting DNS Server IP Address Getting IPv6 statusGetting Global Address of IPv6 Setting TOS Value of StreamGetting MAC Address Getting TOS Value of StreamSetting Multicast TTL Setting Unicast TTLGetting Unicast TTL Value Getting Multicast TTL ValueGetting Network Negotiation Setting Setting MTU ValueSetting Network Negotiation JVC API for ProtocolSetting Status of AMX Discovery Protocol Setting Port Number of HttpSetting Status of Psia Protocol Getting Status of AMX Discovery ProtocolSetting Status of Multicast Streaming, or Save Changes Setting Status of Onvif ProtocolJVC API for Multicast Streaming Getting Status of Onvif ProtocolSetting Multicast Port Number Setting Multicast AddressGetting Multicast Address Getting Multicast Port NumberGetting Audio Multicast Address Setting Frame Rate of Jpeg MulticastGetting Status of Audio Multicast Streaming Setting Audio Multicast Address JVC API for Access RestrictionsSetting Audio Multicast Port Number Getting Deny/Allow Setting of Client RestrictionsGetting IP Address Setting of Restricted Client Setting Client Restriction to Deny/AllowSetting IP Address of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumberSetting NTP Server Address Setting On/Off of Sntp Client, or Validate ChangesJVC API for Time Getting On/Off of Sntp ClientSetting Access Interval to NTP Server Getting Access Interval to NTP ServerGetting Access Interval Unit of NTP Setting Access Interval Unit of SntpGetting Timezone Setting TimeSetting Timezone JVC API for PasswordSetting Password of admin Format /api/param?system.password.adminnum=data2Setting Password of operator JVC API for MaintenanceSetting Password of user Delete AcountJVC API for LED Setting Setting LED blinking mode Getting LED blinking modeJVC API for Getting Status Getting Sending StatusGetting Log Alarm input 1ch makeGetting Model Name Format /api/param?system.logGetting Mode of FTP Server Getting Alarm Input Status VN-H57/157/257JVC API for Others Getting Firmware RevisionsSetting Control Port Number of FTP Server Setting Mode of FTP ServerSetting Port Number of Rtsp Server Getting Control Port Number of FTP ServerExample /api/param?network.rtsp.port=554 Camera Sending Audio to the Camera VN-H57/157WP/257/257VP Response When API is successfully receivedCamera ProceduresPlayback control Getting SD Card data from the Camera via RTSP/RTPExample of message sequence 1fCRLF Exporting H.264 data from SD Card to the PCGetting Total Number of Files and File Size Exporting SD Card Data as a File Customizing Built-in Viewer List of Protocols and Port Numbers UsedList of ActiveX Protocol / Port Number UseProperties of ActiveX How to download ActiveX controls102 Direction Number of n How to use ActiveX Control by HtmlMethod of ActiveX Control Sample code Html Sample105 106 107 Psia FAQ