JVC VN-V686UAPI manual Setting Status of a Privacy Masking Area for VN-V686

Page 75

number.

Allowed users admin, operator, user

Setting Status of a Privacy Masking Area for VN-V686

Format /api/param?camera.private_mask.area(number).status=data

Example of Response camera.private_mask.area(number).status&202

Accepted(camera.status=save)

Interpretation Change each status of privacy masking area. Specify from 0 to 7 as area number. Specify "on" or "off". 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 Brightness from VN-V686

Format /api/param?camera.private_mask.color

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

Interpretation Acquire the brightness of privacy masking. RGB values are returned as hexadecimal number. For exmaple, ffffff is white, 808080 is gray, 000000 is black. The brightness is 11 steps internally.

Allowed users admin, operator, user

Setting Privacy Masking Brightness for VN-V686

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

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

Interpretation Change the brightness of privacy masking. Specify RGB values by hexadecimal number. For exmaple, ffffff for white, 808080 for gray, 000000 for black.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

Start/Save Editing of Privacy Masking for VN-V686

Format /api/param?camera.private_mask.area(number).status=data

Example to start editing /api/param?camera.private_mask.area(0).status=edit Example to save editing /api/param?camera.private_mask.area(0).status=save Example to clear setting /api/param?camera.private_mask.area(0).status=clear Example to quit editing without save

/api/param?camera.private_mask.area(0).status=exit

Example of Response camera.private_mask.area(0).status&200 OK

Interpretation Start editing of a privacy masking area. Specify from 0 to 7 as area number. Specify "edit", "save",

75

