JVC 686U, 686BU, VN-V685U manual Format /api/param?application.eventNumber.trigger=data

Page 45

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

Example When setting Trigger of Alarm No. 1

/api/param?application.event(1).trigger=m1

Example of Response

application.event(1).trigger&202 Accepted(application.event(1).status=restart)

Interpretation Set Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.

The changes to settings of alarm action become valid by /api/param?application.event(Number).status=restart. When setting only 1 Trigger:

specify m1 in the case of Make for alarm input 1. specify b1 in the case of Break for alarm input 1. specify m2 in the case of Make for alarm input 2. specify b2 in the case of Break for alarm input 2. specify v1 for motion detection of video. specify ncbws for IR Filter OFF.

specify ncbwe for IR Filter ON. specify efans for fan stop.

specify camera.position(num).status for preset position. "num" is from 0 to 99.

Setting Example /api/param?application.event(1).trigger=v1

Interval can be set to periodic ftp assigned to event(6). Set "i1500" for interval 1500 seconds.

Setting Example /api/param?application.event(6).trigger=i1500

When setting Trigger upon combining 2 alarm inputs, specify as m1(50)b2. The example above indicates that trigger will be activated when break is invoked at alarm input 2 within 50 seconds after make is invoked at alarm input 1. Additionally, combination is only allowed for alarm inputs and not motion detect. And same alarm can not be combined. For example, m1(50)m1 is not available.

Setting Example /api/param?application.event(1).trigger=m1(100)b2

Allowed users admin, operator

6.5. Alarm Environment Setting

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

Getting SMTP Server Address Setting from VN-V685/686/686B

Format /api/param?application.smtp.host

45

