JVC 686BU, 686U, VN-V685U manual

IP Camera

VN-V685U/686U/686BU API GUIDE

This document provides a description of protocols and API of

VN-V685/686/686B.

2009.3.13. JVC

LST0856-001A

Contents

Main IP Camera VN-V685U/686U/686BU API GUIDE This document provides a description of protocols and API of VN-V685/686/686B. 2009.3.13. JVC Updates Custom Application Software Development Guide Content 1. Getting JPEG from VN-V685/686/686B 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 When API is successfully received with boundary=off 1.4. Restrictions Access restriction Restriction by maximum bitrate of VN-V685/686/686B 1.5. JPEG File Format Sent Out by VN-V685/686/686B 2. Getting MPEG-4 from VN-V685/686/686B 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 2.5. MPEG-4 Stream Format Sent Out by VN-V685/686/686B Preset Position Number position = 0 Indicates preset position number after moving to preset position Fan status fan = 0 Indicates status of fan Intelligent tracking 3. API to Search VN-V685/686/686B Search VN-V685/686/686B in LAN 4. Getting Alarm from VN-V685/686/686B 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-V685/686/686B 6.1. General 6.2. Camera Saving Changes of Camera Settings Getting Camera ID stored in JPEG from VN-V685/686/686B Setting Camera ID in JPEG from VN-V685/686/686B Getting Monitor Type from VN-V685/686/686B Setting Monitor Type for VN-V685/686/686B Getting Black level from VN-V685/686/686B Setting Black level for VN-V685/686/686B Getting Gamma from VN-V685/686/686B Setting Gamma for VN-V685/686/686B Getting Enhance Band from VN-V685/686/686B Getting Active Gamma Level from VN-V685/686/686B internally. Thie setting is valid when gamma setting is "active". Setting Enhance Band for VN-V685/686/686B Getting Enhance from VN-V685/686/686B Setting Enhance for VN-V685/686/686B Getting Color Level from VN-V685/686/686B Setting Color Level for VN-V685/686/686B Getting Stabilizer from VN-V685/686/686B Setting Stabilizer for VN-V685/686/686B Getting Stabilizer Level from VN-V685/686/686B Setting Stabilizer Level for VN-V685/686/686B Getting DNR from VN-V685/686/686B Setting DNR for VN-V685/686/686B Getting 3D Noise Reduction from VN-V685/686B Setting 3D Noise Reduction for VN-V685/686B Getting AGC from VN-V685/686/686B Setting AGC for VN-V685/686/686B Getting Limit of Sense Up from VN-V685/686/686B Setting Limit of Sense Up for VN-V685/686/686B Getting ALC priority from VN-V685/686/686B Setting Shutter Speed for VN-V685/686/686B Setting ALC priority for VN-V685/686/686B Getting Shutter Speed from VN-V685/686/686B Getting B&W Mode from VN-V685/686/686B Setting B&W Mode for VN-V685/686/686B Getting Auto Focus mode for B&W switching from VN-V685/686/686B Setting Auto Focus mode for B&W switching for VN-V685/686/686B Getting Light setting for focus in B&W mode from VN-V685/686/686B Setting Light for focus in B&W mode for VN-V685/686/686B Saving Image Settings for Auto Pan and Auto Trace Getting Iris from VN-V685/686/686B Setting Iris for VN-V685/686/686B Setting Iris Direction for VN-V685/686/686B Operating Iris for VN-V685/686/686B Getting White Balance from VN-V685/686/686B Setting White Balance for VN-V685/686/686B Getting R-Gain of White Balance from VN-V685/686/686B Setting R-Gain of White Balance for VN-V685/686/686B Getting B-Gain of White Balance from VN-V685/686/686B Setting B-Gain of White Balance for VN-V685/686/686B Getting Current R-Gain of Auto White Balance from VN-V685/686/686B Getting Current B-Gain of Auto White Balance from VN-V685/686/686B Getting Back Light Compensation from VN-V685/686/686B Setting Back Light Compensation for VN-V685/686/686B Saving Changes of Encode Settings for VN-V685/686/686B 6.3. Encoding Getting JPEG Frame Size from VN-V685/686/686B Setting JPEG Frame Size for VN-V685/686/686B Getting JPEG Rate Control Setting from VN-V685/686/686B Setting JPEG Rate Control for VN-V685/686/686B Getting JPEG File Size Setting from VN-V685/686/686B Setting JPEG File Size Setting for VN-V685/686/686B Getting MPEG-4 Frame Size from VN-V685/686/686B Setting MPEG-4 Frame Size for VN-V685/686/686B Getting MPEG-4 bitrate Setting from VN-V685/686/686B Setting MPEG-4 Rate Control for VN-V685/686/686B Setting MPEG-4 bitrate Setting for VN-V685/686/686B Getting MPEG-4 Rate Control Setting from VN-V685/686/686B Getting MPEG-4 Frame Rate Setting from VN-V685/686/686B Setting MPEG-4 Frame Rate Setting for VN-V685/686/686B Getting MPEG-4 I-Frame Interval Setting from VN-V685/686/686B Setting MPEG-4 I-Frame Interval Setting for VN-V685/686/686B Getting MPEG-4 Priority Setting from VN-V685/686/686B Setting MPEG-4 Priority Setting for VN-V685/686/686B 6.4. Alarm Setting Getting On/Off of Alarm Action from VN-V685/686/686B Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V685/686/686B Getting Alarm Action from VN-V685/686/686B Setting Alarm Action for VN-V685/686/686B Page Getting Alarm Filter Setting from VN-V685/686/686B Setting Alarm Filter for VN-V685/686/686B Getting Alarm Filter Time from VN-V685/686/686B Setting Alarm Filter Time for VN-V685/686/686B Getting Alarm Filter Type from VN-V685/686/686B Setting Alarm Filter Type for VN-V685/686/686B Getting Alarm Trigger from VN-V685/686/686B Setting Alarm Trigger for VN-V685/686/686B 6.5. Alarm Environment Setting Getting SMTP Server Address Setting from VN-V685/686/686B Setting SMTP Server Address for VN-V685/686/686B Getting SMTP Server Port Number Setting from VN-V685/686/686B Setting SMTP Server Port Number for VN-V685/686/686B Getting Sender Mail Address Setting from VN-V685/686/686B Setting Sender Mail Address for VN-V685/686/686B Getting "POP before SMTP" Setting from VN-V685/686/686B Setting "POP before SMTP" for VN-V685/686/686B Getting POP Server Address Setting from VN-V685/686/686B Setting POP Server Address for VN-V685/686/686B Getting POP Server Port Number Setting from VN-V685/686/686B Setting POP Server Port Number for VN-V685/686/686B Getting POP Server User Name Setting from VN-V685/686/686B Setting POP Server User Name for VN-V685/686/686B Setting POP Server Password for VN-V685/686/686B Getting FTP Server Path Setting from VN-V685/686/686B Getting FTP Server Address Setting from VN-V685/686/686B Setting FTP Server Address for VN-V685/686/686B Setting FTP Server Path for VN-V685/686/686B Getting FTP Server User Name Setting from VN-V685/686/686B Setting FTP Server User Name for VN-V685/686/686B Setting FTP Server Password for VN-V685/686/686B Getting File Naming of Periodic FTP from VN-V685/686/686B Setting File Naming of Periodic FTP for VN-V685/686/686B Getting User Define Name of File Naming from VN-V685/686/686B Setting User Define Name of File Naming for VN-V685/686/686B Getting Parameters of Pre/Post Recording from VN-V685/686/686B Setting Parameters of Pre/Post Recording for VN-V685/686/686B Getting Alarm Output Time Setting from VN-V685/686/686B Setting Alarm Output Time for VN-V685/686/686B Getting Alarm Output Status from VN-V685/686/686B Changing Alarm Output of VN-V685/686/686B 6.6. PTZ (1) Settings for PTZ Control Getting Auto Return Mode from VN-V685/686/686B Setting Auto Return Mode for VN-V685/686/686B Getting Timeout of Auto Return from VN-V685/686/686B Setting Timeout of Auto Return for VN-V685/686/686B Getting Auto Return Status from VN-V685/686/686B Setting Auto Return Status for VN-V685/686/686B Getting Current Operation Status of Auto Tracking from VN-V685/686/686B Start/Stop of Auto Tracking for VN-V685/686/686B Specify target for Intelligent Tracking for VN-V685/686/686B Getting Detection Level of Auto Tracking from VN-V685/686/686B Setting Detection Level of Auto Tracking for VN-V685/686/686B Getting Restart Time of Auto Tracking from VN-V685/686/686B Setting Restart Time of Auto Tracking for VN-V685/686/686B Getting Detection Area of Intelligent Tracking from VN-V685/686/686B Setting Detection Area of Intelligent Tracking for VN-V685/686/686B Getting Tracking Zoom setting of Intelligent Tracking from VN-V685/686/686B Setting Tracking Zoom of Intelligent Tracking for VN-V685/686/686B Getting Zoom Limit of Intelligent Tracking from VN-V685/686/686B Setting Zoom Limit of Intelligent Tracking for VN-V685/686/686B Getting Maximum Zoom of Intelligent Tracking from VN-V685/686/686B Setting Maximum Zoom of Intelligent Tracking for VN-V685/686/686B Getting Threshold of Intelligent Tracking from VN-V685/686/686B Setting Threshold of Intelligent Tracking for VN-V685/686/686B Getting Dead Zone of Intelligent Tracking from VN-V685/686/686B Setting Dead Zone of Intelligent Tracking for VN-V685/686/686B Getting Upper Limit of EZoom from VN-V685/686/686B Setting Upper Limit of EZoom for VN-V685/686/686B Getting On/Off of Pan Limit from VN-V685/686/686B Setting On/Off of Pan Limit for VN-V685/686/686B Getting Left Side of Pan Limit from VN-V685/686/686B Setting Left Side of Pan Limit for VN-V685/686/686B Getting Right Side of Pan Limit from VN-V685/686/686B Setting Right Side of Pan Limit for VN-V685/686/686B Moving to Left/Right Side of Pan Limit for VN-V685/686/686B Setting Speed of Going to Preset Position for VN-V685/686/686B Getting Tilt Limit from VN-V685/686/686B Setting Tilt Limit for VN-V685/686/686B Getting Auto Flip Setting from VN-V685/686/686B Setting Auto Flip for VN-V685/686/686B Getting Current Status of Digital Flip from VN-V685/686/686B (2) PTZ Control Getting Pan Position from VN-V685/686/686B Moving to Specified Pan Position for VN-V685/686/686B Pan Operation for VN-V685/686/686B Setting Direction of Pan Operation for VN-V685/686/686B Setting Speed of Pan Operation for VN-V685/686/686B Getting Pan Operation Status from VN-V685/686/686B Getting Status of Variable Pan/Tilt Speed from VN-V685/686/686B Setting Status of Variable Pan/Tilt Speed for VN-V685/686/686B Getting Tilt Position from VN-V685/686/686B Moving to Specified Tilt Position for VN-V685/686/686B Tilt Operation for VN-V685/686/686B Setting Direction of Tilt Operation for VN-V685/686/686B Setting Speed of Tilt Operation for VN-V685/686/686B Getting Tilt Operation Status from VN-V685/686/686B Getting Zoom Position from VN-V685/686/686B Moving to Specified Zoom Position for VN-V685/686/686B Zoom Operation for VN-V685/686/686B Getting Zoom Operation Status from VN-V685/686/686B Setting Direction of Zoom Operation for VN-V685/686/686B Setting Speed of Zoom Operation for VN-V685/686/686B Moving Specified Position to Center for VN-V685/686/686B Getting Focus Position from VN-V685/686/686B Moving to Specified Focus Position for VN-V685/686/686B Focus Operation for VN-V685/686/686B Setting Direction of Focus Operation for VN-V685/686/686B Setting Speed of Focus Operation for VN-V685/686/686B (3) Preset Position Getting Current Preset Position from VN-V685/686/686B Getting Status of Specified Preset Position from VN-V685/686/686B Register Current Position as Preset Position for VN-V685/686/686B Initialize Preset Position for VN-V685/686/686B Moving to Preset Position for VN-V685/686/686B Getting Title of Preset Position from VN-V685/686/686B Setting Title to Preset Position for VN-V685/686/686B (4) Auto Pan Getting Status of Auto Pan from VN-V685/686/686B Start/Stop of Auto Pan for VN-V685/686/686B Getting Direction of Auto Pan from VN-V685/686/686B Setting Direction of Auto Pan for VN-V685/686/686B Page Start/Stop of Auto Trace for VN-V685/686/686B Start/Stop of Auto Trace Recording for VN-V685/686/686B Getting Status of Auto Trace Recording from VN-V685/686/686B 6.7. Auto Patrol Start/Stop of Auto Patrol for VN-V685/686/686B Getting Status of Auto Patrol from VN-V685/686/686B Getting Preset Postion Number of Auto Patrol from VN-V685/686/686B Setting Preset Postion Number of Auto Patrol for VN-V685/686/686B Getting Duration of Auto Patrol from VN-V685/686/686B Setting Duarion of Auto Patrol for VN-V685/686/686B Saving Preset Position Number/Duarion of Auto Patrol for VN-V685/686/686B 6.8. Privacy Masking Getting Whole Status of Privacy Masking from VN-V685/686/686B Setting Whole Status of Privacy Masking for VN-V685/686/686B Getting Status of a Privacy Masking Area from VN-V685/686/686B Setting Status of a Privacy Masking Area for VN-V685/686/686B Getting Privacy Masking Brightness from VN-V685/686/686B Setting Privacy Masking Brightness for VN-V685/686/686B Start/Save Editing of Privacy Masking for VN-V685/686/686B Setting Width of Privacy Masking Area for VN-V685/686/686B Setting Height of Privacy Masking Area for VN-V685/686/686B 6.9. Motion Detect Getting Motion Detect On/Off Status from VN-V685/686/686B Setting Motion Detect to On/Off for VN-V685/686/686B Getting Motion Detect Sensitivity from VN-V685/686/686B Setting Motion Detect Sensitivity for VN-V685/686/686B Getting Motion Detect Mask from VN-V685/686/686B Setting Motion Detect Mask for VN-V685/686/686B 6.10. Network Basics Enabling Network Setting Changes Getting DHCP Setting from VN-V685/686/686B Setting DHCP for VN-V685/686/686B Getting IP Address from VN-V685/686/686B Setting IP Address for VN-V685/686/686B Getting Subnet Mask from VN-V685/686/686B Setting Subnet Mask for VN-V685/686/686B Getting Default Gateway from VN-V685/686/686B Setting Default Gateway for VN-V685/686/686B Getting Host Name from VN-V685/686/686B Setting Host Name for VN-V685/686/686B Getting DNS Server On/Off Status from VN-V685/686/686B Setting DNS Server Status to On/Off, or Validate Changes for VN-V685/686/686B Getting DNS Server IP Address from VN-V685/686/686B Setting DNS Server IP Address for VN-V685/686/686B Getting IPv6 status from VN-V685/686/686B Setting IPv6 status for VN-V685/686/686B Getting Link Local Address of IPv6 from VN-V685/686/686B Getting Global Address of IPv6 from VN-V685/686/686B Getting MAC Address from VN-V685/686/686B 6.11. Network Details Getting TOS Value of JPEG from VN-V685/686/686B Setting TOS Value of JPEG for VN-V685/686/686B Getting TOS Value of MPEG-4 from VN-V685/686/686B Setting TOS Value of MPEG-4 for VN-V685/686/686B Getting Unicast TTL Value from VN-V685/686/686B Setting Unicast TTL for VN-V685/686/686B Getting Multicast TTL Value from VN-V685/686/686B Setting Multicast TTL for VN-V685/686/686B Getting MTU Value VN-V685/686/686B Setting MTU Value for VN-V685/686/686B Getting Network Negotiation Setting from VN-V685/686/686B Setting Network Negotiation for VN-V685/686/686B 6.12. Protocol Getting Port Number of HTTP from VN-V685/686/686B Getting Port Number of VSIP from VN-V685/686/686B Setting Port Number of HTTP for VN-V685/686/686B Getting Status of VSIP from VN-V685/686/686B Setting Port Number of VSIP for VN-V685/686/686B Getting Status of AMX Discovery Protocol from VN-V685/686/686B Setting Mode of JPEG streaming for VN-V685/686B Setting Status of AMX Discovery Protocol for VN-V685/686/686B Getting Mode of JPEG streaming from VN-V685/686B 6.13. Multicast Streaming Getting Status of JPEG Multicast Streaming from VN-V685/686/686B Setting Status of JPEG Multicast Streaming, or Save Changes for VN-V685/686/686B Getting JPEG Multicast Address from VN-V685/686/686B Setting JPEG Multicast Address for VN-V685/686/686B Getting JPEG Multicast Port Number from VN-V685/686/686B Setting JPEG Multicast Port Number for VN-V685/686/686B Getting Frame Rate of JPEG Multicast from VN-V685/686/686B Setting Frame Rate of JPEG Multicast for VN-V685/686/686B Getting Status of MPEG-4 Multicast Streaming from VN-V685/686/686B Setting Status of MPEG-4 Multicast Streaming, or Save Changes for VN-V685/686/686B Getting MPEG-4 Multicast Address from VN-V685/686/686B Setting MPEG-4 Multicast Address for VN-V685/686/686B Getting MPEG-4 Multicast Port Number from VN-V685/686/686B 6 Getting Deny/Allow Setting of Client Restrictions from VN-V685/686/686B Setting Client Restriction to Deny/Allow for VN-V685/686/686B Getting IP Address Setting of Restricted Client from VN-V685/686/686B Setting IP Address of Restricted Client for VN-V685/686/686B 6.15. Time Getting On/Off of SNTP Client from VN-V685/686/686B Setting On/Off of SNTP Client, or Validate Changes for VN-V685/686/686B Setting Access Interval to NTP Server for VN-V685/686/686B Getting NTP Server Address from VN-V685/686/686B Setting NTP Server Address for VN-V685/686/686B Getting Access Interval Unit of NTP from VN-V685/686/686B Setting Access Interval Unit of SNTP for VN-V685/686/686B Getting Time from VN-V685/686/686B Setting Time for VN-V685/686/686B Getting Timezone from VN-V685/686/686B Setting Timezone for VN-V685/686/686B 6.16. Password Setting Password for VN-V685/686/686B 6.17. Maintenance Initialization Firmware Update Getting Status of Auto Cleaning from VN-V685/686/686B Setting Auto Cleaning for VN-V685/686/686B Setting Time of Auto Cleaning for VN-V685/686/686B 6 Getting Sending Status Getting Log Getting Firmware Revisions of Streaming Manager 6.19. Getting Settings Getting Model Name Getting Firmware Revisions of PTZ Controller Getting Firmware Revisions of Image Processor Getting Firmware Revisions of Lens 6 Restart VN-V685/686/686B Getting Alarm Input Status from VN-V685/686/686B Getting Mode of FTP Server from VN-V685/686/686B Setting Mode of FTP Server for VN-V685/686/686B Getting Control Port Number of FTP Server from VN-V685/686/686B Setting Control Port Number of FTP Server for VN-V685/686/686B 7. List of Protocols and Port Numbers Used with VN-V685/686/686B 8. Customizing VN-V686/685/686Bs Built-in Viewer 8.1. List of ActiveX How to download ActiveX controls: 8.2. Properties of ActiveX Page 8.3. Method of ActiveX Control 8.4. How to use ActiveX Control by HTML 8.5. HTML Sample Page Page 8.6. Notes 9. FAQ