Image 75
Contents VN-V686U Updates Custom Application Software Development Guide Content Host 192.168.0.2CRLFCRLF Basic ProceduresPage Response When API is successfully received with boundary=on API Format StructureParameter Description When API is successfully received with boundary=off RestrictionsJpeg File Format Sent Out by VN-V686 190.00 .00 corresponds to -5 degrees Getting MPEG-4 from VN-V686 via Http Page Response When API is successfully received MPEG-4 Stream Format Sent Out by VN-V686 VOL VOP Search VN-V686 in LANProcedure Getting Alarm from VN-V686Encoded User Name and Password General Camera Saving Changes of Camera Settings Setting Camera ID in Jpeg from VN-V686Getting Camera ID stored in Jpeg from VN-V686 Getting Black level from VN-V686 Setting Monitor Type for VN-V686Setting Black level for VN-V686 Getting Monitor Type from VN-V686Getting Active Gamma Level from VN-V686 Setting Gamma for VN-V686Setting Active Gamma Level for VN-V686 Getting Gamma from VN-V686Getting Enhance from VN-V686 Setting Enhance Band for VN-V686Setting Enhance for VN-V686 Getting Enhance Band from VN-V686Getting Stabilizer from VN-V686 Setting Color Level for VN-V686Setting Stabilizer for VN-V686 Getting Color Level from VN-V686Getting DNR from VN-V686 Setting Stabilizer Level for VN-V686Setting DNR for VN-V686 Getting Stabilizer Level from VN-V686Getting Limit of Sense Up from VN-V686 Setting AGC for VN-V686Setting Limit of Sense Up for VN-V686 Getting AGC from VN-V686Getting Shutter Speed from VN-V686 Setting ALC priority for VN-V686Setting Shutter Speed for VN-V686 Getting B&W Mode from VN-V686Getting Light setting for focus in B&W mode from VN-V686 Setting B&W Mode for VN-V686Getting Auto Focus mode for B&W switching from VN-V686 Setting Auto Focus mode for B&W switching for VN-V686Setting Light for focus in B&W mode for VN-V686 Saving Image Settings for Auto Pan and Auto TraceGetting Iris from VN-V686 Getting White Balance from VN-V686 Setting Iris for VN-V686Setting Iris Direction for VN-V686 Operating Iris for VN-V686Getting B-Gain of White Balance from VN-V686 Setting White Balance for VN-V686Setting R-Gain of White Balance for VN-V686 Getting R-Gain of White Balance from VN-V686Getting Back Light Compensation from VN-V686 Setting B-Gain of White Balance for VN-V686Getting Current R-Gain of Auto White Balance from VN-V686 Getting Current B-Gain of Auto White Balance from VN-V686Getting Jpeg Frame Size from VN-V686 Setting Back Light Compensation for VN-V686Encoding Saving Changes of Encode Settings for VN-V686 Setting Jpeg Frame Size for VN-V686Setting Jpeg File Size Setting for VN-V686 Getting Jpeg Rate Control Setting from VN-V686Setting Jpeg Rate Control for VN-V686 Getting Jpeg File Size Setting from VN-V686Getting MPEG-4 Frame Size from VN-V686 Setting MPEG-4 Frame Size for VN-V686Setting MPEG-4 Rate Control for VN-V686 Getting MPEG-4 bitrate Setting from VN-V686Setting MPEG-4 bitrate Setting for VN-V686 Getting MPEG-4 Rate Control Setting from VN-V686Getting MPEG-4 Priority Setting from VN-V686 Setting MPEG-4 Frame Rate Setting for VN-V686Getting MPEG-4 I-Frame Interval Setting from VN-V686 Setting MPEG-4 I-Frame Interval Setting for VN-V686Format /api/param?application.eventNumber.status=data Setting MPEG-4 Priority Setting for VN-V686Alarm Setting Getting On/Off of Alarm Action from VN-V686 Format /api/param?application.eventNumber.statusExample of Response application.event1.action=&200 OK Getting Alarm Action from VN-V686Format /api/param?application.eventNumber.action Api/param?application.event1.actionSetting Alarm Action for VN-V686 Format /api/param?application.eventNumber.action=DataSsage Alarm%20ON Getting Alarm Filter Setting from VN-V686 Setting Alarm Filter for VN-V686Api/param?application.event1.filtersunday.status=on Setting Alarm Filter Time for VN-V686 Getting Alarm Filter Time from VN-V686Api/param?application.event1.filtersunday.type=unmask Getting Alarm Filter Type from VN-V686Setting Alarm Filter Type for VN-V686 Getting Alarm Trigger from VN-V686Api/param?application.event1.trigger=m1 Setting Alarm Trigger for VN-V686Example of Response application.event1.trigger=v1&200 OK Format /api/param?application.eventNumber.trigger=dataSetting Smtp Server Address for VN-V686 Setting Example /api/param?application.event1.trigger=v1Setting Example /api/param?application.event6.trigger=i1500 Setting Sender Mail Address for VN-V686 Getting Smtp Server Port Number Setting from VN-V686Setting Smtp Server Port Number for VN-V686 Getting Sender Mail Address Setting from VN-V686Setting POP Server Address for VN-V686 Getting POP before Smtp Setting from VN-V686Setting POP before Smtp for VN-V686 Getting POP Server Address Setting from VN-V686Example of setting /api/param?application.pop.user=somename Setting POP Server Port Number for VN-V686Getting POP Server User Name Setting from VN-V686 Setting POP Server User Name for VN-V686Getting FTP Server Path Setting from VN-V686 Setting POP Server Password for VN-V686Getting FTP Server Address Setting from VN-V686 Setting FTP Server Address for VN-V686Getting File Naming of Periodic FTP from VN-V686 Getting FTP Server User Name Setting from VN-V686Setting FTP Server User Name for VN-V686 Setting FTP Server Password for VN-V686Setting File Naming of Periodic FTP for VN-V686 Example of Response application.ftp.naming=default&200 OKGetting User Define Name of File Naming from VN-V686 Setting User Define Name of File Naming for VN-V686 Setting Parameters of Pre/Post Recording for VN-V686Getting Parameters of Pre/Post Recording from VN-V686 Changing Alarm Output of VN-V686 Getting Alarm Output Time Setting from VN-V686Setting Alarm Output Time for VN-V686 Getting Alarm Output Status from VN-V686Setting Timeout of Auto Return for VN-V686 Getting Auto Return Mode from VN-V686Setting Auto Return Mode for VN-V686 Getting Timeout of Auto Return from VN-V686Setting Auto Return Status for VN-V686 Getting Auto Return Status from VN-V686Start/Stop of Auto Tracking for VN-V686 Getting Restart Time of Auto Tracking from VN-V686 Setting Detection Level of Auto Tracking for VN-V686Specify target for Intelligent Tracking for VN-V686 Getting Detection Level of Auto Tracking from VN-V686Format /api/param?camera.motion.autotracking2.area Setting Restart Time of Auto Tracking for VN-V686Setting Detection Area of Intelligent Tracking for VN-V686 Getting Detection Area of Intelligent Tracking from VN-V686Getting Maximum Zoom of Intelligent Tracking from VN-V686 Setting Tracking Zoom of Intelligent Tracking for VN-V686Setting Zoom Limit of Intelligent Tracking for VN-V686 Getting Zoom Limit of Intelligent Tracking from VN-V686Getting Dead Zone of Intelligent Tracking from VN-V686 Setting Maximum Zoom of Intelligent Tracking for VN-V686Setting Threshold of Intelligent Tracking for VN-V686 Getting Threshold of Intelligent Tracking from VN-V686Getting Upper Limit of EZoom from VN-V686 Setting Dead Zone of Intelligent Tracking for VN-V686Setting Upper Limit of EZoom for VN-V686 Setting On/Off of Pan Limit for VN-V686Getting Right Side of Pan Limit from VN-V686 Setting Left Side of Pan Limit for VN-V686Setting Right Side of Pan Limit for VN-V686 Getting Left Side of Pan Limit from VN-V686Getting Auto Flip Setting from VN-V686 Setting Tilt Limit for VN-V686Getting Speed of Going to Preset Position from VN-V686 Setting Speed of Going to Preset Position for VN-V686Setting Auto Flip for VN-V686 Getting Current Status of Digital Flip from VN-V686Getting Pan Position from VN-V686 Pan Operation for VN-V686 Setting Direction of Pan Operation for VN-V686Setting Speed of Pan Operation for VN-V686 Moving to Specified Pan Position for VN-V686Tilt Operation for VN-V686 Setting Status of Variable Pan/Tilt Speed for VN-V686Getting Tilt Position from VN-V686 Moving to Specified Tilt Position for VN-V686Getting Zoom Position from VN-V686 Setting Direction of Tilt Operation for VN-V686Setting Speed of Tilt Operation for VN-V686 Getting Tilt Operation Status from VN-V686Getting Zoom Operation Status from VN-V686 Setting Direction of Zoom Operation for VN-V686Setting Speed of Zoom Operation for VN-V686 Zoom Operation for VN-V686Focus Operation for VN-V686 Setting Direction of Focus Operation for VN-V686Setting Speed of Focus Operation for VN-V686 Moving to Specified Focus Position for VN-V686Initialize Preset Position for VN-V686 Getting Current Preset Position from VN-V686Getting Status of Specified Preset Position from VN-V686 Register Current Position as Preset Position for VN-V686Getting Status of Auto Pan from VN-V686 Moving to Preset Position for VN-V686Getting Title of Preset Position from VN-V686 Setting Title to Preset Position for VN-V686Getting Speed of Auto Pan from VN-V686 Setting Direction of Auto Pan for VN-V686Setting Speed of Auto Pan for VN-V686 Getting Direction of Auto Pan from VN-V686Api/param?camera.motion.autotrace.record.status=start Getting Status of Auto Trace from VN-V686Start/Stop of Auto Trace for VN-V686 Start/Stop of Auto Trace Recording for VN-V686Getting Status of Auto Trace Recording from VN-V686 Auto Patrol Start/Stop of Auto Patrol for VN-V686Getting Status of Auto Patrol from VN-V686 Getting Duration of Auto Patrol from VN-V686 Getting Preset Postion Number of Auto Patrol from VN-V686Setting Preset Postion Number of Auto Patrol for VN-V686 Setting Duarion of Auto Patrol for VN-V686Getting Status of a Privacy Masking Area from VN-V686 Setting Whole Status of Privacy Masking for VN-V686Start/Save Editing of Privacy Masking for VN-V686 Setting Status of a Privacy Masking Area for VN-V686Setting Privacy Masking Brightness for VN-V686 Getting Privacy Masking Brightness from VN-V686Setting Width of Privacy Masking Area for VN-V686 Setting Height of Privacy Masking Area for VN-V686Setting Motion Detect to On/Off for VN-V686 Getting Motion Detect Mask from VN-V686 Setting Motion Detect Sensitivity for VN-V686Setting Motion Detect Mask for VN-V686 Getting Motion Detect Sensitivity from VN-V686Network Basics Enabling Network Setting Changes Getting Dhcp Setting from VN-V686Setting Dhcp for VN-V686 Getting IP Address from VN-V686 Setting IP Address for VN-V686Setting Subnet Mask for VN-V686 Getting Default Gateway from VN-V686Getting DNS Server On/Off Status from VN-V686 Setting Default Gateway for VN-V686Setting Host Name for VN-V686 Getting Host Name from VN-V686Network Details Getting TOS Value of Jpeg from VN-V686 Setting DNS Server IP Address for VN-V686Getting DNS Server IP Address from VN-V686 Getting MAC Address from VN-V686Getting TOS Value of MPEG-4 from VN-V686 Setting TOS Value of Jpeg for VN-V686Setting TOS Value of MPEG-4 for VN-V686 Setting Unicast TTL for VN-V686Getting MTU Value VN-V686 Setting Multicast TTL for VN-V686Setting MTU Value for VN-V686 Getting Multicast TTL Value from VN-V686Protocol Getting Port Number of Http from VN-V686 Getting Network Negotiation Setting from VN-V686Setting Network Negotiation for VN-V686 Setting Port Number of Http for VN-V686Getting Jpeg Multicast Address from VN-V686 Setting Jpeg Multicast Address for VN-V686Getting Frame Rate of Jpeg Multicast from VN-V686 Setting Jpeg Multicast Port Number for VN-V686Setting Frame Rate of Jpeg Multicast for VN-V686 Getting Jpeg Multicast Port Number from VN-V686Setting MPEG-4 Multicast Address for VN-V686 Getting MPEG-4 Multicast Address from VN-V686Getting MPEG-4 Multicast Port Number from VN-V686 Setting MPEG-4 Multicast Port Number for VN-V686 Setting Client Restriction to Deny/Allow for VN-V686Format /api/param?network.accesscontrolstreamout.hostNumber Time Getting On/Off of Sntp Client from VN-V686 Setting IP Address of Restricted Client for VN-V686Network.accesscontrolstreamout.host1=10.0.0.0/24&200 OK Example /api/param?network.accesscontrolstreamout.host1=%00Getting NTP Server Address from VN-V686 Setting NTP Server Address for VN-V686Getting Access Interval to NTP Server from VN-V686 Setting Access Interval to NTP Server for VN-V686Getting Time from VN-V686 Getting Access Interval Unit of NTP from VN-V686Setting Access Interval Unit of Sntp for VN-V686 Setting Time for VN-V686GMT-9 Setting Timezone for VN-V686 Password Setting Password for VN-V686Format /api/param?system.password.data1=data2 Setting Auto Cleaning for VN-V686 Maintenance InitializationFirmware Update Getting Status of Auto Cleaning from VN-V686Setting Time of Auto Cleaning for VN-V686 Getting Status Getting Sending StatusFormat /api/param?system.session Getting Settings Getting Model Name Getting LogGetting Firmware Revisions of Streaming Manager Getting Firmware Revisions of Lens Getting Alarm Input Status from VN-V686Getting Firmware Revisions of PTZ Controller Getting Firmware Revisions of Image ProcessorGetting Control Port Number of FTP Server from VN-V686 Getting Mode of FTP Server from VN-V686Setting Mode of FTP Server for VN-V686 Setting Control Port Number of FTP Server for VN-V686List of Protocols and Port Numbers Used with VN-V686 Methods of ActiveX Getting Multicast Seamless Switching 103 104 FAQ