JVC VN-V685U, 686U, 686BU manual Getting Alarm Action from VN-V685/686/686B

Page 38

Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V685/686/686B

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-V685/686/686B

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

Example When Getting action of alarm action No. 1

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

Example of Response

application.event(1).action=mailto/somebody@somecompany.com/none/Message&200 OK

Interpretation Acquire the alarm action of 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. A separate API (/api/param?application.event(Number).status) is used to acquire the on/off status of the alarm action.

When no action is specified, response below is returned.

Example of Response application.event(1).action=&200 OK

When sending mail is specified, mailto, mail address, JPEG attaching and the character string to be sent will be returned. When spaces are included in the character string, the character string with spaces will be returned. Segments are indicated by /. If JPEG attaching is on, "object01" is returned, and if JPEG attaching is off, "none" is returned.

Example of Response

application.event(1).action=mailto/somebody@somecompany.com/object01/Message&2

00 OK

When "PrePostRecording + FTP" is specified, recftp, FTP number, and the attached object number will be returned. Segments are indicated by /. The FTP number is fixed as ftp01 at all times. The object number is fixed as object01.

38

Image 38
Contents API Guide Updates Custom Application Software Development Guide Content Basic Procedures Getting Jpeg from VN-V685/686/686B via HttpPage API Format Structure Parameter DescriptionRestrictions Response When API is successfully received with boundary=onWhen API is successfully received with boundary=off Access restriction Jpeg File Format Sent Out by VN-V685/686/686BGetting MPEG-4 from VN-V685/686/686B via Http Example of VN-V685 API Format Structure Response When API is successfully received MPEG-4 Stream Format Sent Out by VN-V685/686/686B 20070319161455123UTCProcedure Search VN-V685/686/686B in LANUsing API that Requires Basic Authentication User Vn-v686 VN-V685 and VN-V686B Username General CameraExample of setting /api/param?camera.id=Camera01 Saving Changes of Camera SettingsSetting Camera ID in Jpeg from VN-V685/686/686B Getting Camera ID stored in Jpeg from VN-V685/686/686BGetting Monitor Type from VN-V685/686/686B Setting Monitor Type for VN-V685/686/686BSetting Black level for VN-V685/686/686B Getting Black level from VN-V685/686/686BGetting Gamma from VN-V685/686/686B Setting Gamma for VN-V685/686/686BSetting Active Gamma Level for VN-V685/686/686B Getting Active Gamma Level from VN-V685/686/686BGetting Enhance from VN-V685/686/686B Setting Enhance Band for VN-V685/686/686BSetting Enhance for VN-V685/686/686B Getting Color Level from VN-V685/686/686BGetting Stabilizer from VN-V685/686/686B Setting Color Level for VN-V685/686/686BSetting Stabilizer for VN-V685/686/686B Getting Stabilizer Level from VN-V685/686/686BGetting DNR from VN-V685/686/686B Setting Stabilizer Level for VN-V685/686/686BSetting DNR for VN-V685/686/686B Getting 3D Noise Reduction from VN-V685/686BGetting AGC from VN-V685/686/686B Setting 3D Noise Reduction for VN-V685/686BSetting AGC for VN-V685/686/686B Getting Limit of Sense Up from VN-V685/686/686BSetting Shutter Speed for VN-V685/686/686B Setting Limit of Sense Up for VN-V685/686/686BSetting ALC priority for VN-V685/686/686B Getting ALC priority from VN-V685/686/686BCamera.image.truedaynight&202 Acceptedcamera.status=save Getting B&W Mode from VN-V685/686/686BSetting B&W Mode for VN-V685/686/686B Format /api/param?camera.image.truedaynight.af=dataExample /api/param?camera.image.truedaynight.af=on Setting Light for focus in B&W mode for VN-V685/686/686BSaving Image Settings for Auto Pan and Auto Trace Camera.image.truedaynight.af&202 Acceptedcamera.status=saveGetting Iris from VN-V685/686/686B Setting Iris for VN-V685/686/686BSetting Iris Direction for VN-V685/686/686B Operating Iris for VN-V685/686/686BGetting R-Gain of White Balance from VN-V685/686/686B Setting White Balance for VN-V685/686/686BGetting White Balance from VN-V685/686/686B Example of response camera.iris.status&200 OKGetting B-Gain of White Balance from VN-V685/686/686B Setting R-Gain of White Balance for VN-V685/686/686BSetting B-Gain of White Balance for VN-V685/686/686B Setting Back Light Compensation for VN-V685/686/686B Getting Back Light Compensation from VN-V685/686/686BSetting Jpeg Rate Control for VN-V685/686/686B Setting Jpeg Frame Size for VN-V685/686/686BGetting Jpeg Rate Control Setting from VN-V685/686/686B Getting Jpeg Frame Size from VN-V685/686/686BGetting MPEG-4 Frame Size from VN-V685/686/686B Getting Jpeg File Size Setting from VN-V685/686/686BSetting Jpeg File Size Setting for VN-V685/686/686B Format /api/param?encode2.framesizeSetting MPEG-4 bitrate Setting for VN-V685/686/686B Setting MPEG-4 Frame Size for VN-V685/686/686BGetting MPEG-4 bitrate Setting from VN-V685/686/686B Getting MPEG-4 Rate Control Setting from VN-V685/686/686BGetting MPEG-4 Frame Rate Setting from VN-V685/686/686B Setting MPEG-4 Frame Rate Setting for VN-V685/686/686BFormat /api/param?application.eventNumber.status Getting MPEG-4 Priority Setting from VN-V685/686/686BSetting MPEG-4 Priority Setting for VN-V685/686/686B Getting Alarm Action from VN-V685/686/686B Setting Alarm Action for VN-V685/686/686B Format /api/param?application.eventNumber.action=DataAlarm%20ON SsageGetting Alarm Filter Setting from VN-V685/686/686B Setting Alarm Filter Time for VN-V685/686/686B Setting Alarm Filter for VN-V685/686/686BGetting Alarm Filter Time from VN-V685/686/686B Api/param?application.event1.filtersunday.status=onApi/param?application.event1.filtersunday.type=unmask Getting Alarm Filter Type from VN-V685/686/686BSetting Alarm Filter Type for VN-V685/686/686B Format /api/param?application.eventNumber.trigger Getting Alarm Trigger from VN-V685/686/686BSetting Alarm Trigger for VN-V685/686/686B Example of Response application.event1.trigger=v1&200 OKFormat /api/param?application.eventNumber.trigger=data Setting Example /api/param?application.event1.trigger=v1Setting Example /api/param?application.event6.trigger=i1500 Api/param?application.event1.trigger=m1Getting Sender Mail Address Setting from VN-V685/686/686B Setting Smtp Server Address for VN-V685/686/686BSetting Smtp Server Port Number for VN-V685/686/686B Setting POP before Smtp for VN-V685/686/686B Setting Sender Mail Address for VN-V685/686/686BGetting POP before Smtp Setting from VN-V685/686/686B Getting POP Server Address Setting from VN-V685/686/686BSetting POP Server User Name for VN-V685/686/686B Setting POP Server Port Number for VN-V685/686/686BGetting POP Server User Name Setting from VN-V685/686/686B Setting FTP Server Address for VN-V685/686/686B Setting POP Server Password for VN-V685/686/686BGetting FTP Server Address Setting from VN-V685/686/686B Getting FTP Server Path Setting from VN-V685/686/686BSetting FTP Server User Name for VN-V685/686/686B Setting FTP Server Path for VN-V685/686/686BGetting FTP Server User Name Setting from VN-V685/686/686B Setting FTP Server Password for VN-V685/686/686BGetting File Naming of Periodic FTP from VN-V685/686/686B Setting File Naming of Periodic FTP for VN-V685/686/686BApi/param?application.ftp.password=%00 Setting User Define Name of File Naming for VN-V685/686/686B Getting Alarm Output Status from VN-V685/686/686B Getting Alarm Output Time Setting from VN-V685/686/686BSetting Alarm Output Time for VN-V685/686/686B Setting Auto Return Mode for VN-V685/686/686B Changing Alarm Output of VN-V685/686/686BGetting Auto Return Mode from VN-V685/686/686B PTZSetting Auto Return Status for VN-V685/686/686B Getting Timeout of Auto Return from VN-V685/686/686BSetting Timeout of Auto Return for VN-V685/686/686B Getting Auto Return Status from VN-V685/686/686BStart/Stop of Auto Tracking for VN-V685/686/686B Api/param?camera.motion.autotracking2.target=s10-s20Format /api/param?camera.motion.autotracking2.area Setting Restart Time of Auto Tracking for VN-V685/686/686BGetting Restart Time of Auto Tracking from VN-V685/686/686B Page Page Setting Upper Limit of EZoom for VN-V685/686/686B Getting Upper Limit of EZoom from VN-V685/686/686BGetting On/Off of Pan Limit from VN-V685/686/686B Setting On/Off of Pan Limit for VN-V685/686/686BSetting Left Side of Pan Limit for VN-V685/686/686B Getting Left Side of Pan Limit from VN-V685/686/686BMoving to Left/Right Side of Pan Limit for VN-V685/686/686B Setting Right Side of Pan Limit for VN-V685/686/686BSetting Tilt Limit for VN-V685/686/686B Getting Tilt Limit from VN-V685/686/686BGetting Auto Flip Setting from VN-V685/686/686B Setting Auto Flip for VN-V685/686/686BGetting Pan Position from VN-V685/686/686B Setting Direction of Pan Operation for VN-V685/686/686BSetting Speed of Pan Operation for VN-V685/686/686B Moving to Specified Pan Position for VN-V685/686/686BMoving to Specified Tilt Position for VN-V685/686/686B Getting Pan Operation Status from VN-V685/686/686BGetting Tilt Position from VN-V685/686/686B Example of Response camera.motion.pan.speed&200 OKTilt Operation for VN-V685/686/686B Setting Direction of Tilt Operation for VN-V685/686/686BSetting Speed of Tilt Operation for VN-V685/686/686B Getting Tilt Operation Status from VN-V685/686/686BMoving to Specified Zoom Position for VN-V685/686/686B Setting Direction of Zoom Operation for VN-V685/686/686BSetting Speed of Zoom Operation for VN-V685/686/686B Zoom Operation for VN-V685/686/686BMoving to Specified Focus Position for VN-V685/686/686B Moving Specified Position to Center for VN-V685/686/686BGetting Focus Position from VN-V685/686/686B Getting Current Preset Position from VN-V685/686/686B Setting Direction of Focus Operation for VN-V685/686/686BSetting Speed of Focus Operation for VN-V685/686/686B Focus Operation for VN-V685/686/686BGetting Title of Preset Position from VN-V685/686/686B Initialize Preset Position for VN-V685/686/686BMoving to Preset Position for VN-V685/686/686B Setting Title to Preset Position for VN-V685/686/686BStart/Stop of Auto Pan for VN-V685/686/686B Setting Direction of Auto Pan for VN-V685/686/686BGetting Status of Auto Pan from VN-V685/686/686B Getting Direction of Auto Pan from VN-V685/686/686BGetting Status of Auto Trace from VN-V685/686/686B Setting Speed of Auto Pan for VN-V685/686/686BGetting Speed of Auto Pan from VN-V685/686/686B Format /api/param?camera.motion.autotrace.statusApi/param?camera.motion.autotrace.record.status=start Start/Stop of Auto Trace for VN-V685/686/686BStart/Stop of Auto Trace Recording for VN-V685/686/686B Auto Patrol Start/Stop of Auto Patrol for VN-V685/686/686B Getting Status of Auto Patrol from VN-V685/686/686BPrivacy Masking Setting Duarion of Auto Patrol for VN-V685/686/686BGetting Duration of Auto Patrol from VN-V685/686/686B Setting Whole Status of Privacy Masking for VN-V685/686/686B Getting Privacy Masking Brightness from VN-V685/686/686BSetting Height of Privacy Masking Area for VN-V685/686/686B Setting Privacy Masking Brightness for VN-V685/686/686BSetting Width of Privacy Masking Area for VN-V685/686/686B Start/Save Editing of Privacy Masking for VN-V685/686/686BGetting Motion Detect Sensitivity from VN-V685/686/686B Setting Motion Detect to On/Off for VN-V685/686/686BSetting Motion Detect Sensitivity for VN-V685/686/686B Getting Motion Detect Mask from VN-V685/686/686B Setting Motion Detect Mask for VN-V685/686/686BNetwork Basics Enabling Network Setting Changes Setting IP Address for VN-V685/686/686B Getting Dhcp Setting from VN-V685/686/686BSetting Dhcp for VN-V685/686/686B Getting IP Address from VN-V685/686/686BSetting Default Gateway for VN-V685/686/686B Setting Subnet Mask for VN-V685/686/686BGetting Default Gateway from VN-V685/686/686B Getting Subnet Mask from VN-V685/686/686BGetting DNS Server On/Off Status from VN-V685/686/686B Setting Host Name for VN-V685/686/686BSetting DNS Server IP Address for VN-V685/686/686B Getting DNS Server IP Address from VN-V685/686/686BGetting Link Local Address of IPv6 from VN-V685/686/686B Setting IPv6 status for VN-V685/686/686BGetting IPv6 status from VN-V685/686/686B Getting Global Address of IPv6 from VN-V685/686/686BGetting TOS Value of MPEG-4 from VN-V685/686/686B Setting TOS Value of Jpeg for VN-V685/686/686BGetting MAC Address from VN-V685/686/686B Setting Multicast TTL for VN-V685/686/686B Setting TOS Value of MPEG-4 for VN-V685/686/686BSetting Unicast TTL for VN-V685/686/686B Getting Unicast TTL Value from VN-V685/686/686BSetting Network Negotiation for VN-V685/686/686B Setting MTU Value for VN-V685/686/686BGetting Network Negotiation Setting from VN-V685/686/686B Getting MTU Value VN-V685/686/686BProtocol Getting Port Number of Http from VN-V685/686/686B Setting Port Number of Http for VN-V685/686/686BSetting Status of Vsip for VN-V685/686/686B Getting Status of Vsip from VN-V685/686/686BSetting Mode of Jpeg streaming for VN-V685/686B Setting Port Number of Vsip for VN-V685/686/686BGetting Mode of Jpeg streaming from VN-V685/686B Getting Jpeg Multicast Address from VN-V685/686/686B Setting Frame Rate of Jpeg Multicast for VN-V685/686/686B Setting Jpeg Multicast Address for VN-V685/686/686BSetting Jpeg Multicast Port Number for VN-V685/686/686B Getting Jpeg Multicast Port Number from VN-V685/686/686BSetting MPEG-4 Multicast Address for VN-V685/686/686B Getting MPEG-4 Multicast Address from VN-V685/686/686BSetting MPEG-4 Multicast Port Number for VN-V685/686/686B Getting MPEG-4 Multicast Port Number from VN-V685/686/686BExample /api/param?network.accesscontrolstreamout.host1=%00 Format /api/param?network.accesscontrolstreamout.hostNumberNetwork.accesscontrolstreamout.host1=10.0.0.0/24&200 OK TimeSetting Access Interval to NTP Server for VN-V685/686/686B Setting NTP Server Address for VN-V685/686/686BGetting Access Interval to NTP Server from VN-V685/686/686B Getting On/Off of Sntp Client from VN-V685/686/686BSetting Time for VN-V685/686/686B Getting Access Interval Unit of NTP from VN-V685/686/686BSetting Access Interval Unit of Sntp for VN-V685/686/686B Getting Time from VN-V685/686/686BGetting Timezone from VN-V685/686/686B GMT-8Format /api/param?system.password.data1=data2 Setting Timezone for VN-V685/686/686BPassword Setting Password for VN-V685/686/686B Getting Status of Auto Cleaning from VN-V685/686/686B Maintenance InitializationFirmware Update Setting Auto Cleaning for VN-V685/686/686BFormat /api/param?system.session Setting Time of Auto Cleaning for VN-V685/686/686BGetting Status Getting Sending Status Getting Firmware Revisions of Streaming Manager Getting Settings Getting Model NameGetting Log 100Getting Firmware Revisions of Image Processor Getting Alarm Input Status from VN-V685/686/686BGetting Firmware Revisions of PTZ Controller Getting Firmware Revisions of Lens102 Getting Mode of FTP Server from VN-V685/686/686BSetting Mode of FTP Server for VN-V685/686/686B Format /api/param?application.ftp.mode=dataList of ActiveX 103Properties of ActiveX 104105 HhmmssMethod of ActiveX Control 106How to use ActiveX Control by Html 107Html Sample 108109 Script110 111 Form Body Html