JVC VN-V686U manual Alarm Setting Getting On/Off of Alarm Action from VN-V686

Page 35

The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator

6.4. Alarm Setting

The APIs below are related to alarm setting. These are equivalent to the features on the Alarm page of the WEB setting page. Refer to the instruction manual for details on the Alarm page.

Getting On/Off of Alarm Action from VN-V686

Format /api/param?application.event(Number).status

Example When Getting the on/off status of alarm action No. 1

/api/param?application.event(1).status

Example of response application.event(1).status=on&200 OK

Interpretation Acquire the on/off status of the alarm action for the specified alarm action number. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Either on or off is returned.

Allowed users admin, operator

Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V686

Format /api/param?application.event(Number).status=data

Example When setting alarm action No. 1 to off

/api/param?application.event(1).status=off

Example of response application.event(1).status&200 OK

Interpretation Set the alarm action of the specified alarm action number to on/off, or enable changes to the alarm action. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Either on or off will be returned.

Specify "on", "off" or "restart". By "restart", changes to alarm action and alarm trigger are enabled. By "on" after "restart", the alarm action starts working with the changed settings. If "restart" is not set after changes to alarm action and alarm trigger, APIs to get settings of alarm action and alarm trigger return previous values.

Allowed users admin, operator

Getting Alarm Action from VN-V686

Format /api/param?application.event(Number).action

Example When Getting action of alarm action No. 1

/api/param?application.event(1).action

35

