JVC VN-V25U, VN-V26U manual

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

Contents

Main IP Camera VN-V25U/26U API GUIDE 2008.1.19. JVC Updates Custom Application Software Development Guide Content 1. Getting JPEG from VN-V25/26 via HTTP 1.1. Basic Procedures 1.2. API Format Structure Parameter Description 1.3. Response When API is successfully received 1.4. Restrictions Restriction by maximum bitrate of VN-V25/26 1.5. JPEG File Format Sent Out by VN-V25/26 Page 2. Getting MPEG-4 from VN-V25/26 via HTTP w i d t h = 6 4 0 0x00 0x00 2.1. Basic Procedures name =space space value (stuffed with 0x00) fixed length for each item Page 2.4. Restrictions Restriction by maximum bitrate of VN-V25/26 2. MPEG-4 Stream Format Sent Out by VN-V25/26 20070319161455123UTC 3. API to Search VN-V25/26 Search VN-V25/26 in LAN 4. Getting Alarm from VN-V25/26 4.1. Procedure 4.2. Restrictions 5. Using API that Requires Basic Authentication 5.1. Procedure Page 6. API for Getting/Changing Parameters of VN-V25/26 6.1. General be 6.2. Camera Saving Changes of Camera Settings Getting Camera ID stored in JPEG from VN-V25/26 Mail Address for VN-V25/26". Setting Camera ID in JPEG from VN-V25/26 Example of setting Sender Camera01<somename@somecompany.com> Getting Monitor Type from VN-V25/26 Setting Monitor Type for VN-V25/26 Getting Black level from VN-V25/26 Setting Black level for VN-V25/26 Getting Gamma from VN-V25/26 Setting Gamma for VN-V25/26 Getting Enhance Band from VN-V25/26 Setting Enhance Band for VN-V25/26 Getting Enhance from VN-V25/26 Setting Enhance for VN-V25/26 Getting Color Level from VN-V25/26 Setting Color Level for VN-V25/26 Getting AGC from VN-V25/26 Setting AGC for VN-V25/26 Getting Limit of Sense Up from VN-V25/26 Setting Limit of Sense Up for VN-V25/26 Getting ALC priority from VN-V25/26 Setting ALC priority for VN-V25/26 Getting Shutter Speed from VN-V25/26 Setting Shutter Speed for VN-V25/26 Getting Easy Day and Night from VN-V25 (VN-V25 Only) Setting Easy Day and Night for VN-V25 (VN-V25 Only) Getting B&W Mode (True Day&Night) from VN-V26 (VN-V26 Only) Setting B&W Mode (True Day&Night) for VN-V26 (VN-V26 Only) Getting Auto Exposure Reference from VN-V25/26 Setting Auto Exposure Reference for VN-V25/26 Getting White Balance from VN-V25/26 Setting White Balance for VN-V25/26 Getting R-Gain of White Balance from VN-V25/26 Setting R-Gain of White Balance for VN-V25/26 Getting B-Gain of White Balance from VN-V25/26 Setting B-Gain of White Balance for VN-V25/26 Getting Back Light Compensation from VN-V25/26 Setting Back Light Compensation for VN-V25/26 6.3. Encoding Saving Changes of Encode Settings for VN-V25/26 Getting JPEG Frame Size from VN-V25/26 Setting JPEG Frame Size for VN-V25/26 Getting JPEG Rate Control Setting from VN-V25/26 Setting JPEG Rate Control for VN-V25/26 Getting JPEG File Size Setting from VN-V25/26 Setting JPEG File Size Setting for VN-V25/26 Getting MPEG-4 Frame Size from VN-V25/26 Setting 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/26 Getting 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/26 Page Setting Mic Gain for VN-V26 6.5. Alarm Setting Getting On/Off of Alarm Action from VN-V25/26 Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V25/26 Getting Alarm Action from VN-V25/26 Setting Alarm Action for VN-V25/26 Page Getting Alarm Filter Setting from VN-V25/26 Setting Alarm Filter for VN-V25/26 Getting Alarm Filter Time from VN-V25/26 Setting Alarm Filter Time for VN-V25/26 Getting Alarm Filter Type from VN-V25/26 Setting Alarm Filter Type for VN-V25/26 Getting Alarm Trigger from VN-V25/26 Setting Alarm Trigger for VN-V25/26 6.6. Alarm Environment Setting Getting SMTP Server Address Setting from VN-V25/26 Setting SMTP Server Address for VN-V25/26 Getting SMTP Server Port Number Setting from VN-V25/26 Setting SMTP Server Port Number for VN-V25/26 Getting Sender Mail Address Setting from VN-V25/26 Setting Sender Mail Address for VN-V25/26 Getting "POP before SMTP" Setting from VN-V25/26 Setting "POP before SMTP" for VN-V25/26 Getting POP Server Address Setting from VN-V25/26 Setting POP Server Address for VN-V25/26 Getting POP Server Port Number Setting from VN-V25/26 Setting POP Server Port Number for VN-V25/26 Getting POP Server User Name Setting from VN-V25/26 Setting POP Server User Name for VN-V25/26 Setting POP Server Password for VN-V25/26 Getting FTP Server Address Setting from VN-V25/26 Setting FTP Server Address for VN-V25/26 Getting FTP Server Path Setting from VN-V25/26 Setting FTP Server Path for VN-V25/26 Getting FTP Server User Name Setting from VN-V25/26 Setting FTP Server User Name for VN-V25/26 Setting FTP Server Password for VN-V25/26 Getting File Naming of Periodic FTP from VN-V25/26 Setting File Naming of Periodic FTP for VN-V25/26 Getting User Define Name of File Naming from VN-V25/26 Setting 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/26 Getting Alarm Output Time Setting from VN-V25/26 Setting Alarm Output Time for VN-V25/26 Getting Alarm Output Status from VN-V25/26 Changing Alarm Output of VN-V25/26 6.7. Privacy Masking Getting Privacy Masking On/Off Status from VN-V25/26 Setting Privacy Masking to On/Off for VN-V25/26 Getting Privacy Masking Color from VN-V25/26 Setting Privacy Masking Color for VN-V25/26 6.8. Motion Detect Getting Motion Detect On/Off Status from VN-V25/26 Setting Motion Detect to On/Off for VN-V25/26 Getting Motion Detect Sensitivity from VN-V25/26 Setting Motion Detect Sensitivity for VN-V25/26 Getting Motion Detect Mask from VN-V25/26 Setting Motion Detect Mask for VN-V25/26 6.9. Network Basics Enabling Network Setting Changes Getting DHCP Setting from VN-V25/26 Setting DHCP for VN-V25/26 Getting IP Address from VN-V25/26 Setting IP Address for VN-V25/26 Getting Subnet Mask from VN-V25/26 Setting Subnet Mask for VN-V25/26 Getting Default Gateway from VN-V25/26 Setting Default Gateway for VN-V25/26 Getting Host Name from VN-V25/26 Setting Host Name for VN-V25/26 Getting DNS Server On/Off Status from VN-V25/26 Setting DNS Server Status to On/Off, or Validate Changes for VN-V25/26 Getting DNS Server IP Address from VN-V25/26 Setting DNS Server IP Address for VN-V25/26 Getting MAC Address from VN-V25/26 6.10. Network Details Getting TOS Value of JPEG from VN-V25/26 Setting TOS Value of JPEG for VN-V25/26 Getting TOS Value of MPEG-4 from VN-V25/26 Setting TOS Value of MPEG-4 for VN-V25/26 Getting TOS Value of Audio from VN-V26 (VN-V26 Only) Setting TOS Value of Audio for VN-V26 (VN-V26 Only) Getting Unicast TTL Value from VN-V25/26 Setting Unicast TTL for VN-V25/26 Getting Multicast TTL Value from VN-V25/26 Setting Multicast TTL for VN-V25/26 Getting MTU Value VN-V25/26 Setting MTU Value for VN-V25/26 Getting Network Negotiation Setting from VN-V25/26 Setting Network Negotiation for VN-V25/26 Page Getting JPEG Multicast Address from VN-V25/26 Setting JPEG Multicast Address for VN-V25/26 Getting JPEG Multicast Port Number from VN-V25/26 Setting JPEG Multicast Port Number for VN-V25/26 Getting Frame Rate of JPEG Multicast from VN-V25/26 Setting Frame Rate of JPEG Multicast for VN-V25/26 Getting Status of MPEG-4 Multicast Streaming from VN-V25/26 Setting Status of MPEG-4 Multicast Streaming, or Save Changes for VN- V25/26 Getting MPEG-4 Multicast Address from VN-V25/26 Setting MPEG-4 Multicast Address for VN-V25/26 Getting MPEG-4 Multicast Port Number from VN-V25/26 Setting MPEG-4 Multicast Port Number for VN-V25/26 Getting Status of Audio Multicast Streaming from VN-V26 (VN-V26 Only) Page 6 Getting Deny/Allow Setting of Client Restrictions from VN-V25/26 Setting Client Restriction to Deny/Allow for VN-V25/26 Getting IP Address Setting of Restricted Client from VN-V25/26 Setting IP Address of Restricted Client for VN-V25/26 6.14. Time Getting On/Off of SNTP Client from VN-V25/26 Setting On/Off of SNTP Client, or Validate Changes for VN-V25/26 Getting NTP Server Address from VN-V25/26 Setting NTP Server Address for VN-V25/26 Getting Access Interval to NTP Server from VN-V25/26 Setting Access Interval to NTP Server for VN-V25/26 Getting Access Interval Unit of NTP from VN-V25/26 Setting Access Interval Unit of SNTP for VN-V25/26 Getting Time from VN-V25/26 Setting Time for VN-V25/26 Getting Timezone from VN-V25/26 GMT-12 Page Setting Timezone for VN-V25/26 6.15. Password Setting Password for VN-V25/26 6.16. Maintenance Page Setting LED blinking mode for VN-V25/26 6 Getting Sending Status Getting Log 6.19. Getting Settings Getting Model Name 6 Getting Control Port Number of FTP Server from VN-V25/26 Setting Control Port Number of FTP Server for VN-V25/26 7. Getting Audio from VN-V26 via HTTP 7.1. Basic Procedures 7.2. API Format Structure Parameter Description 7.3. Response When API is successfully received GET APIspace space HTTP/1.1 0x0D 0x0A 0x0D 0x0A 0x0D 0x0A Host: space IP Address of VN-V26 7.4. Restrictions 8. Sending Audio to VN-V26 8.1. Procedures 8.2. Restrictions Restrictions on Number of Clients Timing of Data Sending 9. List of Protocols and Port Numbers Used with VN-V25/26 10. Customizing VN-V25/26's Built-in Viewer 10.1. Properties of ActiveX 10.2. Methods of ActiveX 10.3. HTML Example for JPEG viewer (1) Getting 15fps JPEG at display size QVGA (2) Getting Multicast (3) HTML Sample Page (4) Seamless Switching 10.4. HTML Example for MPEG-4 viewer (1) Getting MPEG-4 at display size QVGA (2) Getting Multicast (3) HTML Sample 10.5. Notes 11. Customizing VN-V26's Built-in Audio Client 11.1. Audio Monitor (1) Properties of ActiveX (2) Methods of ActiveX (3) HTML Example for audio monitor Page 11.2. Audio Sender from PC to VN-V26 (1) Properties of ActiveX (2) Methods of ActiveX (3) HTML Example for audio monitor 12. FAQ