JVC VN-V25U Getting Alarm Action from VN-V25/26, Format /api/param?application.eventNumber.action

Page 32

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-V25/26

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. Parameters of FTP can be gotten by other APIs, application.ftp and application.object.

Example of Response application.event(1).action=recftp/ftp01/object01&200 OK

When sending via TCP is specified, tcpto, IP address, port number and the character string to be sent will be returned. Segments are indicated by /.

Example of Response

application.event(1).action=tcpto/10.0.0.100/20000/Message&200 OK

32

Image 32
Contents VN-V25U/26U Updates Custom Application Software Development Guide Content Basic Procedures Getting Jpeg from VN-V25/26 via HttpAPI Format Structure APIResponse When API is successfully received Parameter DescriptionRestrictions Jpeg File Format Sent Out by VN-V25/26Fffe Getting MPEG-4 from VN-V25/26 via Http HTTP/1.1 200 Okcrlf Connection closeCRLF MPEG-4 Stream Format Sent Out by VN-V25/26 Procedure Search VN-V25/26 in LANUsing API that Requires Basic Authentication Maximum number of clientsClient disconnects TCP80 to end the use of API API for Getting/Changing Parameters of VN-V25/26 GeneralParamA.ParamB.ParamC&200 OK Camera Saving Changes of Camera SettingsGetting Camera ID stored in Jpeg from VN-V25/26 Setting Camera ID in Jpeg from VN-V25/26 Setting Monitor Type for VN-V25/26Example of setting /api/param?camera.id=Camera01 Getting Monitor Type from VN-V25/26Setting Black level for VN-V25/26 Setting Gamma for VN-V25/26Getting Black level from VN-V25/26 Getting Gamma from VN-V25/26Setting Enhance Band for VN-V25/26 Setting Enhance for VN-V25/26Getting Enhance Band from VN-V25/26 Getting Enhance from VN-V25/26Setting Color Level for VN-V25/26 Setting AGC for VN-V25/26Getting AGC from VN-V25/26 Getting Limit of Sense Up from VN-V25/26Setting Limit of Sense Up for VN-V25/26 Setting ALC priority for VN-V25/26Getting ALC priority from VN-V25/26 Getting Shutter Speed from VN-V25/26Setting Shutter Speed for VN-V25/26 Setting Easy Day and Night for VN-V25 VN-V25 OnlyGetting B&W Mode True Day&Night from VN-V26 VN-V26 Only Getting Easy Day and Night from VN-V25 VN-V25 OnlySetting B&W Mode True Day&Night for VN-V26 VN-V26 Only Setting Auto Exposure Reference for VN-V25/26Getting Auto Exposure Reference from VN-V25/26 Getting White Balance from VN-V25/26Setting White Balance for VN-V25/26 Setting R-Gain of White Balance for VN-V25/26Setting B-Gain of White Balance for VN-V25/26 Getting R-Gain of White Balance from VN-V25/26Setting Back Light Compensation for VN-V25/26 Encoding Saving Changes of Encode Settings for VN-V25/26Getting Back Light Compensation from VN-V25/26 Getting Jpeg Frame Size from VN-V25/26Setting Jpeg Frame Size for VN-V25/26 Getting Jpeg Rate Control Setting from VN-V25/26Setting Jpeg Rate Control for VN-V25/26 Getting Jpeg File Size Setting from VN-V25/26Getting MPEG-4 Frame Size from VN-V25/26 Setting Jpeg File Size Setting for VN-V25/26Setting MPEG-4 Frame Size for VN-V25/26 Getting MPEG-4 bitrate Setting from VN-V25/26 Setting MPEG-4 bitrate Setting for VN-V25/26Getting MPEG-4 Rate Control Setting from VN-V25/26 Setting MPEG-4 Rate Control for VN-V25/26 Getting MPEG-4 Frame Rate Setting from VN-V25/26 Setting MPEG-4 Frame Rate Setting for VN-V25/26 Getting MPEG-4 I-Frame Interval Setting from VN-V25/26 Setting MPEG-4 I-Frame Interval Setting for VN-V25/26Getting MPEG-4 Priority Setting from VN-V25/26 Setting MPEG-4 Priority Setting for VN-V25/26Setting Audio Duplex Mode for VN-V26 Getting Mic Gain from VN-V26Setting Mic Gain for VN-V26 Alarm Setting Getting On/Off of Alarm Action from VN-V25/26Format /api/param?application.eventNumber.status Format /api/param?application.eventNumber.status=dataGetting Alarm Action from VN-V25/26 Format /api/param?application.eventNumber.actionApi/param?application.event1.action Example of Response application.event1.action=&200 OKSsage Setting Alarm Action for VN-V25/26Format /api/param?application.eventNumber.action=Data Alarm%20ON Api/param?application.event1.filtersunday.status=on Getting Alarm Filter Setting from VN-V25/26Setting Alarm Filter for VN-V25/26 Getting Alarm Filter Type from VN-V25/26 Getting Alarm Filter Time from VN-V25/26Setting Alarm Filter Time for VN-V25/26 Setting Alarm Filter Type for VN-V25/26 Getting Alarm Trigger from VN-V25/26Api/param?application.event1.filtersunday.type=unmask Format /api/param?application.eventNumber.triggerSetting Alarm Trigger for VN-V25/26 Example of Response application.event1.trigger=v1&200 OKFormat /api/param?application.eventNumber.trigger=data Api/param?application.event1.trigger=m1Setting Smtp Server Address for VN-V25/26 Getting Smtp Server Port Number Setting from VN-V25/26Setting Example /api/param?application.event1.trigger=v1 Setting Example /api/param?application.event6.trigger=i1500Setting Smtp Server Port Number for VN-V25/26 Getting Sender Mail Address Setting from VN-V25/26Setting Sender Mail Address for VN-V25/26 Getting POP before Smtp Setting from VN-V25/26Setting POP before Smtp for VN-V25/26 Getting POP Server Address Setting from VN-V25/26Setting POP Server Address for VN-V25/26 Getting POP Server Port Number Setting from VN-V25/26Getting POP Server User Name Setting from VN-V25/26 Setting POP Server User Name for VN-V25/26Setting POP Server Password for VN-V25/26 Example of setting /api/param?application.pop.user=somenameGetting FTP Server Address Setting from VN-V25/26 Setting FTP Server Address for VN-V25/26Getting FTP Server Path Setting from VN-V25/26 Setting FTP Server Path for VN-V25/26Setting FTP Server User Name for VN-V25/26 Setting FTP Server Password for VN-V25/26Api/param?application.ftp.password=%00 Getting File Naming of Periodic FTP from VN-V25/26Getting User Define Name of File Naming from VN-V25/26 Setting File Naming of Periodic FTP for VN-V25/26Setting User Define Name of File Naming for VN-V25/26 Getting Parameters of Pre/Post Recording from VN-V25/26 Setting Parameters of Pre/Post Recording for VN-V25/26Getting Alarm Output Time Setting from VN-V25/26 Setting Alarm Output Time for VN-V25/26 Getting Alarm Output Status from VN-V25/26Changing Alarm Output of VN-V25/26 Format /api/param?camera.privatemask.statusSetting Privacy Masking to On/Off for VN-V25/26 Setting Privacy Masking Color for VN-V25/26Getting Privacy Masking Color from VN-V25/26 Example of response camera.privatemask.status=on&200 OKSetting Motion Detect to On/Off for VN-V25/26 Setting Motion Detect Sensitivity for VN-V25/26Getting Motion Detect Sensitivity from VN-V25/26 Getting Motion Detect Mask from VN-V25/26Setting Motion Detect Mask for VN-V25/26 Network Basics Enabling Network Setting ChangesGetting Dhcp Setting from VN-V25/26 Setting Dhcp for VN-V25/26Setting IP Address for VN-V25/26 Setting Subnet Mask for VN-V25/26Getting IP Address from VN-V25/26 Getting Subnet Mask from VN-V25/26Getting Default Gateway from VN-V25/26 Setting Default Gateway for VN-V25/26Setting Host Name for VN-V25/26 Getting Host Name from VN-V25/26Setting DNS Server IP Address for VN-V25/26 Getting DNS Server IP Address from VN-V25/26Getting MAC Address from VN-V25/26 Network DetailsSetting TOS Value of Jpeg for VN-V25/26 Setting TOS Value of MPEG-4 for VN-V25/26Getting TOS Value of Jpeg from VN-V25/26 Getting TOS Value of MPEG-4 from VN-V25/26Setting TOS Value of Audio for VN-V26 VN-V26 Only Setting Unicast TTL for VN-V25/26Setting Multicast TTL for VN-V25/26 Getting Unicast TTL Value from VN-V25/26Setting MTU Value for VN-V25/26 Getting Network Negotiation Setting from VN-V25/26Setting Network Negotiation for VN-V25/26 Getting MTU Value VN-V25/26Format /api/param?network.destination1.status=data Setting Port Number of Http for VN-V25/26Protocol Getting Port Number of Http from VN-V25/26 Setting Jpeg Multicast Address for VN-V25/26 Setting Jpeg Multicast Port Number for VN-V25/26Getting Jpeg Multicast Address from VN-V25/26 Getting Jpeg Multicast Port Number from VN-V25/26Getting Status of MPEG-4 Multicast Streaming from VN-V25/26 Setting Frame Rate of Jpeg Multicast for VN-V25/26Getting Frame Rate of Jpeg Multicast from VN-V25/26 Setting MPEG-4 Multicast Address for VN-V25/26 Setting MPEG-4 Multicast Port Number for VN-V25/26Getting MPEG-4 Multicast Address from VN-V25/26 Getting MPEG-4 Multicast Port Number from VN-V25/26Setting Audio Multicast Address for VN-V26 VN-V26 Only Setting Audio Multicast Port Number for VN-V26 VN-V26 OnlyGetting Audio Multicast Address from VN-V26 VN-V26 Only Getting Audio Multicast Port Number from VN-V26 VN-V26 OnlySetting Client Restriction to Deny/Allow for VN-V25/26 Format /api/param?network.accesscontrolstreamout.hostNumberSetting IP Address of Restricted Client for VN-V25/26 Network.accesscontrolstreamout.host1=10.0.0.0/24&200 OKExample /api/param?network.accesscontrolstreamout.host1=%00 Time Getting On/Off of Sntp Client from VN-V25/26Setting NTP Server Address for VN-V25/26 Getting Access Interval to NTP Server from VN-V25/26Setting Access Interval to NTP Server for VN-V25/26 Getting Access Interval Unit of NTP from VN-V25/26Setting Access Interval Unit of Sntp for VN-V25/26 Setting Time for VN-V25/26Getting Time from VN-V25/26 Getting Timezone from VN-V25/26GMT-9 Setting Timezone for VN-V25/26 Password Setting Password for VN-V25/26Maintenance Format /api/param?system.password.data1=data2Firmware Update LED Setting Getting LED mode from VN-V25/26Setting LED mode for VN-V25/26 Getting LED blinking mode from VN-V25/26Setting LED blinking mode for VN-V25/26 Getting Status Getting Sending StatusExample of Response camera.identify=off&200 OK Camera.identify&202 Acceptedcamera.status=saveFormat /api/param?system.log Getting Settings Getting Model NameGetting Log Getting Alarm Input Status from VN-V25/26 Getting Mode of FTP Server from VN-V25/26Setting Mode of FTP Server for VN-V25/26 Getting Firmware RevisionsGetting Control Port Number of FTP Server from VN-V25/26 Setting Control Port Number of FTP Server for VN-V25/26Getting Audio from VN-V26 via Http VN-V26 returns Http response Parameter Description Procedures Sending Audio to VN-V26Restrictions on Number of Clients List of Protocols and Port Numbers Used with VN-V25/26 Customizing VN-V25/26s Built-in ViewerMethods of ActiveX Getting Multicast Script Seamless Switching MPEG4Viewer.Stop Customizing VN-V26s Built-in Audio Client Audio Monitor Properties of ActiveX Script Head Audio Sender from PC to VN-V26 Properties of ActiveX Sound.Play FAQ Causes of Low Frame Rate