Image 45
Contents API Guide Updates Custom Application Software Development Guide Content Getting Jpeg from VN-V685/686/686B via Http Basic ProceduresPage Parameter Description API Format StructureResponse When API is successfully received with boundary=on When API is successfully received with boundary=offRestrictions Jpeg File Format Sent Out by VN-V685/686/686B Access restrictionGetting MPEG-4 from VN-V685/686/686B via Http Example of VN-V685 API Format Structure Response When API is successfully received 20070319161455123UTC MPEG-4 Stream Format Sent Out by VN-V685/686/686BSearch VN-V685/686/686B in LAN ProcedureUsing API that Requires Basic Authentication User Vn-v686 VN-V685 and VN-V686B Username Camera GeneralSetting Camera ID in Jpeg from VN-V685/686/686B Saving Changes of Camera SettingsExample of setting /api/param?camera.id=Camera01 Getting Camera ID stored in Jpeg from VN-V685/686/686BSetting Black level for VN-V685/686/686B Setting Monitor Type for VN-V685/686/686BGetting Monitor Type from VN-V685/686/686B Getting Black level from VN-V685/686/686BSetting Active Gamma Level for VN-V685/686/686B Setting Gamma for VN-V685/686/686BGetting Gamma from VN-V685/686/686B Getting Active Gamma Level from VN-V685/686/686BSetting Enhance for VN-V685/686/686B Setting Enhance Band for VN-V685/686/686BGetting Enhance from VN-V685/686/686B Getting Color Level from VN-V685/686/686BSetting Stabilizer for VN-V685/686/686B Setting Color Level for VN-V685/686/686BGetting Stabilizer from VN-V685/686/686B Getting Stabilizer Level from VN-V685/686/686BSetting DNR for VN-V685/686/686B Setting Stabilizer Level for VN-V685/686/686BGetting DNR from VN-V685/686/686B Getting 3D Noise Reduction from VN-V685/686BSetting AGC for VN-V685/686/686B Setting 3D Noise Reduction for VN-V685/686BGetting AGC from VN-V685/686/686B Getting Limit of Sense Up from VN-V685/686/686BSetting ALC priority for VN-V685/686/686B Setting Limit of Sense Up for VN-V685/686/686BSetting Shutter Speed for VN-V685/686/686B Getting ALC priority from VN-V685/686/686BSetting B&W Mode for VN-V685/686/686B Getting B&W Mode from VN-V685/686/686BCamera.image.truedaynight&202 Acceptedcamera.status=save Format /api/param?camera.image.truedaynight.af=dataSaving Image Settings for Auto Pan and Auto Trace Setting Light for focus in B&W mode for VN-V685/686/686BExample /api/param?camera.image.truedaynight.af=on Camera.image.truedaynight.af&202 Acceptedcamera.status=saveSetting Iris Direction for VN-V685/686/686B Setting Iris for VN-V685/686/686BGetting Iris from VN-V685/686/686B Operating Iris for VN-V685/686/686BGetting White Balance from VN-V685/686/686B Setting White Balance for VN-V685/686/686BGetting R-Gain of White Balance from VN-V685/686/686B Example of response camera.iris.status&200 OKSetting R-Gain of White Balance for VN-V685/686/686B Setting B-Gain of White Balance for VN-V685/686/686BGetting B-Gain of White Balance from VN-V685/686/686B Getting Back Light Compensation from VN-V685/686/686B Setting Back Light Compensation for VN-V685/686/686BGetting Jpeg Rate Control Setting from VN-V685/686/686B Setting Jpeg Frame Size for VN-V685/686/686BSetting Jpeg Rate Control for VN-V685/686/686B Getting Jpeg Frame Size from VN-V685/686/686BSetting Jpeg File Size Setting for VN-V685/686/686B Getting Jpeg File Size Setting from VN-V685/686/686BGetting MPEG-4 Frame Size from VN-V685/686/686B Format /api/param?encode2.framesizeGetting MPEG-4 bitrate Setting from VN-V685/686/686B Setting MPEG-4 Frame Size for VN-V685/686/686BSetting MPEG-4 bitrate Setting for VN-V685/686/686B Getting MPEG-4 Rate Control Setting from VN-V685/686/686BSetting MPEG-4 Frame Rate Setting for VN-V685/686/686B Getting MPEG-4 Frame Rate Setting from VN-V685/686/686BGetting MPEG-4 Priority Setting from VN-V685/686/686B Setting MPEG-4 Priority Setting for VN-V685/686/686BFormat /api/param?application.eventNumber.status Getting Alarm Action from VN-V685/686/686B Format /api/param?application.eventNumber.action=Data Setting Alarm Action for VN-V685/686/686BSsage Alarm%20ONGetting Alarm Filter Setting from VN-V685/686/686B Getting Alarm Filter Time from VN-V685/686/686B Setting Alarm Filter for VN-V685/686/686BSetting Alarm Filter Time for VN-V685/686/686B Api/param?application.event1.filtersunday.status=onGetting Alarm Filter Type from VN-V685/686/686B Setting Alarm Filter Type for VN-V685/686/686BApi/param?application.event1.filtersunday.type=unmask Setting Alarm Trigger for VN-V685/686/686B Getting Alarm Trigger from VN-V685/686/686BFormat /api/param?application.eventNumber.trigger Example of Response application.event1.trigger=v1&200 OKSetting Example /api/param?application.event6.trigger=i1500 Setting Example /api/param?application.event1.trigger=v1Format /api/param?application.eventNumber.trigger=data Api/param?application.event1.trigger=m1Setting Smtp Server Address for VN-V685/686/686B Setting Smtp Server Port Number for VN-V685/686/686BGetting Sender Mail Address Setting from VN-V685/686/686B Getting POP before Smtp Setting from VN-V685/686/686B Setting Sender Mail Address for VN-V685/686/686BSetting POP before Smtp for VN-V685/686/686B Getting POP Server Address Setting from VN-V685/686/686BSetting POP Server Port Number for VN-V685/686/686B Getting POP Server User Name Setting from VN-V685/686/686BSetting POP Server User Name for VN-V685/686/686B Getting FTP Server Address Setting from VN-V685/686/686B Setting POP Server Password for VN-V685/686/686BSetting FTP Server Address for VN-V685/686/686B Getting FTP Server Path Setting from VN-V685/686/686BGetting FTP Server User Name Setting from VN-V685/686/686B Setting FTP Server Path for VN-V685/686/686BSetting FTP Server User Name for VN-V685/686/686B Setting FTP Server Password for VN-V685/686/686BSetting File Naming of Periodic FTP for VN-V685/686/686B Api/param?application.ftp.password=%00Getting File Naming of Periodic FTP from VN-V685/686/686B Setting User Define Name of File Naming for VN-V685/686/686B Getting Alarm Output Time Setting from VN-V685/686/686B Setting Alarm Output Time for VN-V685/686/686BGetting Alarm Output Status from VN-V685/686/686B Getting Auto Return Mode from VN-V685/686/686B Changing Alarm Output of VN-V685/686/686BSetting Auto Return Mode for VN-V685/686/686B PTZSetting Timeout of Auto Return for VN-V685/686/686B Getting Timeout of Auto Return from VN-V685/686/686BSetting Auto Return Status for VN-V685/686/686B Getting Auto Return Status from VN-V685/686/686BApi/param?camera.motion.autotracking2.target=s10-s20 Start/Stop of Auto Tracking for VN-V685/686/686BSetting Restart Time of Auto Tracking for VN-V685/686/686B Getting Restart Time of Auto Tracking from VN-V685/686/686BFormat /api/param?camera.motion.autotracking2.area Page Page Getting Upper Limit of EZoom from VN-V685/686/686B Setting Upper Limit of EZoom for VN-V685/686/686BSetting Left Side of Pan Limit for VN-V685/686/686B Setting On/Off of Pan Limit for VN-V685/686/686BGetting On/Off of Pan Limit from VN-V685/686/686B Getting Left Side of Pan Limit from VN-V685/686/686BSetting Tilt Limit for VN-V685/686/686B Setting Right Side of Pan Limit for VN-V685/686/686BMoving to Left/Right Side of Pan Limit for VN-V685/686/686B Getting Tilt Limit from VN-V685/686/686BSetting Auto Flip for VN-V685/686/686B Getting Auto Flip Setting from VN-V685/686/686BSetting Speed of Pan Operation for VN-V685/686/686B Setting Direction of Pan Operation for VN-V685/686/686BGetting Pan Position from VN-V685/686/686B Moving to Specified Pan Position for VN-V685/686/686BGetting Tilt Position from VN-V685/686/686B Getting Pan Operation Status from VN-V685/686/686BMoving to Specified Tilt Position for VN-V685/686/686B Example of Response camera.motion.pan.speed&200 OKSetting Speed of Tilt Operation for VN-V685/686/686B Setting Direction of Tilt Operation for VN-V685/686/686BTilt Operation for VN-V685/686/686B Getting Tilt Operation Status from VN-V685/686/686BSetting Speed of Zoom Operation for VN-V685/686/686B Setting Direction of Zoom Operation for VN-V685/686/686BMoving to Specified Zoom Position for VN-V685/686/686B Zoom Operation for VN-V685/686/686BMoving Specified Position to Center for VN-V685/686/686B Getting Focus Position from VN-V685/686/686BMoving to Specified Focus Position for VN-V685/686/686B Setting Speed of Focus Operation for VN-V685/686/686B Setting Direction of Focus Operation for VN-V685/686/686BGetting Current Preset Position from VN-V685/686/686B Focus Operation for VN-V685/686/686BMoving to Preset Position for VN-V685/686/686B Initialize Preset Position for VN-V685/686/686BGetting Title of Preset Position from VN-V685/686/686B Setting Title to Preset Position for VN-V685/686/686BGetting Status of Auto Pan from VN-V685/686/686B Setting Direction of Auto Pan for VN-V685/686/686BStart/Stop of Auto Pan for VN-V685/686/686B Getting Direction of Auto Pan from VN-V685/686/686BGetting Speed of Auto Pan from VN-V685/686/686B Setting Speed of Auto Pan for VN-V685/686/686BGetting Status of Auto Trace from VN-V685/686/686B Format /api/param?camera.motion.autotrace.statusStart/Stop of Auto Trace for VN-V685/686/686B Start/Stop of Auto Trace Recording for VN-V685/686/686BApi/param?camera.motion.autotrace.record.status=start Getting Status of Auto Patrol from VN-V685/686/686B Auto Patrol Start/Stop of Auto Patrol for VN-V685/686/686BSetting Duarion of Auto Patrol for VN-V685/686/686B Getting Duration of Auto Patrol from VN-V685/686/686BPrivacy Masking Getting Privacy Masking Brightness from VN-V685/686/686B Setting Whole Status of Privacy Masking for VN-V685/686/686BSetting Width of Privacy Masking Area for VN-V685/686/686B Setting Privacy Masking Brightness for VN-V685/686/686BSetting Height of Privacy Masking Area for VN-V685/686/686B Start/Save Editing of Privacy Masking for VN-V685/686/686BSetting Motion Detect to On/Off for VN-V685/686/686B Setting Motion Detect Sensitivity for VN-V685/686/686BGetting Motion Detect Sensitivity from VN-V685/686/686B Setting Motion Detect Mask for VN-V685/686/686B Network Basics Enabling Network Setting ChangesGetting Motion Detect Mask from VN-V685/686/686B Setting Dhcp for VN-V685/686/686B Getting Dhcp Setting from VN-V685/686/686BSetting IP Address for VN-V685/686/686B Getting IP Address from VN-V685/686/686BGetting Default Gateway from VN-V685/686/686B Setting Subnet Mask for VN-V685/686/686BSetting Default Gateway for VN-V685/686/686B Getting Subnet Mask from VN-V685/686/686BSetting DNS Server IP Address for VN-V685/686/686B Setting Host Name for VN-V685/686/686BGetting DNS Server On/Off Status from VN-V685/686/686B Getting DNS Server IP Address from VN-V685/686/686BGetting IPv6 status from VN-V685/686/686B Setting IPv6 status for VN-V685/686/686BGetting Link Local Address of IPv6 from VN-V685/686/686B Getting Global Address of IPv6 from VN-V685/686/686BSetting TOS Value of Jpeg for VN-V685/686/686B Getting MAC Address from VN-V685/686/686BGetting TOS Value of MPEG-4 from VN-V685/686/686B Setting Unicast TTL for VN-V685/686/686B Setting TOS Value of MPEG-4 for VN-V685/686/686BSetting Multicast TTL for VN-V685/686/686B Getting Unicast TTL Value from VN-V685/686/686BGetting Network Negotiation Setting from VN-V685/686/686B Setting MTU Value for VN-V685/686/686BSetting Network Negotiation for VN-V685/686/686B Getting MTU Value VN-V685/686/686BSetting Status of Vsip for VN-V685/686/686B Setting Port Number of Http for VN-V685/686/686BProtocol Getting Port Number of Http from VN-V685/686/686B Getting Status of Vsip from VN-V685/686/686BSetting Port Number of Vsip for VN-V685/686/686B Getting Mode of Jpeg streaming from VN-V685/686BSetting Mode of Jpeg streaming for VN-V685/686B Getting Jpeg Multicast Address from VN-V685/686/686B Setting Jpeg Multicast Port Number for VN-V685/686/686B Setting Jpeg Multicast Address for VN-V685/686/686BSetting Frame Rate of Jpeg Multicast for VN-V685/686/686B Getting Jpeg Multicast Port Number from VN-V685/686/686BGetting MPEG-4 Multicast Address from VN-V685/686/686B Setting MPEG-4 Multicast Address for VN-V685/686/686BGetting MPEG-4 Multicast Port Number from VN-V685/686/686B Setting MPEG-4 Multicast Port Number for VN-V685/686/686BNetwork.accesscontrolstreamout.host1=10.0.0.0/24&200 OK Format /api/param?network.accesscontrolstreamout.hostNumberExample /api/param?network.accesscontrolstreamout.host1=%00 TimeGetting Access Interval to NTP Server from VN-V685/686/686B Setting NTP Server Address for VN-V685/686/686BSetting Access Interval to NTP Server for VN-V685/686/686B Getting On/Off of Sntp Client from VN-V685/686/686BSetting Access Interval Unit of Sntp for VN-V685/686/686B Getting Access Interval Unit of NTP from VN-V685/686/686BSetting Time for VN-V685/686/686B Getting Time from VN-V685/686/686BGMT-8 Getting Timezone from VN-V685/686/686BSetting Timezone for VN-V685/686/686B Password Setting Password for VN-V685/686/686BFormat /api/param?system.password.data1=data2 Firmware Update Maintenance InitializationGetting Status of Auto Cleaning from VN-V685/686/686B Setting Auto Cleaning for VN-V685/686/686BSetting Time of Auto Cleaning for VN-V685/686/686B Getting Status Getting Sending StatusFormat /api/param?system.session Getting Log Getting Settings Getting Model NameGetting Firmware Revisions of Streaming Manager 100Getting Firmware Revisions of PTZ Controller Getting Alarm Input Status from VN-V685/686/686BGetting Firmware Revisions of Image Processor Getting Firmware Revisions of LensSetting Mode of FTP Server for VN-V685/686/686B Getting Mode of FTP Server from VN-V685/686/686B102 Format /api/param?application.ftp.mode=data103 List of ActiveX104 Properties of ActiveXHhmmss 105106 Method of ActiveX Control107 How to use ActiveX Control by Html108 Html SampleScript 109110 Form Body Html 111