Image 35
Contents VN-V686U Updates Custom Application Software Development Guide Content Getting Jpeg from VN-V686 via Http Basic ProceduresAPI Format Structure Parameter Description Response When API is successfully receivedJpeg File Format Sent Out by VN-V686 RestrictionsGetting MPEG-4 from VN-V686 via Http VN-V686 returns Http response Example encode=mpeg4 MPEG-4 Stream Format Sent Out by VN-V686 20070319161455123UTC Search VN-V686 in LAN ProcedureUsing API that Requires Basic Authentication ParamA.ParamB.ParamC&401 Unauthorized GeneralApi/param?ParamA.ParamB.ParamC ParamA.ParamB.ParamC=Data&200 OKParamA.ParamB.ParamC&200 OK Camera Saving Changes of Camera SettingsGetting Camera ID stored in Jpeg from VN-V686 Api/param?ParamA.ParamB.ParamC=DataGetting Monitor Type from VN-V686 Setting Camera ID in Jpeg from VN-V686Setting Monitor Type for VN-V686 Example of setting /api/param?camera.id=Camera01Getting Gamma from VN-V686 Setting Black level for VN-V686Setting Gamma for VN-V686 Getting Black level from VN-V686Getting Enhance Band from VN-V686 Setting Active Gamma Level for VN-V686Setting Enhance Band for VN-V686 Getting Active Gamma Level from VN-V686Getting Stabilizer from VN-V686 Setting Enhance for VN-V686Setting Color Level for VN-V686 Getting Color Level from VN-V686Getting DNR from VN-V686 Setting Stabilizer for VN-V686Setting Stabilizer Level for VN-V686 Getting Stabilizer Level from VN-V686Getting AGC from VN-V686 Setting DNR for VN-V686Setting AGC for VN-V686 Setting Limit of Sense Up for VN-V686Getting Shutter Speed from VN-V686 Setting ALC priority for VN-V686Setting Shutter Speed for VN-V686 Getting ALC priority from VN-V686Setting Auto Focus mode for B&W switching for VN-V686 Getting B&W Mode from VN-V686Setting B&W Mode for VN-V686 Getting Auto Focus mode for B&W switching from VN-V686Saving Image Settings for Auto Pan and Auto Trace Getting Light setting for focus in B&W mode from VN-V686Setting Light for focus in B&W mode for VN-V686 Operating Iris for VN-V686 Setting Iris for VN-V686Setting Iris Direction for VN-V686 Getting Iris from VN-V686Getting R-Gain of White Balance from VN-V686 Setting White Balance for VN-V686Setting R-Gain of White Balance for VN-V686 Getting White Balance from VN-V686Getting Back Light Compensation from VN-V686 Setting B-Gain of White Balance for VN-V686Setting Back Light Compensation for VN-V686 Getting B-Gain of White Balance from VN-V686Getting Jpeg Frame Size from VN-V686 Encoding Saving Changes of Encode Settings for VN-V686Setting Jpeg Frame Size for VN-V686 Setting 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-V686Getting MPEG-4 bitrate Setting from VN-V686 Getting MPEG-4 Frame Rate Setting from VN-V686 Setting MPEG-4 bitrate Setting for VN-V686Getting MPEG-4 Rate Control Setting from VN-V686 Setting MPEG-4 Rate Control for VN-V686Setting MPEG-4 Priority Setting for VN-V686 Getting MPEG-4 I-Frame Interval Setting from VN-V686Setting MPEG-4 I-Frame Interval Setting for VN-V686 Getting MPEG-4 Priority Setting from VN-V686Getting Alarm Action from VN-V686 Alarm Setting Getting On/Off of Alarm Action from VN-V68600 OK Example of Response application.event1.action=&200 OKSsage Setting Alarm Action for VN-V686Format /api/param?application.eventNumber.action=Data Alarm%20ON Api/param?application.event1.filtersunday.status=on Getting Alarm Filter Setting from VN-V686Setting Alarm Filter for VN-V686 Getting Alarm Filter Type from VN-V686 Getting Alarm Filter Time from VN-V686Setting Alarm Filter Time for VN-V686 Format /api/param?application.eventNumber.trigger Setting Alarm Filter Type for VN-V686Getting Alarm Trigger from VN-V686 Api/param?application.event1.filtersunday.type=unmaskApi/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 Example /api/param?application.event6.trigger=i1500 Setting Smtp Server Address for VN-V686Getting Smtp Server Port Number Setting from VN-V686 Setting Example /api/param?application.event1.trigger=v1Getting POP before Smtp Setting from VN-V686 Setting Smtp Server Port Number for VN-V686Getting Sender Mail Address Setting from VN-V686 Setting Sender Mail Address for VN-V686Getting POP Server Port Number Setting from VN-V686 Setting POP before Smtp for VN-V686Getting POP Server Address Setting from VN-V686 Setting POP Server Address for VN-V686Setting POP Server Password for VN-V686 Getting POP Server User Name Setting from VN-V686Setting POP Server User Name for VN-V686 Setting FTP Server Path for VN-V686 Getting FTP Server Address Setting from VN-V686Setting FTP Server Address for VN-V686 Getting FTP Server Path Setting from 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-V686Getting User Define Name of File Naming from VN-V686 Setting File Naming of Periodic FTP for VN-V686Setting User Define Name of File Naming for VN-V686 Getting Parameters of Pre/Post Recording from VN-V686 Setting Parameters of Pre/Post Recording for VN-V686Changing 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-V686Getting Detection Level of Auto Tracking from VN-V686 Setting Auto Return Status for VN-V686Setting Detection Level of Auto Tracking for VN-V686 Start/Stop of Auto Tracking for VN-V686Getting Upper Limit of EZoom from VN-V686 Setting Restart Time of Auto Tracking for VN-V686Setting Upper Limit of EZoom for VN-V686 Getting Restart Time of Auto Tracking from VN-V686Getting Left Side of Pan Limit from VN-V686 Setting On/Off of Pan Limit for VN-V686Setting Left Side of Pan Limit for VN-V686 Setting Right Side of Pan Limit for VN-V686Moving to Left/Right Side of Pan Limit for 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-V686Getting Pan Position from VN-V686 Getting Auto Flip Setting from VN-V686Setting Auto Flip for 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-V686Moving to Specified Tilt Position for VN-V686 Setting Status of Variable Pan/Tilt Speed for VN-V686Getting Status of Variable Pan/Tilt Speed from VN-V686 Getting Tilt Position from 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 Patrol from VN-V686 Getting Status of Auto Trace Recording from VN-V686Auto Patrol Start/Stop of Auto Patrol for 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 Motion Detect to On/Off for VN-V686 Setting Width of Privacy Masking Area for VN-V686Setting Height of Privacy Masking Area 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-V686Setting Dhcp for VN-V686 Network Basics Enabling Network Setting ChangesGetting Dhcp Setting from 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-V686Getting MPEG-4 Multicast Port Number from VN-V686 Setting MPEG-4 Multicast Address for VN-V686Getting MPEG-4 Multicast Address from VN-V686 Format /api/param?network.accesscontrolstreamout.hostNumber Setting MPEG-4 Multicast Port Number for VN-V686Setting Client Restriction to Deny/Allow for VN-V686 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 Format /api/param?system.password.data1=data2 Setting Timezone for VN-V686Password Setting Password for VN-V686 Setting Auto Cleaning for VN-V686 Maintenance InitializationFirmware Update Getting Status of Auto Cleaning from VN-V686Format /api/param?system.session Setting Time of Auto Cleaning for VN-V686Getting Status Getting Sending Status Format /api/param?system.log Getting Settings Getting Model NameGetting Log Getting Firmware Revisions of Streaming ManagerGetting 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 Html Sample Seamless Switching Getting Multicast Script FAQ