JVC VN-686BU Api Manual
  1. Manuals
  2. Brands
  3. JVC Manuals
  4. IP Camera
  5. VN-686BU
  6. Api manual

JVC VN-686BU Api Manual

Hide thumbs Also See for VN-686BU:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Instruction 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
1

Advertisement

Table of Contents
loading

Related Manuals for JVC VN-686BU

Summary of Contents for JVC VN-686BU

  • Page 1 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...
  • Page 2 Updates Version Date Updates 1.00 2008/10/16 First release. 1.01 2008/10/31 P17. Typo is fixes. (difference -> different) 1.02 2009/02/03 Garbled characters are fixed. 1.03 2009/03/13 P10, P15 "searching" is added to status of Intelligent tracking. Target color is added to information of Intelligent tracking.
  • Page 3 Custom Application Software Development Guide VN-V685/686/686B can be used from a custom application software by utilizing the API and protocols for VN-V685/686/686B. The following operations are possible. - Getting JPEG from VN-V685/686/686B. - Getting MPEG-4 from VN-V685/686/686B. - Getting Alarm from VN-V685/686/686B. - Getting or changing VN-V685/686/686B settings.

  • Page 4: Table Of Contents

    Content 1. Getting JPEG from VN-V685/686/686B via HTTP 2. Getting MPEG-4 from VN-V685/686/686B via HTTP 3. API to Search VN-V685/686/686B 4. Getting Alarm from VN-V685/686/686B via TCP 5. Using API that Requires Basic Authentication 6. API for Getting/Changing Parameters of VN-V685/686/686B 7.

  • Page 5: Getting Jpeg From Vn-V685/686/686B Via Http

    HTTP/1.1 200 OK<CRLF> Connection: close<CRLF> Content-type: multipart/x-mixed-replace;boundary=-foo<CRLF> Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF> Server: JVC VN-V685 Network Camera<CRLF> x-vnv685_response: encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF> 4) VN-V685/686/686B sends out JPEG data after returning HTTP response. JPEG files with boundary structure will be sent out continuously after HTTP Response as follows. Content-Length in...
  • Page 6 boundary structure shows file size of each JPEG file. Using the size, reading the whole JPEG data becomes easy. HTTP Response -foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 31614<CRLF><CRLF> JPEG (No. 1) JPEG (No. 1) <CRLF> -foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 32756<CRLF><CRLF> JPEG (No. 2) <CRLF> When ptz_info=on is specified, boundary, pan/tilt/zoom information and JPEG file will be sent out continuously after HTTP Response as follows.
  • Page 7 X-Puls-Pan is from 0 to 35999. Range of -Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185 degrees. Range of X 500 and 18500 mean horizontal. X-Posi-Zoom is from 0 to 9999. Range of Details of JPEG file format is explained later.
  • Page 8 Example of VN-V685 HTTP/1.1 200 OK<CRLF> Content-Type: multipart/x-mixed-replace;boundary=--foo<CRLF> Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF> Server: JVC VN-V685 Network Camera<CRLF> x-vnv685_response: encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF> When API is successfully received with boundary=off VN-V685/686/686B will return 200 OK. Content-Length shows file size of first JPEG. The x-vnv686_response line indicates actual parameters.
  • Page 9 Intelligent tracking status" and "Target position of Intelligent tracking" are not available. Item Size Example Note Version Information JVC V1.0 Indicates the version of information stored in the comment segment. File Size size = 123456 Indicates JPEG size in bytes.

  • Page 10: Getting Mpeg-4 From Vn-V685/686/686B Via Http

    is created. Pan position pan = 123.45 Indicates pan position in degrees from 0.00 to 359.99. Tilt position tilt = 123.45 Indicates tilt position in degrees from 0.00 to 190.00. 0.00 corresponds to -5 degrees and 190.00 corresponds to 185 degrees. 5.00 and 185.00 mean horizontal.
  • Page 11 HTTP/1.1 200 OK<CRLF> Connection: close<CRLF> Content-Type: video/mp4v-es<CRLF> Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF> Server: JVC VN-V685 Network Camera<CRLF> x-vnv685_response: encode=mpeg4&framerate=15&framesize=vga&ptz_info=off<CRLF><CRLF> 4) VN-V685/686/686B sends out MPEG-4 data after returning HTTP response. HTTP Response and MPEG-4 stream sent out by VN-V685/686/686B are as follows.
  • Page 12 Example of Booundary and pan/tilt/zoom information: --foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 5914<CRLF> X-Puls-Pan: 0<CRLF> X-Puls-Tilt: 0<CRLF> X-Posi-Zoom: 0<CRLF><CRLF> X-Puls-Pan is from 0 to 35999. Range of -Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185 degrees. Range of X 500 and 18500 mean horizontal.
  • Page 13 HTTP/1.1 200 OK<CRLF> Connection: close<CRLF> Content-Type: video/mp4v-es<CRLF> Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF> Server: JVC VN-V685 Network Camera<CRLF> x-vnv685_response: encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF> MPEG-4 framerate can be changed by Web page or API. When MPEG-4 framerate is changed, the framerate of current stream is changed also.
  • Page 14 2.5. MPEG-4 Stream Format Sent Out by VN-V685/686/686B MPEG-4 stream from VN-V685/686/686B is MPEG-4 Part 2(ISO/IEC 14496-2) compliant, level 3 of simple profile. It is a sequence of I-VOPs, or I-VOPs and P-VOPs. I-VOP: Intra frame compressed data P-VOP: Inter frame compressed data with previous frame Ratio of I-VOP and P-VOP depends on I-Frame interval setting.

  • Page 15: Api To Search Vn-V685/686/686B

    Preset Position position = 0 Indicates preset position number after moving to Number preset position . In other cases, position = NA. Fan status fan = 0 Indicates status of fan . 1 means error. Intelligent tracking track_status = 0 Indicates status of Intelligent tracking .

  • Page 16: Using Api That Requires Basic Authentication

    4.2. Restrictions Maximum number of clients The maximum number of clients that may acquire alarm is 10. When a 11th client establishes TCP connection to port number 32040, VN-V685/686/686B disconnects the TCP connection. Additionally, VN-V685/686/686B will also check whether the TCP connection is maintained at regular intervals. VN-V685/686/686B will disconnect the TCP connection if syn exchange is not performed in 10 minutes.
  • Page 17 Content-Length: 80<CRLF> Content-type: text/plain<CRLF> Date: Fri, 13 MAY 2005 08:33:12 GMT<CRLF> Server: JVC VN-V685 API Server<CRLF> network.interface.subnetmask=255.0.0.0&200 OK<CRLF> 4) The client disconnects TCP80 to end the use of API. Note: APIs for getting/setting parameters are not restricted by the access restriction function.

  • Page 18: Api For Getting/Changing Parameters Of Vn-V685/686/686B

    6. API for Getting/Changing Parameters of VN-V685/686/686B This section provides description of APIs for getting/changing parameters of VN-V685/686/686B. Make use of the API explained in this section in the way as mentioned in Section 5 6.1. General (1) Getting parameter Specify API in GET line according to the format below when getting a parameter from VN-V685/686/686B.
  • Page 19 PTZ Controller of built-in viewer. Refer to the instruction manual for details on the Camera page and PTZ Controller. Saving Changes of Camera Settings Format /api/param?canera.status=data Example /api/param?canera.status=save Example of response canera.status&200 OK Interpretation Save or cancel changes to camera settings. Specify save or restore. By status=save, changes to camera settings are saved.
  • Page 20 Allowed users admin, operator Getting Monitor Type from VN-V685/686/686B Format /api/param?camera.image.monitortype Example of response camera.image.monitortype=lcd1&200 OK Interpretation Acquire the monitor type setting. Value is custome, lcd1, lcd2 or crt. When lcd1, lcd2 or crt is set, enhance band setting and gamma setting are ignored. Allowed users admin, operator, user Setting Monitor Type for VN-V685/686/686B Format /api/param?camera.image.monitortype=data...
  • Page 21 Getting Gamma from VN-V685/686/686B Format /api/param?camera.image.gamma Example of response camera.image.gamma=0.45&200 OK 1, 0.55, 0.5, 0.45 or active Interpretation Acquire gamma setting. Value of gamma is When lcd1, lcd2 or crt is set to monitor type, gamma setting is ignored. Allowed users admin, operator, user Setting Gamma for VN-V685/686/686B Format /api/param?camera.image.gamma=data Example of setting a value /api/param?camera.image.gamma=0.45...
  • Page 22 Format /api/param?camera.image.enhance.band Example of response camera.image.enhance.band=high&200 OK Interpretation Acquire enhance band setting. Value of enhance band is high or low. When lcd1, lcd2 or crt is set to monitor type, enhance band setting is ignored. Allowed users admin, operator, user Setting Enhance Band for VN-V685/686/686B Format /api/param?camera.image.enhance.band=data Example of setting a value /api/param?camera.image.enhance.band=low...
  • Page 23 levels. The larger the value, the stronger will be the color. Allowed users admin, operator, user Setting Color Level for VN-V685/686/686B Format /api/param?camera.image.color=data Example of setting a value /api/param?camera.image.color=50 Example of 1 step change /api/param?camera.image.color=+ Example of response camera.image.color&202 Accepted(camera.status=save) Interpretation Change color level value.
  • Page 24 Setting Stabilizer Level for VN-V685/686/686B Format /api/param?camera.image.stabilizer.level=data Example of setting /api/param?camera.image.stabilizer.level=0 Example of setting to strengthen /api/param?camera.image.stabilizer.level=+ Example of response camera.image.stabilizer.level&202 Accepted(camera.status=save) Interpretation Change stabilizer level setting. Specify from 0 to 100, "+" or "-". "+" or "-" changes the level 1 step. The level is 3 steps internally.
  • Page 25 Example of response camera.image.3ddnr=on&200 OK Interpretation Acquire 3D Noise Reduction setting. "off", "low", "mid", or "high" are returned. This API is available for VN-V685/686B from ver3.00. 3D Noise Reduction improves noise in dark image. Allowed users admin, operator, user Setting 3D Noise Reduction for VN-V685/686B Format /api/param?camera.image.3ddnr=data Example of setting /api/param?camera.image.3ddnr=on...
  • Page 26 Setting Limit of Sense Up for VN-V685/686/686B Format /api/param?camera.image.senseup_limit=data Example /api/param?camera.image.senseup_limit=4 Example of response camera.image.senseup_limit&202 Accepted(camera.status=save) Interpretation Change limit of sense up. Specify 0, 2, 4, 8, 16, 32, 64, 128, "+" or "-". 0 means sense up is disabled. It becomes bigger 1 step by specifying "+", smaller 1 step by specifying "-".
  • Page 27 Format /api/param?camera.shutter=data Example of setting a value /api/param?camera.shutter=60 Example of 1 step change /api/param?camera.shutter=+ Example of response camera.shutter&202 Accepted(camera.status=save) Interpretation Change shutter speed setting. Specify 60, 100, 250, 500, 1000, 2000, 4000, 10000, "+" or "-". To set 1/60 for example, specify 60. It becomes shorter 1 step by specifying "+", longer 1 step by specifying "-". The change is saved by the API, camera.status=save.
  • Page 28 Example /api/param?camera.image.true_daynight.af=on Example of response camera.image.true_daynight.af&202 Accepted(camera.status=save) Interpretation Change auto focus mode for B&W switching. Specify "on" or "off". When the setting is "on", auto focus works when B&W mode is switched. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
  • Page 29 Note of Iris Setting: After power on, iris setting of Home position is applied. After moving to preset position, iris setting of the position is applied. During Auto Pan and Auto Trace, iris setting for Auto Pan and Auto Trace is applied. When iris setting is changed by API, the change is temporal.
  • Page 30 Example of response camera.iris.status&200 OK Interpretation Start or stop iris operation. Specify "start" or "stop". Allowed users admin, operator Note of White Balance Setting: After power on, White Balance setting of Home position is applied. After moving to preset position, White Balance setting of the position is applied. During Auto Pan and Auto Trace, White Balance setting for Auto Pan and Auto Trace is applied.
  • Page 31 Setting R-Gain of White Balance for VN-V685/686/686B Format /api/param?camera.image.white_balance.r=data Example of response camera.image.white_balance.r&202 Accepted(camera.status=save or camera.motion.auto_pan.image=save) Interpretation Change R-gain white balance setting. Specify s0 to s255. The s before number means "step". Default value is s85. The change is saved to preset position by the API, camera(num).status=save. The change is saved to Auto Pan and Auto Trace by the API, camera.motion.auto_pan.image=save.
  • Page 32 Example of response camera.image.autowhite_balance.b=s219&200 OK Interpretation Acquire current B-gain of auto white balance. s0 to s255 is returned. The s before number means "step". Allowed users admin, operator, user Note of Back Light Compensation Setting: After power on, Back Light Compensation setting of Home position is applied.
  • Page 33 Format /api/param?encode(1).status=save /api/param?encode(2).status=save Example of response encode(1).status&200 OK Interpretation Save changes to encode settings. All JPEG and MPEG-4 settings are saved. If not saved, the changes are restored by power off of VN-V685/686/686B. Allowed users admin, operator Getting JPEG Frame Size from VN-V685/686/686B Format /api/param?encode(1).framesize Example of response encode(1).framesize=vga&200 OK Interpretation Acquire JPEG frame size setting.
  • Page 34 Example of response encode(1).cbr_mode&202 Accepted(encode(1).status=save) Interpretation Change rate control of JPEG. Rate control can be set to vfs or afs. In vfs (VariableFileSize), quantization table is fixed. In afs (AverageFileSize), average file size of multiple JPEGs is controlled to be constant. The change is saved by the API, encode(1).status=save.
  • Page 35 Example of response encode(2).framesize=vga&200 OK Interpretation Acquire MPEG-4 frame size setting. "vga" or "qvga" is returned. Allowed users admin, operator, user Setting MPEG-4 Frame Size for VN-V685/686/686B Format /api/param?encode(2).framesize=data Example /api/param?encode(2).framesize=qvga Example of response encode(2).framesize&202 Accepted(encode(1).status=save) Interpretation Change MPEG-4 frame size. Specify "vga" or "qvga". When frame size of JPEG and MPEG-4 are same, privacy masking is available for both compression.
  • Page 36 Format /api/param?encode(2).cbr_mode=data Example /api/param?encode(2).cbr_mode=vbr Example of response encode(2).cbr_mode&202 Accepted(encode(2).status=save) Interpretation Change rate control of MPEG-4. Rate control can be set to cbr or vbr. Bitrate is controlled to be constant in the case of cbr (Constant Bitrate). In the case of vbr (Variable Bitrate), bitrate can be larger by input image. If vbr is set, frame rate of MPEG-4 becomes 30fps.

  • Page 37: Alarm Setting

    210 or 240, real frame rate is as frame rate setting. If I-Frame interval is not 30, 60, 120, 150, 180, 210 or 240, real frame rate becomes larger than the setting because I-Frame can not be skipped. If I-Frame setting is 1, all frames become I-Frame and frame rate becomes 30fps.
  • Page 38 Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for VN-V685/686/686B Format /api/param?application.event(Number).status=data Example When setting alarm action No. 1 to off /api/param?application.event(1).status=off Example of response application.event(1).status&200 OK Interpretation Set the alarm action of the specified alarm action number to on/off, or enable changes to the alarm action.
  • Page 39 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 When sending via UDP is specified, udpto, IP address, port number and the character string to be sent will be returned.
  • Page 40 /api/param?application.event(1).action=mailto/somebody@somecompany.com/none/Me ssage Example of Response application.event(1).action&202 Accepted(application.event(1).status=restart) Interpretation Set the alarm action of the specified alarm number. Up to 5 alarm actions can be specified, and therefore the number of alarm(number) can also be set between the range of 1 to 5. Note that alarm numbers are different from the alarm input pin numbers.
  • Page 41 Setting Example /api/param?application.event(1).action=tcpto/10.0.0.100/20000/Message Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
  • Page 42 Interpretation Acquire filter setting of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay.
  • Page 43 Format /api/param?application.event(Number).filter(WeekOfDay).time=data Example When setting Sunday filter time of Alarm No. 1 /api/param?application.event(1).filter(sunday).time=010200-040500 Example of Response application.event(1).filter(sunday).time&202 Accepted(application.event(1).status=restart) Interpretation Set filter time of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6.
  • Page 44 specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Specify mask or unmask.
  • Page 45 Format /api/param?application.event(Number).trigger=data Example When setting Trigger of Alarm No. 1 /api/param?application.event(1).trigger=m1 Example of Response application.event(1).trigger&202 Accepted(application.event(1).status=restart) Interpretation Set Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6.
  • Page 46 Example of Response application.smtp.host=192.168.0.200&200 OK Response example when setting field is left blank application.smtp.host=&200 OK Interpretation Acquire the address setting of the SMTP server. Allowed users admin, operator, user Setting SMTP Server Address for VN-V685/686/686B Format /api/param?application.smtp.host=data Example /api/param?application.smtp.host=192.168.0.200 Example of Response application.smtp.host&200 OK Interpretation Change the address setting of the SMTP server.
  • Page 47 Setting Sender Mail Address for VN-V685/686/686B Format /api/param?application.smtp.mailfrom=data Example /api/param?application.smtp.mailfrom=somebody@somecompany.com Example of Response application.smtp.mailfrom&200 OK Interpretation Change sender mail address setting. Maximum text number of sender mail address is 96. Alphanumeric and followings are available. ! # $ % & ' * + - / = ? ^ _ ` { } | ~ POP user name is used as local part of sender mail address when sender mail address setting is blank.
  • Page 48 Example /api/param?application.pop.host=192.168.0.200 Example of Response application.pop.host&200 OK Interpretation Change the address setting of the POP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the POP server is not set. It is also possible to leave the setting field blank as follows.
  • Page 49 /api/param?application.pop.user=%00 The user name is used as local part of sender mail address when sender mail address setting is blank. When the user name is blank, the local-part is set to "vn_v686". When POP before SMTP is disabled, it is not necessary to set POP server settings other than POP user name setting.
  • Page 50 Format /api/param?application.ftp.path Example of Response application.ftp.path=subdir1&200 OK Response example when setting field is left blank application.ftp.path=&200 OK Interpretation Acquire the FTP server directory setting used for FTP transmission via alarm. Allowed users admin, operator, user Setting FTP Server Path for VN-V685/686/686B Format /api/param?application.ftp.path=data Example /api/param?application.ftp.path=subdir1 Example of Response application.ftp.path&200 OK...
  • Page 51 Example /api/param?application.ftp.password=someword Example of Response application.ftp.password&200 OK Interpretation Change the FTP server password setting used for FTP transmission via alarm. The maximum password size is 32 bytes. Set as follows when this setting is to be left blank. /api/param?application.ftp.password=%00 Allowed users admin, operator (There is no API for Getting passwords.) Getting File Naming of Periodic FTP from VN-V685/686/686B Format /api/param?application.ftp.naming...
  • Page 52 Getting User Define Name of File Naming from VN-V685/686/686B Format /api/param?application.ftp.naming_option Example of Response application.ftp.naming_option=abc&200 OK Interpretation Acquire user define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?application.ftp.naming_option is set to "type1", the file name is as ***YYYMMDDHHMMSSNNN.jpg, and "***"...
  • Page 53 Setting Parameters of Pre/Post Recording for VN-V685/686/686B Format To set Frame Rate /api/param?application.object.framerate=5 To set Pre Duration /api/param?application.object.prerec=3 To set Post Duration /api/param?application.object.postrec=3 Example of Response For Frame Rate application.object.framerate&200 OK For Pre Duration /api/param?application.object.prerec&200 OK For Post Duration /api/param?application.object.postrec&200 OK Interpretation Change parameters for PrePost + ftp.
  • Page 54 Allowed users admin, operator, user Changing Alarm Output of VN-V685/686/686B Format /api/param?peripheral.output_pin.pin(Number).status=data Example /api/param?peripheral.output_pin.pin(1).status=break Example of Response peripheral.output_pin.pin(1).status&200 OK Interpretation Change the alarm output. Specify 1 or 2 to Number. Specify "make" or "break" to data. When the alarm output time is zero, alarm output is changed as this API specifies. When the alarm output time is not zero, alarm output is changed as this API specifies, then alarm output is changed again after the alarm output time.
  • Page 55 Getting Timeout of Auto Return from VN-V685/686/686B Format /api/param?camera.motion.auto_return.timeout Example of response camera.motion.auto_return.timeout=60&200 OK Interpretation Acquire timeout of Auto Return in seconds. Allowed users admin, operator, user Setting Timeout of Auto Return for VN-V685/686/686B Format /api/param?camera.motion.auto_return.timeout=data Example of Response camera.motion.auto_return.timeout&202 Accepted(camera.status=save) Interpretation Change timeout of Auto Return in seconds.
  • Page 56 Start/Stop of Auto Tracking for VN-V685/686/686B Format /api/param?camera.motion.auto_tracking(1).status=data /api/param?camera.motion.auto_tracking(2).status=data Example of Response camera.motion.auto_tracking(1).status&200 OK Interpretation Start or stop Auto tracking or Intelligent tracking. Specify "start" or "stop". When auto tracking is started, the camera moves to home position, then starts Auto Tracking. Motion detection is disabled during Auto Tracking.
  • Page 57 Example of Response camera.motion.auto_tracking(1).level&202 Accepted(camera.status=save) Interpretation Change detection level of Auto Tracking. Or change detection level of starting Intelligent tracking by Auto Return. Specify from 0 to 100. 100 is most sensitive. The level is 11 steps internally.The change is saved by the API, camera.status=save.
  • Page 58 Setting Detection Area of Intelligent Tracking for VN-V685/686/686B Format /api/param?camera.motion.auto_tracking(2).area=data Example of Response camera.motion.auto_tracking(2).area&202 Accepted(camera.status=save) Interpretation Change detection area of Intelligent Tracking when it is started by Auto Return. In VN-V686 before v1.02, this API is not available. The meaning of value is same as motion detection area. The change is saved by the API, camera.status=save.
  • Page 59 Setting Zoom Limit of Intelligent Tracking for VN-V685/686/686B Format /api/param?camera.motion.auto_tracking(2).zoom_limit=data Example of Response camera.motion.auto_tracking(2).zoom_limit&202 Accepted(camera.status=save) Interpretation Change zoom limit of Intelligent Tracking. In VN-V686 before v1.02, this API is not available. This is valid when tracking zoom setting is on. Specify value from 1.00 to 21.37. The change is saved by the API, camera.status=save.
  • Page 60 Example of Response camera.motion.auto_tracking(2).threshold.hsv&202 Accepted(camera.status=save) Interpretation Change threshold of Intelligent Tracking. In VN-V686 before v1.02, this API is not available. 2 APIs for setting HSV threshold and YUV threshold are availble. In case of HSV, H is from 0 to 180, S/V is from 0 to 255. In case of RGB, R/G/B is from 0 to 255.
  • Page 61 Interpretation Change upper limit of EZoom. Specify 1, 2, 4, 8, 16 or 32. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting On/Off of Pan Limit from VN-V685/686/686B Format /api/param?camera.motion.pan.limit.status Example of response camera.motion.pan.limit.status=off&200 OK Interpretation Acquire On/Off of Pan Limit.
  • Page 62 Setting Right Side of Pan Limit for VN-V685/686/686B Format /api/param?camera.motion.pan.limit.right=present Example of Response camera.motion.pan.limit.right&200 OK Interpretation Set current pan position as right side of Pan Limit. Allowed users admin, operator Moving to Left/Right Side of Pan Limit for VN-V685/686/686B Format /api/param?camera.motion.pan.status=data Example to move ot left side /api/param?camera.motion.pan.status=goto_leftlimit Example of Response camera.motion.pan.status&200 OK...
  • Page 63 Format /api/param?camera.motion.position.speed=data Example to set horizontal /api/param?camera.motion.position.speed=100 Example of Response camera.motion.position.speed&202 Accepted(camera.status=save) Interpretation Set speed of going to preset position. Specify from 0 to 100. 5 is horizontal. 100 is fastest. The speed is 4 steps internally. The speed is applied also to preset position of auto patrol. The change is saved by the API, camera.status=save.
  • Page 64 Interpretation Acquire current status of digital flip. "on" or "off" is returned. When off is returned, the image is not reversed. When onn is returned, the image is reversed. Allowed users admin, operator, user (2) PTZ Control Getting Pan Position from VN-V685/686/686B Format /api/param?camera.motion.pan Example of response camera.motion.pan=45.00&200 OK Interpretation Acquire current pan position in degrees.
  • Page 65 Example of Response camera.motion.pan.speed&200 OK Interpretation Set speed of pan operation. Specify 0 to 100. The speed is 8 steps internally. Allowed users admin, operator Getting Pan Operation Status from VN-V685/686/686B Format /api/param?camera.motion.pan.status Example of Response camera.motion.pan.status=moving&200 OK Interpretation Acquire current pan status. "moving" or "stop" is returned. Allowed users admin, operator, user Getting Status of Variable Pan/Tilt Speed from VN-V685/686/686B Format /api/param?camera.motion.variable_pantiltspeed.status...
  • Page 66 Example of Response camera.motion.tilt&200 OK Interpretation Move to specified tilt position. To move to absolute position, specify from 0.00 to 190.00. 0.00 means -5 degrees and 190.00 means 185.00 degrees. 5.00 and 185.00 are horizontal. Allowed users admin, operator Tilt Operation for VN-V685/686/686B Format /api/param?camera.motion.tilt.status=data Example to start pan /api/param?camera.motion.tilt.status=start...
  • Page 67 Interpretation Acquire current zoom position. Value from 0.00 to 99.99 is returned. 0.00 means Wide edge and 99.99 means Tele edge. Allowed users admin, operator, user Moving to Specified Zoom Position for VN-V685/686/686B Format /api/param?camera.motion.zoom=data Example to move to absolute 50.00 /api/param?camera.motion.zoom=50.00 Example to move to relative 5 Tele /api/param?camera.motion.zoom=+5.00...
  • Page 68 Format /api/param?camera.motion.zoom.status Example of Response camera.motion.zoom.status=moving&200 OK Interpretation Acquire current zoom status. "moving" or "stop" is returned. Allowed users admin, operator, user Moving Specified Position to Center for VN-V685/686/686B Format /api/param?camera.motion.clickoncenter=X-Y Example of Response camera.motion.clickoncenter&200 OK Example to move (160, 120) to center (pixel) /api/param?camera.motion.clickoncenter=s160-s120 Example to move (160, 120) to center (percentage) /api/param?camera.motion.clickoncenter=25.00-25.00...
  • Page 69 99.99 means Far edge. Specify easy_auto for auto focus. Specify op_auto for one push auto focus. Specify manual for changing from auto to manual. Auto focus works after pan/tilt/zoom operation. Auto focus does not work after moving absolute/relative position of pan/tilt/zoom. Allowed users admin, operator Focus Operation for VN-V685/686/686B Format /api/param?camera.focus.status=data...
  • Page 70 Example of response camera.position(3).status=unregistered&200 OK Interpretation Acquire current status of specified preset position. Specify from 0 to 99 as position number. "unregistered" or "registered" is returned. Allowed users admin, operator, user Register Current Position as Preset Position for VN-V685/686/686B Format /api/param?camera.position(number).status=save Example of Response camera.position(3).status&200 OK Interpretation Save current position as preset position.
  • Page 71 Example of Response camera.position(3).status&200 OK Interpretation Set tilte to specified preset position. Specify from 0 to 99 as position number. Maximum characters is 32. To erase title, specify %00, i.e. 0x25 0x30 0x30 in binary data. Use %20 to set space. Allowed users admin, operator (4) Auto Pan Getting Status of Auto Pan from VN-V685/686/686B...
  • Page 72 camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Speed of Auto Pan from VN-V685/686/686B Format /api/param?camera.motion.auto_pan.speed Example of response camera.motion.auto_pan.speed=50&200 OK Interpretation Acquire speed of auto pan. Value from 0 to 100 is returned. The speed is 3 steps internally. Allowed users admin, operator, user Setting Speed of Auto Pan for VN-V685/686/686B Format /api/param?camera.motion.auto_pan.speed=data...
  • Page 73 Example of response camera.motion.auto_trace.status=moving&200 OK Interpretation Acquire current status of auto trace. "moving" of "stop" is returned. Allowed users admin, operator, user Start/Stop of Auto Trace for VN-V685/686/686B Format /api/param?camera.motion.auto_trace.status=data Example to start auto trace /api/param?camera.motion.auto_trace.status=start Example to stop auto trace /api/param?camera.motion.auto_trace.status=stop Example of Response camera.motion.auto_trace.status&200 OK Interpretation Start/stop auto trace.

  • Page 74: Auto Patrol

    6.7. Auto Patrol The APIs below are related to auto patrol. These are equivalent to the features on the Auto Patrol page of the WEB setting page. Refer to the instruction manual for details on the Auto Patrol page. Start/Stop of Auto Patrol for VN-V685/686/686B Format /api/param?camera.motion.auto_patrol(number).status=data Example to start auto patrol mode 1 /api/param?camera.motion.auto_patrol(0).status=start...

  • Page 75: Privacy Masking

    Interpretation Set preset position number of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2. Patrol number is from 0 to 99. Specify preset position number from 0 to 99. The change is saved by the API, camera.motion.auto_patrol.status=save.
  • Page 76 WEB setting page. Refer to the instruction manual for details on the Privacy Masking page. Getting Whole Status of Privacy Masking from VN-V685/686/686B Format /api/param?camera.private_mask.status Example of response camera.private_mask.status=on&200 OK Interpretation Acquire the whole status of privacy masking. "on" or "off" is returned. When this status is off, all privacy masking areas disappear.
  • Page 77 exmaple, ffffff is white, 808080 is gray, 000000 is black. The brightness is 11 steps internally. Allowed users admin, operator, user Setting Privacy Masking Brightness for VN-V685/686/686B Format /api/param?camera.private_mask.color=data Example of Response camera.private_mask.color&202 Accepted(camera.status=save) Interpretation Change the brightness of privacy masking. Specify RGB values by hexadecimal number. For exmaple, ffffff for white, 808080 for gray, 000000 for black.The change is saved by the API, camera.status=save.

  • Page 78: Motion Detect

    Interpretation Change the height of editing privacy masking area. Specify + or -. Before use this API, starting editing is required. Allowed users admin, operator 6.9. Motion Detect The APIs below are related to motion detection. These are equivalent to the features on the Motion Detection page of the WEB setting page.
  • Page 79 Allowed users admin, operator Getting Motion Detect Mask from VN-V685/686/686B Format /api/param?camera.detection.area Example of response camera.detection.area=000102030405060708090001&200 OK Interpretation Acquire the mask of motion detect. 24 ASCII characters will be returned. The screen of VN-V685/686/686B is made up of 12 x 8 = 96 blocks, and mask can be set to on/off for each block. This information can be represented in 96 bits = 12-byte hexadecimal.
  • Page 80 Interpretation Changes of following network parameters become valid by this API. DHCP, IP Address, Subnet Mask, TTL, MTU, TOS, Negotiation, IPv6 Changes are not reflected in the actions until this API is used. APIs to get settings of those parameters return previous values until this API is used.
  • Page 81 Getting Subnet Mask from VN-V685/686/686B Format /api/param?network.interface.subnetmask Example of Response network.interface.subnetmask=255.255.255.0&200 OK Interpretation Acquire the current subnet mask. Allowed users admin, operator, user Setting Subnet Mask for VN-V685/686/686B Format /api/param?network.interface.subnetmask=data Example /api/param?network.interface.subnetmask=255.0.0.0 Example of Response network.interface.subnetmask&202 Accepted(network.interface.status=restart) Interpretation Change the subnet mask. To validate the change, use "network.interface.status=restart" API that reboots VN-V685/686/686B in about 1 minute.
  • Page 82 Interpretation Acquire the current host name. Allowed users admin, operator, user Setting Host Name for VN-V685/686/686B Format /api/param?network.hostname=data Example /api/param?network.hostname=somename Example of Response network.hostname&200 OK Interpretation Change the host name. Characters that may be used for the host name are alphanumerics, hyphens (-) and period.
  • Page 83 Example /api/param?network.dns.ip=10.0.0.150 Example of Response network.dns.ip&202 Accepted(network.dns.status=restart) Interpretation Change IP address of DNS server. To validate the change, use "network.dns.status=restart" API. Allowed users admin, operator Getting IPv6 status from VN-V685/686/686B Format /api/param?network.interface.ipv6.status Example of Response network.interface.ipv6.status=off&200 OK Interpretation Acquire IPv6 status. "on" or "off" is returned. In VN-V686, this API is not available. Allowed users admin, operator, user Setting IPv6 status for VN-V685/686/686B Format /api/param?network.interface.ipv6.status=data...

  • Page 84: Network Details

    Interpretation Acquire the global address of IPv6. Specify from 1 to 8 for Number, and get addresses from 1 till vacant address is returned. In VN-V686, this API is not available. There is no API for setting global address of IPv6. Allowed users admin, operator, user Getting MAC Address from VN-V685/686/686B Format /api/param?network.interface.mac...
  • Page 85 Allowed users admin, operator, user Setting TOS Value of MPEG-4 for VN-V685/686/686B Format /api/param?network.interface.dscp.video.mpeg=data Example /api/param?network.interface.dscp.video.mpeg=56 Example of Response network.interface.dscp.video.mpeg&202 Accepted(network.interface.status=restart) Interpretation Change TOS that includes DHCP field for MPEG-4. The range of set value is between 0 to 255 though MSB 6 bits in the value is valid.
  • Page 86 Example of Response network.interface.ttl.multicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of multicast. The range of set value is between 1 to 255. To validate the change, use "network.interface.status=restart" API. Allowed user admin Getting MTU Value VN-V685/686/686B Format /api/param?network.interface.mtu Example of Response network.interface.mtu=1420&200 OK Interpretation Acquire the MTU value.
  • Page 87 6.12. Protocol The APIs below are related to protocol. These are equivalent to the features on the Protocol page of the WEB setting page. Refer to the instruction manual for details on the Protocol page. Getting Port Number of HTTP from VN-V685/686/686B Format /api/param?network.http.port Example of Response network.http.port=80&200 OK Interpretation Acquire port number of HTTP server in VN-V685/686/686B.
  • Page 88 Format /api/param?network.vsip_server.port Example of Response network.vsip_server.port=5510&200 OK Interpretation Acquire port number of VSIP server in VN-V685/686/686B. In VN-V686, this API is not available. Allowed users admin, operator Setting Port Number of VSIP for VN-V685/686/686B Format /api/param?network.vsip_server.port=data Example of Response network.vsip_server.port&202 Accepted(network.vsip_server.status=restart) Interpretation Change port number of VSIP server in VN-V685/686/686B.
  • Page 89 Format /api/param?network.http(streaming).priority=data Example /api/param?network.http(streaming).priority=clientnumber Example of Response network.http(streaming).priority&202 Accepted(network.http(configuration).status=restart) Interpretation Change mode of JPEG streaming. Specify "framerate" or "clientnumber". This API is available for VN-V685/686B from v2.00. In case of "clientnumber", VN-V685/686B accepts many clients though requested JPEG framerate from clients is not kept. In case of "framerate", VN-V685/686B keeps JPEG framerate as clients requested though number of clients is limited.
  • Page 90 Allowed users admin, operator Setting JPEG Multicast Address for VN-V685/686/686B Format /api/param?network.destination(1).host=data Example /api/param?network.destination(1).host=225.0.1.1 Example of Response network.destination(1).host&202 Accepted(network.destination(1).host=save) Interpretation Change JPEG multicast address. Specify from 224.0.0.0 to 239.255.255.255. To validate the change, use "network.destination(1).host=save" API. After the save, start streaming by "network.destination(1).host=start" API.
  • Page 91 Example of Response network.destination(1).framerate&202 Accepted(network.destination(1).host=save) Interpretation Change JPEG multicast frame rate. Specify 30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1, -2, -3, -5, -10, -15, -20, or -30. -5 means 1/5fps for example. To validate the change, use "network.destination(1).host=save" API. After the save, start streaming by "network.destination(1).host=start"...

  • Page 92: Access Restrictions

    Interpretation Change MPEG-4 multicast address. Specify from 224.0.0.0 to 239.255.255.255. To validate the change, use "network.destination(2).host=save" API. After the save, start streaming by "network.destination(2).host=start" API. Allowed user admin Getting MPEG-4 Multicast Port Number from VN-V685/686/686B Format /api/param?network.destination(2).port Example of Response network.destination(2).port=59152&200 OK Interpretation Acquire MPEG-4 multicast port number.
  • Page 93 Interpretation Change the deny/allow setting of client restrictions. Specify as deny or allow. These restrictions are applied to getting JPEG/MPEG-4. Allowed user admin Getting IP Address Setting of Restricted Client from VN-V685/686/686B Format /api/param?network.access_control(stream_out).host(Number) Example When Getting the first IP address /api/param?network.access_control(stream_out).host(1) Example of Response network.access_control(stream_out).host(1)=10.0.0.100&200 OK Interpretation Acquire the IP address setting of the restricted client.
  • Page 94 Getting On/Off of SNTP Client from VN-V685/686/686B Format /api/param?network.ntp.status Example of Response network.ntp.status=off&200 OK Interpretation Acquire the on/off status of SNTP client. Either on or off will be returned. Allowed users admin, operator, user Setting On/Off of SNTP Client, or Validate Changes for VN-V685/686/686B Format /api/param?network.ntp.status=data Example /api/param?network.ntp.status=on Example of Response network.ntp.status&200 OK...
  • Page 95 Format /api/param?network.ntp.interval=data Example /api/param?network.ntp.interval=60 Example of Response network.ntp.interval&202 Accepted(network.ntp.status=restart) Interpretation Change the interval for accessing the NTP server. Unit can be set by "network.ntp.unit" API. Specify 1-60 when the unit is min/hour, 1-31 when the unit is day. To validate the change, use "network.ntp.status=restart" API. Allowed users admin, operator Getting Access Interval Unit of NTP from VN-V685/686/686B Format /api/param?network.ntp.unit...
  • Page 96 hour, minute and second. Specify year in a 4-digit decimal number, and month, day, hour, minute and second in 2-digit decimal numbers. Allowed user admin Getting Timezone from VN-V685/686/686B Format /api/param?system.timezone Example of Response system.timezone=Pacific&200 OK Interpretation Acquire the timezone from VN-V685/686/686B. Character strings in the following table will be returned.
  • Page 97 GMT+5:30 Timezone that is 5 hours and 30 minutes later than the Greenwich Mean Time. Calcutta Same timezone as GMT+5:30 GMT+5:45 Timezone that is 5 hours and 45 minutes later than the Greenwich Mean Time. GMT+6 Timezone that is 6 hours later than the Greenwich Mean Time. GMT+6:30 Timezone that is 6 hours and 30 minutes later than the Greenwich Mean Time.

  • Page 98: Firmware Update

    There is no API for Getting passwords. Allowed user admin 6.17. Maintenance The APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the WEB setting page. Refer to the instruction manual for details on the Maintenance page. Initialization Format /api/param?system.status=initialize Example of Response system.status&200 OK...
  • Page 99 Interpretation Acquire time of auto cleaning. Time is returned in format of hhmmss. Allowed users admin, operator, user Setting Time of Auto Cleaning for VN-V685/686/686B Format /api/param?camera.motion.pan.auto_cleaning.time=data Example of Response camera.motion.pan.auto_cleaning.time&202 Accepted(camera.status=save) Interpretation Change time of auto cleaning. Specify time in format of hhmmss. To save the change, use "camera.status=save"...
  • Page 100 system.session.sending(01).from.framerate=1&200 OK system.session.sending(01).from.framesize=vga&200 OK In case of MPEG-4, system.session.sending(01).from.encode=mpeg4 is returned. In case of multicast, system.session.sending(01).to.ip becomes multicast IP address. Interpretation Acquire the sending status of VN-V685/686/686B. Starting and stopping stream can be occurred in random order, so it can happen that sending(01) is vacant though sending(02) has information. Allowed users admin, operator, user Getting Log Format /api/param?system.log...
  • Page 101 Format /api/param?system.software.revision(net) Example of Response system.software.revision(net)=V1-00&200 OK Interpretation Acquire firmware revisions of streaming manager. Allowed users admin, operator, user Getting Firmware Revisions of PTZ Controller Format /api/param?system.software.revision(sys) Example of Response system.software.revision(sys)=V1-00&200 OK Interpretation Acquire firmware revisions of ptz controller. Allowed users admin, operator, user Getting Firmware Revisions of Image Processor Format /api/param?system.software.revision(cam) Example of Response system.software.revision(cam)=V1-00&200 OK...
  • Page 102 Interpretation Acquire the current alarm input status. Specify 1 or 2 to Number. Either make or break will be returned. Allowed users admin, operator, user Getting Mode of FTP Server from VN-V685/686/686B Format /api/param?application.ftp.mode Example of Response application.ftp.mode=active&200 OK Interpretation Acquire the mode of FTP server that is used by alarm action. Either active or passive is returned. active mode: Standard mode of FTP server.

  • Page 103: List Of Protocols And Port Numbers Used With Vn-V685/686/686B

    Interpretation Change port number for control of FTP server that is used by alarm action. Default is 21. Port number for data plus one is the port number for control. Allowed user admin, operator 7. List of Protocols and Port Numbers Used with VN-V685/686/686B VN-V685/686/686B uses the following protocols and port numbers.
  • Page 104 <VN-V685/VN-V686B> http://(IP Address)/v686.cab ... JPEG/MPEG-4 Viewer, PTZ Control Client Ex.) When IP address of VN-V685/686/686B is “192.168.0.2”: http://192.168.0.2/v686.cab ii) Download dialog box is showed. Please click save button and copy to some folder in the PC. 8.2. Properties of ActiveX JPEG Viewer/MPEG-4 Viewer Property Meaning...
  • Page 105 Timestamp Get current time from camera *MPEG-4 only *This property is read only. TimeFormat Format of Time Code ( 0: YYYY/MM/DD HH:MM:SS.mm 1: YYYY/MM/DD HH:MM:SS 2: DD/MM/YYYY HH:MM:SS 3: MM/DD/YYYY HH:MM:SS 4: MM/DD HH:MM:SS 5: HH:MM:SS 6: HH:MM) *Y: Year M: Month D: Day H: Hour M: Minute S: Second m: milli second Default: 1 FolderName Folder Name of saving still images.
  • Page 106 n: Position Number (0 – 99) MODEL Kind of camera (0: VN-V685, 1: VN-V686/VN-V686B) *This property is not supported by ActiveX built in VN-V686 before v1.04. *If this property is not set, zoom control is likely not correctly. Version2 If you use Intelligent Tracking, this property is set at 1. (0: not use, 1: use) Default: 0 *This property is not supported by VN-V686 before v1.02.
  • Page 107 <PARAM NAME="IP" VALUE="192.168.0.2"> <PARAM NAME="HttpPort" VALUE="80"> <PARAM NAME="DispWidth" VALUE="640"> <PARAM NAME="DispHeight" VALUE="480"> <PARAM NAME="FrameRate" VALUE="15"> <PARAM NAME="StreamType" VALUE="0"> <PARAM NAME="OpPassword" VALUE="jvc"> </OBJECT> MPEG-4 Viewer <OBJECT ID="MPEG4Viewer" WIDTH = 640 HEIGHT= 480 8AAD6441-AE84-4310-9F16-2407AC46548E CLASSID="CLSID: " CODEBASE="./v686.cab#version=1,0,0,2" <PARAM NAME="IP" VALUE="192.168.0.2"> <PARAM NAME="HttpPort"...
  • Page 108 CLASSID is possible to confirm it by defrosting the cabinet file, and opening the set up information file with the text editor. (ii) CODEBASE The cabinet file name of CODEBASE becomes a cabinet file name that contains ActiveX that wants to be used.
  • Page 109 PTControl(num){ if (f_init == 0) InitPTZCtrl(); PTZCtrl.ManualCtrl(num); function ZoomControl(num){ if (f_init == 0) InitPTZCtrl(); PTZCtrl.ZoomCtrl(num); function InitPTZCtrl(){ PTZCtrl.OpPassword = "jvc"; PTZCtrl.IP = myForm.IP.value; PTZCtrl.HttpPort = myForm.HTTP_PORT.value; PTZCtrl.UserLevel = 1; //operator PTZCtrl.MODEL = 0; PTZCtrl.Initialize(); f_init = 1; function mouse_up(){ PTZCtrl.Stop();...
  • Page 110 <PARAM NAME="DispHeight" VALUE="480"> <PARAM NAME="FolderName" VALUE="VN-V685"> <PARAM NAME="FrameRate" VALUE="15"> <PARAM NAME="RcvMode" VALUE="0"> <PARAM NAME="OpPassword" VALUE="jvc"> </OBJECT> <!-- PTZ Control ActiveX --> <OBJECT ID="PTZCtrl" WIDTH = 1 HEIGHT= 1 CLASSID="CLSID:877CBEB7-33CA-44c4-AC85-D7EDC55D0591"> <PARAM NAME="IP" VALUE="192.168.0.2"> <PARAM NAME="HttpPort" VALUE="80"> </OBJECT> <FORM NAME="myForm"> <table> <tr>...

  • Page 111: Faq

    STYLE="width:40px;top:635px;left:134px;position:absolute" onmousedown="ZoomControl(0)" onmouseup="mouse_up()" onmouseout="mouse_up()"> <INPUT TYPE="BUTTON" NAME="WIDE_BTN" VALUE="-" STYLE="width:40px;top:665px;left:134px;position:absolute" onmousedown="ZoomControl(1)" onmouseup="mouse_up()" onmouseout="mouse_up()"> </FORM> </BODY> </HTML> 8.6. Notes - Enable the JPEG/MPEG-4 frame size that you want in “Basic Settings2” or “Encoding” page of VN-V686/685/686B. - Start Multicast stream on VN-V686/685/686B Web page to use Multicast. The ActiveX control does not send request to VN-V686/685/686B for starting Multicast stream.

This manual is also suitable for:

Vn-686uVn-v685u

Table of Contents