JVC VN-V686UAPI manual

IP Camera

VN-V686U　　API GUIDE

This document provides a description of protocols and API of VN-V686.

Refer Readme file in the CD-ROM for updated information.

2008.6.19. JVC

LST0652-001A

Contents

Main IP Camera VN-V686U 2008.6.19. JVC Updates Custom Application Software Development Guide Content 1. Getting JPEG from VN-V686 via HTTP 1.1. Basic Procedures Page 1.2. API Format Structure Parameter Description 1.3. Response When API is successfully received with boundary=on GET APIspace space HTTP/1.1 0x0D 0x0A 0x0D 0x0A When API is successfully received with boundary=off 1.4. Restrictions Access restriction Restriction by maximum bitrate of VN-V686 Number of clients Page 2. Getting MPEG-4 from VN-V686 via HTTP 2.1. Basic Procedures Page 2.2. API Format Structure Parameter Description 2.3. Response When API is successfully received 2.4. Restrictions Access restriction Restriction by maximum bitrate of VN-V686 Number of clients 2. MPEG-4 Stream Format Sent Out by VN-V686 3. API to Search VN-V686 Search VN-V686 in LAN 4. Getting Alarm from VN-V686 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-V686 6.1. General 6.2. Camera Saving Changes of Camera Settings Getting Camera ID stored in JPEG from VN-V686 Setting Camera ID in JPEG from VN-V686 Example of setting Sender Camera01<somename@somecompany.com> Getting Monitor Type from VN-V686 Setting Monitor Type for VN-V686 Getting Black level from VN-V686 Setting Black level for VN-V686 Getting Gamma from VN-V686 Setting Gamma for VN-V686 Getting Active Gamma Level from VN-V686 internally. Thie setting is valid when gamma setting is "active". Setting Active Gamma Level for VN-V686 Getting Enhance Band from VN-V686 Setting Enhance Band for VN-V686 Getting Enhance from VN-V686 Setting Enhance for VN-V686 Getting Color Level from VN-V686 Setting Color Level for VN-V686 Getting Stabilizer from VN-V686 Setting Stabilizer for VN-V686 Getting Stabilizer Level from VN-V686 Setting Stabilizer Level for VN-V686 Getting DNR from VN-V686 Setting DNR for VN-V686 Getting AGC from VN-V686 Setting AGC for VN-V686 Getting Limit of Sense Up from VN-V686 Setting Limit of Sense Up for VN-V686 Getting ALC priority from VN-V686 Setting ALC priority for VN-V686 Getting Shutter Speed from VN-V686 Setting Shutter Speed for VN-V686 Getting B&W Mode from VN-V686 Setting B&W Mode for VN-V686 Getting Auto Focus mode for B&W switching from VN-V686 Setting Auto Focus mode for B&W switching for VN-V686 Getting Light setting for focus in B&W mode from VN-V686 Setting Light for focus in B&W mode for VN-V686 Saving Image Settings for Auto Pan and Auto Trace Getting Iris from VN-V686 Setting Iris for VN-V686 Setting Iris Direction for VN-V686 Operating Iris for VN-V686 Getting White Balance from VN-V686 Setting White Balance for VN-V686 Getting R-Gain of White Balance from VN-V686 Setting R-Gain of White Balance for VN-V686 Getting B-Gain of White Balance from VN-V686 Setting B-Gain of White Balance for VN-V686 Getting Current R-Gain of Auto White Balance from VN-V686 Getting Current B-Gain of Auto White Balance from VN-V686 Getting Back Light Compensation from VN-V686 Setting Back Light Compensation for VN-V686 6.3. Encoding Saving Changes of Encode Settings for VN-V686 Getting JPEG Frame Size from VN-V686 Setting JPEG Frame Size for VN-V686 Getting JPEG Rate Control Setting from VN-V686 Setting JPEG Rate Control for VN-V686 Getting JPEG File Size Setting from VN-V686 Setting JPEG File Size Setting for VN-V686 Getting MPEG-4 Frame Size from VN-V686 Setting MPEG-4 Frame Size for VN-V686 Getting MPEG-4 bitrate Setting from VN-V686 Setting MPEG-4 bitrate Setting for VN-V686 Getting MPEG-4 Rate Control Setting from VN-V686 Setting MPEG-4 Rate Control for VN-V686 Getting MPEG-4 Frame Rate Setting from VN-V686 Setting MPEG-4 Frame Rate Setting for VN-V686 Getting MPEG-4 I-Frame Interval Setting from VN-V686 Setting MPEG-4 I-Frame Interval Setting for VN-V686 Getting MPEG-4 Priority Setting from VN-V686 Setting MPEG-4 Priority Setting for VN-V686 6.4. Alarm Setting Getting On/Off of Alarm Action from VN-V686 Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V686 Getting Alarm Action from VN-V686 Setting Alarm Action for VN-V686 Page Getting Alarm Filter Setting from VN-V686 Setting Alarm Filter for VN-V686 Getting Alarm Filter Time from VN-V686 Setting Alarm Filter Time for VN-V686 Getting Alarm Filter Type from VN-V686 Setting Alarm Filter Type for VN-V686 Getting Alarm Trigger from VN-V686 Setting Alarm Trigger for VN-V686 6.5. Alarm Environment Setting Getting SMTP Server Address Setting from VN-V686 Setting SMTP Server Address for VN-V686 Getting SMTP Server Port Number Setting from VN-V686 Setting SMTP Server Port Number for VN-V686 Getting Sender Mail Address Setting from VN-V686 Setting Sender Mail Address for VN-V686 Getting "POP before SMTP" Setting from VN-V686 Setting "POP before SMTP" for VN-V686 Getting POP Server Address Setting from VN-V686 Setting POP Server Address for VN-V686 Getting POP Server Port Number Setting from VN-V686 Setting POP Server Port Number for VN-V686 Getting POP Server User Name Setting from VN-V686 Setting POP Server User Name for VN-V686 Setting POP Server Password for VN-V686 Getting FTP Server Address Setting from VN-V686 Setting FTP Server Address for VN-V686 Getting FTP Server Path Setting from VN-V686 Setting FTP Server Path for VN-V686 Getting FTP Server User Name Setting from VN-V686 Setting FTP Server User Name for VN-V686 Setting FTP Server Password for VN-V686 Getting File Naming of Periodic FTP from VN-V686 Setting File Naming of Periodic FTP for VN-V686 Getting User Define Name of File Naming from VN-V686 Setting User Define Name of File Naming for VN-V686 Getting Parameters of Pre/Post Recording from VN-V686 Setting Parameters of Pre/Post Recording for VN-V686 Getting Alarm Output Time Setting from VN-V686 Setting Alarm Output Time for VN-V686 Getting Alarm Output Status from VN-V686 Changing Alarm Output of VN-V686 Page Getting Auto Return Status from VN-V686 Setting Auto Return Status for VN-V686 Getting Current Operation Status of Auto Tracking from VN-V686 Start/Stop of Auto Tracking for VN-V686 Specify target for Intelligent Tracking for VN-V686 Getting Detection Level of Auto Tracking from VN-V686 Setting Detection Level of Auto Tracking for VN-V686 Getting Restart Time of Auto Tracking from VN-V686 Setting Restart Time of Auto Tracking for VN-V686 Getting Detection Area of Intelligent Tracking from VN-V686 Setting Detection Area of Intelligent Tracking for VN-V686 Getting Tracking Zoom setting of Intelligent Tracking from VN-V686 Setting Tracking Zoom of Intelligent Tracking for VN-V686 Getting Zoom Limit of Intelligent Tracking from VN-V686 Setting Zoom Limit of Intelligent Tracking for VN-V686 Getting Maximum Zoom of Intelligent Tracking from VN-V686 Setting Maximum Zoom of Intelligent Tracking for VN-V686 Getting Threshold of Intelligent Tracking from VN-V686 Setting Threshold of Intelligent Tracking for VN-V686 Getting Dead Zone of Intelligent Tracking from VN-V686 Setting Dead Zone of Intelligent Tracking for VN-V686 Getting Upper Limit of EZoom from VN-V686 Setting Upper Limit of EZoom for VN-V686 Getting On/Off of Pan Limit from VN-V686 Setting On/Off of Pan Limit for VN-V686 Getting Left Side of Pan Limit from VN-V686 Setting Left Side of Pan Limit for VN-V686 Getting Right Side of Pan Limit from VN-V686 Setting Right Side of Pan Limit for VN-V686 Moving to Left/Right Side of Pan Limit for VN-V686 Getting Tilt Limit from VN-V686 Setting Tilt Limit for VN-V686 Getting Speed of Going to Preset Position from VN-V686 Setting Speed of Going to Preset Position for VN-V686 Getting Auto Flip Setting from VN-V686 Setting Auto Flip for VN-V686 Getting Current Status of Digital Flip from VN-V686 (2) PTZ Control Getting Pan Position from VN-V686 Page Setting Status of Variable Pan/Tilt Speed for VN-V686 Getting Tilt Position from VN-V686 Moving to Specified Tilt Position for VN-V686 Tilt Operation for VN-V686 Setting Direction of Tilt Operation for VN-V686 Setting Speed of Tilt Operation for VN-V686 Getting Tilt Operation Status from VN-V686 Getting Zoom Position from VN-V686 Moving to Specified Zoom Position for VN-V686 Zoom Operation for VN-V686 Setting Direction of Zoom Operation for VN-V686 Setting Speed of Zoom Operation for VN-V686 Getting Zoom Operation Status from VN-V686 Getting Focus Position from VN-V686 Moving to Specified Focus Position for VN-V686 Focus Operation for VN-V686 Setting Direction of Focus Operation for VN-V686 Setting Speed of Focus Operation for VN-V686 (3) Preset Position Getting Current Preset Position from VN-V686 Getting Status of Specified Preset Position from VN-V686 Register Current Position as Preset Position for VN-V686 Initialize Preset Position for VN-V686 Page Getting Direction of Auto Pan from VN-V686 Setting Direction of Auto Pan for VN-V686 Getting Speed of Auto Pan from VN-V686 Setting Speed of Auto Pan for VN-V686 Setting Current Position as Start Position of Auto Pan for VN-V686 Setting Current Position as End Position of Auto Pan for VN-V686 (5) Auto Trace Getting Status of Auto Trace from VN-V686 Start/Stop of Auto Trace for VN-V686 Start/Stop of Auto Trace Recording for VN-V686 Getting Status of Auto Trace Recording from VN-V686 6.7. Auto Patrol Start/Stop of Auto Patrol for VN-V686 Getting Status of Auto Patrol from VN-V686 Getting Preset Postion Number of Auto Patrol from VN-V686 Setting Preset Postion Number of Auto Patrol for VN-V686 Getting Duration of Auto Patrol from VN-V686 Setting Duarion of Auto Patrol for VN-V686 Saving Preset Position Number/Duarion of Auto Patrol for VN-V686 6.8. Privacy Masking Getting Whole Status of Privacy Masking from VN-V686 Setting Whole Status of Privacy Masking for VN-V686 Getting Status of a Privacy Masking Area from VN-V686 Setting Status of a Privacy Masking Area for VN-V686 Getting Privacy Masking Brightness from VN-V686 Setting Privacy Masking Brightness for VN-V686 Start/Save Editing of Privacy Masking for VN-V686 Setting Width of Privacy Masking Area for VN-V686 Setting Height of Privacy Masking Area for VN-V686 6.9. Motion Detect Getting Motion Detect On/Off Status from VN-V686 Setting Motion Detect to On/Off for VN-V686 Getting Motion Detect Sensitivity from VN-V686 Setting Motion Detect Sensitivity for VN-V686 Getting Motion Detect Mask from VN-V686 Setting Motion Detect Mask for VN-V686 6.10. Network Basics Enabling Network Setting Changes Getting DHCP Setting from VN-V686 Setting DHCP for VN-V686 Getting IP Address from VN-V686 Setting IP Address for VN-V686 Getting Subnet Mask from VN-V686 Setting Subnet Mask for VN-V686 Getting Default Gateway from VN-V686 Setting Default Gateway for VN-V686 Getting Host Name from VN-V686 Setting Host Name for VN-V686 Getting DNS Server On/Off Status from VN-V686 Setting DNS Server Status to On/Off, or Validate Changes for VN-V686 Getting DNS Server IP Address from VN-V686 Setting DNS Server IP Address for VN-V686 Getting MAC Address from VN-V686 6.11. Network Details Getting TOS Value of JPEG from VN-V686 Setting TOS Value of JPEG for VN-V686 Getting TOS Value of MPEG-4 from VN-V686 Setting TOS Value of MPEG-4 for VN-V686 Getting Unicast TTL Value from VN-V686 Setting Unicast TTL for VN-V686 Getting Multicast TTL Value from VN-V686 Setting Multicast TTL for VN-V686 Getting MTU Value VN-V686 Setting MTU Value for VN-V686 Getting Network Negotiation Setting from VN-V686 Setting Network Negotiation for VN-V686 6.12. Protocol Getting Port Number of HTTP from VN-V686 Setting Port Number of HTTP for VN-V686 6.13. Multicast Streaming Getting Status of JPEG Multicast Streaming from VN-V686 Setting Status of JPEG Multicast Streaming, or Save Changes for VN-V686 Getting JPEG Multicast Address from VN-V686 Setting JPEG Multicast Address for VN-V686 Getting JPEG Multicast Port Number from VN-V686 Setting JPEG Multicast Port Number for VN-V686 Getting Frame Rate of JPEG Multicast from VN-V686 Setting Frame Rate of JPEG Multicast for VN-V686 Getting Status of MPEG-4 Multicast Streaming from VN-V686 Setting Status of MPEG-4 Multicast Streaming, or Save Changes for VN- V686 Getting MPEG-4 Multicast Address from VN-V686 Setting MPEG-4 Multicast Address for VN-V686 Getting MPEG-4 Multicast Port Number from VN-V686 Setting MPEG-4 Multicast Port Number for VN-V686 6 Getting Deny/Allow Setting of Client Restrictions from VN-V686 Setting Client Restriction to Deny/Allow for VN-V686 Getting IP Address Setting of Restricted Client from VN-V686 Setting IP Address of Restricted Client for VN-V686 6.15. Time Getting On/Off of SNTP Client from VN-V686 Setting On/Off of SNTP Client, or Validate Changes for VN-V686 Getting NTP Server Address from VN-V686 Setting NTP Server Address for VN-V686 Getting Access Interval to NTP Server from VN-V686 Setting Access Interval to NTP Server for VN-V686 Getting Access Interval Unit of NTP from VN-V686 Setting Access Interval Unit of SNTP for VN-V686 Getting Time from VN-V686 Setting Time for VN-V686 Getting Timezone from VN-V686 Page Setting Timezone for VN-V686 6.16. Password Setting Password for VN-V686 Page Setting Time of Auto Cleaning for VN-V686 6 Getting Sending Status Getting Log 6.19. Getting Settings Getting Model Name Getting Firmware Revisions of Streaming Manager 6 Getting Mode of FTP Server from VN-V686 Setting Mode of FTP Server for VN-V686 Getting Control Port Number of FTP Server from VN-V686 Setting Control Port Number of FTP Server for VN-V686 7. List of Protocols and Port Numbers Used with VN-V686 8. Customizing VN-V686's Built-in Viewer 8.1. Properties of ActiveX 8.2. Methods of ActiveX 8.3. HTML Example for JPEG viewer (1) Getting 15fps JPEG at display size QVGA (2) Getting Multicast (3) HTML Sample (4) Seamless Switching 8.4. HTML Example for MPEG-4 viewer (1) Getting MPEG-4 at display size QVGA (2) Getting Multicast (3) HTML Sample Page 8.5. Notes 9. FAQ