JVC VN-V26U manual VN-V25U/26U

Page 1

IP Camera

VN-V25U/26U

API GUIDE

This document provides a description of protocols and API of VN-V25/26. Refer Readme file in the CD-ROM for updated information.

2008.1.19. JVC

LST0652-001A

1

Image 1
Contents VN-V25U/26U Updates Custom Application Software Development Guide Content Getting Jpeg from VN-V25/26 via Http Basic ProceduresAPI API Format StructureParameter Description Response When API is successfully receivedRestrictions 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 Search VN-V25/26 in LAN ProcedureMaximum number of clients Using API that Requires Basic AuthenticationClient disconnects TCP80 to end the use of API General API for Getting/Changing Parameters of VN-V25/26Getting Camera ID stored in Jpeg from VN-V25/26 Camera Saving Changes of Camera SettingsParamA.ParamB.ParamC&200 OK Setting Monitor Type for VN-V25/26 Setting Camera ID in Jpeg from VN-V25/26Example of setting /api/param?camera.id=Camera01 Getting Monitor Type from VN-V25/26Setting Gamma for VN-V25/26 Setting Black level for VN-V25/26Getting Black level from VN-V25/26 Getting Gamma from VN-V25/26Setting Enhance for VN-V25/26 Setting Enhance Band for VN-V25/26Getting Enhance Band from VN-V25/26 Getting Enhance from VN-V25/26Setting AGC for VN-V25/26 Setting Color Level for VN-V25/26Getting AGC from VN-V25/26 Getting Limit of Sense Up from VN-V25/26Setting ALC priority for VN-V25/26 Setting Limit of Sense Up for VN-V25/26Getting ALC priority from VN-V25/26 Getting Shutter Speed from VN-V25/26Setting Easy Day and Night for VN-V25 VN-V25 Only Setting Shutter Speed for VN-V25/26Getting B&W Mode True Day&Night from VN-V26 VN-V26 Only Getting Easy Day and Night from VN-V25 VN-V25 OnlySetting Auto Exposure Reference for VN-V25/26 Setting B&W Mode True Day&Night for VN-V26 VN-V26 OnlyGetting Auto Exposure Reference from VN-V25/26 Getting White Balance from VN-V25/26Setting R-Gain of White Balance for VN-V25/26 Setting White Balance for VN-V25/26Setting B-Gain of White Balance for VN-V25/26 Getting R-Gain of White Balance from VN-V25/26Encoding Saving Changes of Encode Settings for VN-V25/26 Setting Back Light Compensation for VN-V25/26Getting Back Light Compensation from VN-V25/26 Getting Jpeg Frame Size from VN-V25/26Getting Jpeg Rate Control Setting from VN-V25/26 Setting Jpeg Frame Size for VN-V25/26Setting Jpeg Rate Control for VN-V25/26 Getting Jpeg File Size Setting from VN-V25/26Setting MPEG-4 Frame Size for VN-V25/26 Setting Jpeg File Size Setting for VN-V25/26Getting MPEG-4 Frame Size from VN-V25/26 Setting MPEG-4 bitrate Setting for VN-V25/26 Getting MPEG-4 bitrate Setting from VN-V25/26Getting MPEG-4 Rate Control Setting from VN-V25/26 Setting MPEG-4 Rate Control for VN-V25/26Setting MPEG-4 Frame Rate Setting for VN-V25/26 Getting MPEG-4 Frame Rate Setting from VN-V25/26Getting MPEG-4 I-Frame Interval Setting from VN-V25/26 Setting MPEG-4 I-Frame Interval Setting for VN-V25/26Setting MPEG-4 Priority Setting for VN-V25/26 Getting MPEG-4 Priority Setting from VN-V25/26Setting Audio Duplex Mode for VN-V26 Getting Mic Gain from VN-V26Alarm Setting Getting On/Off of Alarm Action from VN-V25/26 Setting Mic Gain for VN-V26Format /api/param?application.eventNumber.status Format /api/param?application.eventNumber.status=dataFormat /api/param?application.eventNumber.action Getting Alarm Action from VN-V25/26Api/param?application.event1.action Example of Response application.event1.action=&200 OKFormat /api/param?application.eventNumber.action=Data Setting Alarm Action for VN-V25/26Ssage Alarm%20ON Setting Alarm Filter for VN-V25/26 Getting Alarm Filter Setting from VN-V25/26Api/param?application.event1.filtersunday.status=on Setting Alarm Filter Time for VN-V25/26 Getting Alarm Filter Time from VN-V25/26Getting Alarm Filter Type from VN-V25/26 Getting Alarm Trigger from VN-V25/26 Setting Alarm Filter Type for VN-V25/26Api/param?application.event1.filtersunday.type=unmask Format /api/param?application.eventNumber.triggerExample of Response application.event1.trigger=v1&200 OK Setting Alarm Trigger for VN-V25/26Format /api/param?application.eventNumber.trigger=data Api/param?application.event1.trigger=m1Getting Smtp Server Port Number Setting from VN-V25/26 Setting Smtp Server Address for VN-V25/26Setting Example /api/param?application.event1.trigger=v1 Setting Example /api/param?application.event6.trigger=i1500Getting Sender Mail Address Setting from VN-V25/26 Setting Smtp Server Port Number for VN-V25/26Setting Sender Mail Address for VN-V25/26 Getting POP before Smtp Setting from VN-V25/26Getting POP Server Address Setting from VN-V25/26 Setting POP before Smtp for VN-V25/26Setting POP Server Address for VN-V25/26 Getting POP Server Port Number Setting from VN-V25/26Setting POP Server User Name for VN-V25/26 Getting POP Server User Name Setting from VN-V25/26Setting POP Server Password for VN-V25/26 Example of setting /api/param?application.pop.user=somenameSetting FTP Server Address for VN-V25/26 Getting FTP Server Address Setting from VN-V25/26Getting FTP Server Path Setting from VN-V25/26 Setting FTP Server Path for VN-V25/26Setting FTP Server Password for VN-V25/26 Setting FTP Server User Name for VN-V25/26Api/param?application.ftp.password=%00 Getting File Naming of Periodic FTP from VN-V25/26Setting User Define Name of File Naming for VN-V25/26 Setting File Naming of Periodic FTP for VN-V25/26Getting User Define Name of File Naming from VN-V25/26 Getting Alarm Output Time Setting from VN-V25/26 Setting Parameters of Pre/Post Recording for VN-V25/26Getting Parameters of Pre/Post Recording from VN-V25/26 Getting Alarm Output Status from VN-V25/26 Setting Alarm Output Time for VN-V25/26Changing Alarm Output of VN-V25/26 Format /api/param?camera.privatemask.statusSetting Privacy Masking Color for VN-V25/26 Setting Privacy Masking to On/Off for VN-V25/26Getting Privacy Masking Color from VN-V25/26 Example of response camera.privatemask.status=on&200 OKSetting Motion Detect Sensitivity for VN-V25/26 Setting Motion Detect to On/Off for VN-V25/26Getting Motion Detect Sensitivity from VN-V25/26 Getting Motion Detect Mask from VN-V25/26Network Basics Enabling Network Setting Changes Setting Motion Detect Mask for VN-V25/26Getting Dhcp Setting from VN-V25/26 Setting Dhcp for VN-V25/26Setting Subnet Mask for VN-V25/26 Setting IP Address for VN-V25/26Getting IP Address from VN-V25/26 Getting Subnet Mask from VN-V25/26Setting Default Gateway for VN-V25/26 Getting Default Gateway from VN-V25/26Setting Host Name for VN-V25/26 Getting Host Name from VN-V25/26Getting DNS Server IP Address from VN-V25/26 Setting DNS Server IP Address for VN-V25/26Getting MAC Address from VN-V25/26 Network DetailsSetting TOS Value of MPEG-4 for VN-V25/26 Setting TOS Value of Jpeg for VN-V25/26Getting TOS Value of Jpeg from VN-V25/26 Getting TOS Value of MPEG-4 from VN-V25/26Setting Unicast TTL for VN-V25/26 Setting TOS Value of Audio for VN-V26 VN-V26 OnlySetting Multicast TTL for VN-V25/26 Getting Unicast TTL Value from VN-V25/26Getting Network Negotiation Setting from VN-V25/26 Setting MTU Value for VN-V25/26Setting Network Negotiation for VN-V25/26 Getting MTU Value VN-V25/26Protocol Getting Port Number of Http from VN-V25/26 Setting Port Number of Http for VN-V25/26Format /api/param?network.destination1.status=data Setting Jpeg Multicast Port Number for VN-V25/26 Setting Jpeg Multicast Address for VN-V25/26Getting Jpeg Multicast Address from VN-V25/26 Getting Jpeg Multicast Port Number from VN-V25/26Getting Frame Rate of Jpeg Multicast from VN-V25/26 Setting Frame Rate of Jpeg Multicast for VN-V25/26Getting Status of MPEG-4 Multicast Streaming from VN-V25/26 Setting MPEG-4 Multicast Port Number for VN-V25/26 Setting MPEG-4 Multicast Address for VN-V25/26Getting MPEG-4 Multicast Address from VN-V25/26 Getting MPEG-4 Multicast Port Number from VN-V25/26Setting Audio Multicast Port Number for VN-V26 VN-V26 Only Setting Audio Multicast Address 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 OnlyFormat /api/param?network.accesscontrolstreamout.hostNumber Setting Client Restriction to Deny/Allow for VN-V25/26Network.accesscontrolstreamout.host1=10.0.0.0/24&200 OK Setting IP Address of Restricted Client for VN-V25/26Example /api/param?network.accesscontrolstreamout.host1=%00 Time Getting On/Off of Sntp Client from VN-V25/26Getting Access Interval to NTP Server from VN-V25/26 Setting NTP Server Address for VN-V25/26Setting Access Interval to NTP Server for VN-V25/26 Getting Access Interval Unit of NTP from VN-V25/26Setting Time for VN-V25/26 Setting Access Interval Unit of Sntp for VN-V25/26Getting Time from VN-V25/26 Getting Timezone from VN-V25/26GMT-9 Password Setting Password for VN-V25/26 Setting Timezone for VN-V25/26Maintenance Format /api/param?system.password.data1=data2LED Setting Getting LED mode from VN-V25/26 Firmware UpdateSetting LED mode for VN-V25/26 Getting LED blinking mode from VN-V25/26Getting Status Getting Sending Status Setting LED blinking mode for VN-V25/26Example of Response camera.identify=off&200 OK Camera.identify&202 Acceptedcamera.status=saveGetting Log Getting Settings Getting Model NameFormat /api/param?system.log Getting Mode of FTP Server from VN-V25/26 Getting Alarm Input Status from VN-V25/26Setting Mode of FTP Server for VN-V25/26 Getting Firmware RevisionsGetting Audio from VN-V26 via Http Setting Control Port Number of FTP Server for VN-V25/26Getting Control Port Number of FTP Server from VN-V25/26 VN-V26 returns Http response Parameter Description Sending Audio to VN-V26 ProceduresRestrictions on Number of Clients Customizing VN-V25/26s Built-in Viewer List of Protocols and Port Numbers Used with VN-V25/26Methods 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 Causes of Low Frame Rate FAQ