Security Camera User Manual

Manuals Brands JVC Manuals Security Camera VN-V686UAPI

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

Summary of content (105 pages)

PAGE 1

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.
PAGE 2

Updates Version Date Updates 1.00 2007/12/13 First release. 1.01 2008/4/25 1.02 2008/6/19 Limitation of Registering Preset Position is added. Fixed auto patrol number for auto return. Fixed api text for getting status of a privacy masking area. - Boundary option is added to JPEG request API. - Status of Intelligent tracking is added to JPEG format and MPEG-4 stream. - APIs for Intelligent tracking are added. - APIs to get current red/blue gain of auto white balance are added.
PAGE 3

Custom Application Software Development Guide VN-V686 can be used from a custom application software by utilizing the API and protocols for VN-V686. The following operations are possible. ● Getting JPEG from VN-V686. ● Getting MPEG-4 from VN-V686. ● Getting Alarm from VN-V686. ● Getting or changing VN-V686 settings. ● Pan/Tilt/Zoom/Focus operation of VN-V686. ● Sending Multicast from VN-V686. ● Customization of VN-V686's built-in viewer.
PAGE 4

Content 1. Getting JPEG from VN-V686 via HTTP 2. Getting MPEG-4 from VN-V686 via HTTP 3. API to Search VN-V686 4. Getting Alarm from VN-V686 via TCP 5. Using API that Requires Basic Authentication 6. API for Getting/Changing Parameters of VN-V686 7. List of Protocols and Port Numbers Used with VN-V686 8. Customizing VN-V686's Built-in Viewer 9.
PAGE 5

1. Getting JPEG from VN-V686 via HTTP 1.1. Basic Procedures 1) The client establishes a TCP connection to port number 80. 2) The client sends out API. Example GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1 Host: 192.168.0.2 Note denotes the line feed code (0x0D, 0x0A). 3) VN-V686 returns HTTP response. Example HTTP/1.
PAGE 6

,,, When ptz_info=on is specified, boundary, pan/tilt/zoom information and JPEG file will be sent out continuously after HTTP Response as follows. HTTP Response boundary pan/tilt/zoom information JPEG (No. 1) boundary pan/tilt/zoom information JPEG (No. 2) ,,, Example of Booundary and pan/tilt/zoom information: --foo Content-Type: image/jpeg Content-Length: 31200 X-Puls-Pan: 0 X-Puls-Tilt: 0 X-Posi-Zoom: 0 Range of X-Puls-Pan is from 0 to 35999.
PAGE 7

1.2. API Format Structure GET space API space HTTP/1.1 Host: space IP Address of VN-V686 0x0D 0x0A 0x0D 0x0A 0x0D 0x0A Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary. Example GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1 Host: 192.168.0.2 Parameter value is indicated using =. Do not insert space before and after =.
PAGE 8

HTTP/1.1 200 OK Content-Type: multipart/x-mixed-replace;boundary=--foo Date: Tue, 02 Oct 2007 07:33:12 GMT Server: JVC VN-V686 Network Camera x-vnv686_response: encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off When API is successfully received with boundary=off VN-V686 will return 200 OK. Content-Length shows file size of first JPEG. The x-vnv686_response line indicates actual parameters. Example HTTP/1.
PAGE 9

Start Code Application Segment Comment Segment 1 Comment Segment 2 (reserved) DHT Huffman Table DQT Quantization Table DRI Restart Interval SOF Frame Information Data Start Segment End Code FFD8 FFE0 FFFE FFFE FFC4 FFDB FFDD FFC0 FFDA FFD9 The following information is stored in the comment segment 1. Each item has a fixed length. Item Version Information File Size Width Height Model Name (reserved) Time Stamp (reserved) Size 9 18 13 14 18 12 70 Example JVC V1.
PAGE 10

Target position of 30 Intelligent tracking track_area 90,420-150,460 = Indicates position of Intelligent tracking target. The numbers are top left position and bottom right position. Item names and values, excluding the version information that does not include =, are stored in the following format. name space = space value (stuffed with 0x00) fixed length for each item Example: When width=640, the 13-byte area will be written as follows. w i d t h = 6 4 0 0x00 2.
PAGE 11

HTTP Response and MPEG-4 stream sent out by VN-V686 are as follows. HTTP Response VOP of MPEG-4 (No. 1) VOP of MPEG-4 (No. 2) ,,, When ptz_info=on is specified, boundary, pan/tilt/zoom information and MPEG-4 VOP will be sent out continuously after HTTP Response are as follows. HTTP Response boundary pan/tilt/zoom information MPEG-4 VOP (No. 1) boundary pan/tilt/zoom information MPEG-4 VOP (No.
PAGE 12

Details of MPEG-4 stream is explained later. 5) When the client wants to stop current MPEG-4 transmission, the client disconnects TCP80. VN-V686 does not accept further API via current TCP that is used for JPEG transmission. To change parameter, disconnect current TCP to stop the MPEG-4 transmission, connect new TCP, and send API with new parameter. 2.2. API Format Structure GET space API space HTTP/1.
PAGE 13

Server: JVC VN-V686 Network Camera x-vnv686_response: encode=mpeg4&framerate=30&framesize=vga&ptz_info=off 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. 2.4. Restrictions Access restriction VN-V686 has access restriction feature that enables to deny access from a specific IP address.
PAGE 14

VOL I-VOP P-VOP There are VOL, Userdata1, GOV and Userdata2 before each I-VOP.
PAGE 15

Response Example system.id=VN-V686U(192.168.0.2/24)&200 OK 4. Getting Alarm from VN-V686 4.1. Procedure 1) The client establishes a TCP connection to port number 32040. 2) When motion is detected from the video image of VN-V686, or when there are changes to the alarm input (make or break), VN-V686 will send out alarm information in the following format. The first 2 lines indicate the current alarm input status (make or break). The following 1 line indicates whether motion has been detected.
PAGE 16

GET Accept: Host: space API Characters space space Authorization: Basic space text/plain (or text/html) IP Address of VN-V686 space HTTP/1.1 0x0D 0x0A 0x0D 0x0A 0x0D 0x0A Encoded User Name and Password 0x0D 0x0A 0x0D 0x0A The following is an example of API for Getting subnet mask of VN-V686. Example GET /api/param?network.interface.subnetmask HTTP/1.1 Accept: text/plain Host: 192.168.0.
PAGE 17

Date: Fri, 13 MAY 2005 07:33:12 GMT Server: JVC VN-V686 API Server network.interface.subnetmask=255.0.0.0&200 OK 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. 6. API for Getting/Changing Parameters of VN-V686 This section provides description of APIs for getting/changing parameters of VN-V686. Make use of the API explained in this section in the way as mentioned in Section 5 . 6.1.
PAGE 18

An error code will be returned when setting is not properly performed. Example: ParamA.ParamB.ParamC&401 Unauthorized 6.2. Camera These APIs are related to camera settings. Same functions are shown on the Camera page of the WEB setting page and 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.
PAGE 19

To set as blank, specify as %00(0x25, 0x30, 0x30). To use space, specify as %20(0x25, 0x32, 0x30). If you want to set "Comment In JPEG" for example, specify as follows. /api/param?camera.id=Comment%20In%20JPEG The Camera ID is used as sender's display name of alarm mail. If you want to set sender's mail address, see "Setting Sender Mail Address for VN-V686". Example of setting Sender /api/param?camera.id=Camera01 Camera01 The change is saved by the API, camera.status=save.
PAGE 20

Example of setting a value /api/param?camera.image.pedestal=50 Example of 1 step change /api/param?camera.image.pedestal=+ Example of response camera.image.pedestal&202 Accepted(camera.status=save) Interpretation Change pedestal setting. Specify 0 to 100, "+" or "-". The value is mapped to 3 internal levels. It becomes brighter 1 step by specifying "+", darker 1 step by specifying "-". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
PAGE 21

Example of response camera.image.gamma.activelevel&202 Accepted(camera.status=save) Interpretation Change active gamma level setting. Specify from 0 to 100. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Thie setting is valid when gamma setting is "active". Allowed users admin, operator Getting Enhance Band from VN-V686 Format /api/param?camera.image.enhance.band Example of response camera.image.enhance.
PAGE 22

becomes sharper 1 step by specifying "+", softer 1 step by specifying "-". 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 Color Level from VN-V686 Format /api/param?camera.image.color Example of response camera.image.color=50&200 OK Interpretation Acquire color level value. Range of color level is between 0 to 100. The value is mapped to 11 internal levels.
PAGE 23

reboot. Allowed users admin, operator Getting Stabilizer Level from VN-V686 Format /api/param?camera.image.stabilizer.level Example of response camera.image.stabilizer.level=100&200 OK Interpretation Acquire stabilizer level. Value from 0 to 100 is returned. The level is 3 steps internally. Allowed users admin, operator, user Setting Stabilizer Level for VN-V686 Format /api/param?camera.image.stabilizer.level=data Example of setting /api/param?camera.image.stabilizer.
PAGE 24

Getting AGC from VN-V686 Format /api/param?camera.image.brightness Example of response camera.image.brightnesss=autoL&200 OK Interpretation Acquire AGC setting. "manual", "autoL", "autoM" or "autoH" is returned. Allowed users admin, operator, user Setting AGC for VN-V686 Format /api/param?camera.image.brightness=data Example /api/param?camera.image.brightness=auto Example of response camera.image.brightness&202 Accepted(camera.status=save) Interpretation Change AGC setting.
PAGE 25

"quality" is returned. In case of "motion", AGC is used before using sense up. In case of "quality", sense up is used before using AGC. Allowed users admin, operator, user Setting ALC priority for VN-V686 Format /api/param?camera.auto_exposure.priority=data Example /api/param?camera.auto_exposure.priority=quality Example of response camera.auto_exposure.priority&202 Accepted(camera.status=save) Interpretation Change ALC priority. ALC priority decides what is used first for auto exposure.
PAGE 26

Interpretation Acquire B&W mode. "color", "bw", "autoL", "autoM" or "autoH" is returned. Allowed users admin, operator, user Setting B&W Mode for VN-V686 Format /api/param?camera.image.true_daynight=data Example /api/param?camera.image.true_daynight=autoM Example of response camera.image.true_daynight&202 Accepted(camera.status=save) Interpretation Change B&W mode. Specify "color", "bw", "autoL", "autoM" or "autoH". IR filter is on when "color" is set. IR filter is off when "bw" is set.
PAGE 27

Allowed users admin, operator, user Setting Light for focus in B&W mode for VN-V686 Format /api/param?camera.image.true_daynight.light=data Example /api/param?camera.image.true_daynight.af=infrared Example of response camera.image.true_daynight.light&202 Accepted(camera.status=save) Interpretation Change light setting for focus in B&W mode. Specify "normal" or "infrared". When the setting is "infrared", focus at zooming works correctly with infrared light in B&W mode.
PAGE 28

Setting Iris for VN-V686 Format /api/param?camera.iris=data Example to set fixed value /api/param?camera.iris=50 Example to set auto /api/param?camera.iris=autoM Example to change from auto to maual /api/param?camera.iris=manual Example of response camera.iris&202 Accepted(camera(num).status=save or camera.motion.auto_pan.image=save) Interpretation Change iris setting. Specify 0 to 100 to set fixed value. 100 means full open. Specify "autoL", "autoM" or "autoH" to set auto.
PAGE 29

Interpretation Acquire white balance setting. "autoW", "autoN" or "manual" is returned. Allowed users admin, operator, user Setting White Balance for VN-V686 Format /api/param?camera.image.white_balance=data Example /api/param?camera.image.white_balance=autoW Example of response camera.image.white_balance&202 Accepted(camera.status=save or camera.motion.auto_pan.image=save) Interpretation Change white balance setting. Specify "autoW", "autoN", "manual" or "op_auto".
PAGE 30

Interpretation Acquire B-gain of white balance setting. s0 to s255 is returned. The s before number means "step". Allowed users admin, operator, user Setting B-Gain of White Balance for VN-V686 Format /api/param?camera.image.white_balance.b=data Example of response camera.image.white_balance.b&202 Accepted(camera.status=save) Interpretation Change B-gain white balance setting. Specify s0 to s255. The s before number means "step". The change is saved to preset position by the API, camera(num).status=save.
PAGE 31

Example of response camera.image.blc=off&200 OK Interpretation Acquire Back Light Compensation setting. "off", "a", "b", "c" or "d" is returned. Refer the instruction manual for detailed information of "a", "b", "c" and "d". Allowed users admin, operator, user Setting Back Light Compensation for VN-V686 Format /api/param?camera.image.blc=data Format of setting ON /api/param?camera.image.blc=a Example of response camera.image.blc&202 Accepted(camera.
PAGE 32

Example /api/param?encode(1).framesize=qvga Example of response encode(1).framesize&202 Accepted(encode(1).status=save) Interpretation Change JPEG frame size. Specify "vga" or "qvga". File size setting is changed automatically when frame size is changed. If frame size is changed from vga to qvga, file size is changed to third part of original size. If frame size is changed from qvga to vga, file size is changed to three times size.
PAGE 33

Example of response encode(1).quality&202 Accepted(encode(1).status=save) Interpretation Change the file size setting of JPEG. The unit of set values is in KB. VN-V686 will perform rate control with this file size as the target. When frame size is VGA, setting between the range of 10k to 100k is possible. When frame size is QVGA, setting between the range of 3k to 33k is possible. When VFS (VariableFileSize) is specified for rate control at the WEB setting page, 7 levels will be available for selection.
PAGE 34

Getting MPEG-4 bitrate Setting from VN-V686 Format /api/param?encode(2).bitrate Example of response encode(2).bitrate=8000000&200 OK Interpretation Acquire the bitrate setting of MPEG-4. If the response is 8000000 for example, the setting is 8Mbps. Allowed users admin, operator, user Setting MPEG-4 bitrate Setting for VN-V686 Format /api/param?encode(2).bitrate=Data Example /api/param?encode(2).bitrate=2000000 Example of response encode(2).bitrate&202 Accepted(encode(2).
PAGE 35

Interpretation Acquire frame rate of MPEG-4 encoding. Allowed users admin, operator, user Setting MPEG-4 Frame Rate Setting for VN-V686 Format /api/param?encode(2).framerate=data Example /api/param?encode(2).framerate=30 Example of response encode(2).framerate&202 Accepted(encode(2).status=save) Interpretation Change frame rate of MPEG-4. Specify 30, 25, 15, 10, 7.5, or 1. If vbr is set to MPEG-4 rate control, frame rate of MPEG-4 becomes 30fps.
PAGE 36

Setting MPEG-4 Priority Setting for VN-V686 Format /api/param?encode(2).priority=data Example /api/param?encode(2).priority=motion Example of response encode(2).priority&202 Accepted(encode(2).status=save) Interpretation Change priority of MPEG-4. Specify "motion" or "quality". To keep frame rate, select "motion". To keep image quality, select "quality". The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator 6.4.
PAGE 37

Allowed users admin, operator Getting Alarm Action from VN-V686 Format /api/param?application.event(Number).action Example When Getting action of alarm action No. 1 /api/param?application.event(1).action Example of Response application.event(1).action=mailto/somebody@somecompany.com/none/Message&200 OK Interpretation Acquire the alarm action of the specified alarm action number. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6.
PAGE 38

application.event(1).action=udpto/10.0.0.100/20000/Message&200 OK When alarm output is specified, pinout, distinction between make/break (m1 or b1) and output time (millisecond) will be returned. Segments are indicated by /. Example of Response application.event(1).action=pinout/m1/1500&200 OK When preset position is specified, position number will be returned. Example of Response when position number is 2 application.event(1).action=camera.position(2).
PAGE 39

Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify object01. If none is specified instead of object01, JPEG is not attached to the mail. Number of the character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
PAGE 40

Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is specified. Segments are indicated by /. The time is 0 or from 100 to 5000. When the time is 0, alarm output does not come back to previous state. Setting Example /api/param?application.event(1).action=pinout/m1/1500 Specify preset position number when preset position is specified. Setting Example /api/param?application.event(1).action=camera.position(2).
PAGE 41

Example of Response application.event(1).filter(sunday).status&202 Accepted(application.event(1).status=restart) Interpretation Set 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.
PAGE 42

time can be from 000001 to 240000. Start time must be earlier than end time. The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart. Allowed users admin, operator Getting Alarm Filter Type from VN-V686 Format /api/param?application.event(Number).filter(WeekOfDay).type Example When Getting Type of Sunday filter of Alarm No. 1 /api/param?application.event(1).filter(sunday).type Example of Response application.event(1).filter(sunday).
PAGE 43

Example When Getting Trigger of Alarm No. 1 /api/param?application.event(1).trigger Example of Response application.event(1).trigger=m1&200 OK Interpretation Acquire 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. Note that alarm numbers are different from the alarm input pin numbers.
PAGE 44

specify m1 in the case of Make for alarm input 1. specify b1 in the case of Break for alarm input 1. specify m2 in the case of Make for alarm input 2. specify b2 in the case of Break for alarm input 2. specify v1 for motion detection of video. specify ncbws for IR Filter OFF. specify ncbwe for IR Filter ON. specify efans for fan stop. specify camera.position(num).status for preset position. "num" is from 0 to 99. Setting Example /api/param?application.event(1).
PAGE 45

Interpretation Change the address setting of the SMTP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the SMTP server is not set. It is also possible to leave the setting field blank as follows. /api/param?application.smtp.host=%00 Allowed users admin, operator Getting SMTP Server Port Number Setting from VN-V686 Format /api/param?application.smtp.port Example of Response application.smtp.
PAGE 46

Allowed users admin, operator Getting "POP before SMTP" Setting from VN-V686 Format /api/param?application.smtp.type Example of Response application.smtp.type=pbs&200 OK Interpretation Acquire the "POP before SMTP" setting. "simple" is returned when this is set to off. "pbs" is returned when this is set to on. Allowed users admin, operator, user Setting "POP before SMTP" for VN-V686 Format /api/param?application.smtp.type=data Example /api/param?application.smtp.type=pbs Example of Response application.
PAGE 47

Interpretation Acquire the port number setting of the POP server. Allowed users admin, operator, user Setting POP Server Port Number for VN-V686 Format /api/param?application.pop.port=data Example /api/param?application.pop.port=110 Example of Response application.pop.port&200 OK Interpretation Change the port number setting of the POP server. Allowed users admin, operator Getting POP Server User Name Setting from VN-V686 Format /api/param?application.pop.user Example of Response application.pop.
PAGE 48

Setting POP Server Password for VN-V686 Format /api/param?application.pop.password=data Example /api/param?application.pop.password=someword Example of Response application.pop.password&200 OK Interpretation Change the password setting of the POP server. The maximum password size is 32 bytes. Set as follows when this is to be left blank. /api/param?application.pop.password=%00 Allowed users admin, operator (Note: There is no API for reading passwords.
PAGE 49

Interpretation Change the FTP server directory setting used for FTP transmission. It is possible to set FTP transmission to a directory under the FTP server home directory by specifying that directory name. Use %2F to segment the directory. ("2F" is ASCII code of "/".) The maximum directory name size is 63 bytes. Example /api/param?application.ftp.path=subdir1%2Fsubdir2 By leaving the setting blank as follows, FTP transmission will be set to the FTP server home directory. /api/param?application.ftp.
PAGE 50

Example of Response application.ftp.naming=default&200 OK Interpretation Acquire file naming of periodic FTP. "default", "type1" or "type2" is returned. When default is set, the file name is as YYYYMMDDHHMMSS-NNN-2.jpg. Example 20060207201315-001-2.jpg When type1 is set, the file name is as ***YYYMMDDHHMMSSNNN.jpg. "***" can be gotten by another API, /api/param?application.ftp.naming_option. File Name Example Camera_20060207201315001.jpg When type2 is set, the file name is as ***.jpg.
PAGE 51

File Name Example Camera.jpg Allowed users admin, operator Setting User Define Name of File Naming for VN-V686 Format /api/param?application.ftp.naming_option=data Example of Response application.ftp.naming_option&200 OK Interpretation Change 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 "***" can be set by this API. File Name Example Camera_20060207201315001.
PAGE 52

For Post Duration /api/param?application.object.postrec&200 OK Interpretation Change parameters for PrePost + ftp. These parameters are used when recftp is set as an alarm action. Specify 30, 15, 10, 7.5, 6, 5, 3, 2, or 1 for frame rate. Maximum Pre/Post duration is 60 seconds. Setting zero to Pre and Post duration is invalid. Allowed users admin, operator Getting Alarm Output Time Setting from VN-V686 Format /api/param?peripheral.output_pin.pin(Number).duration Example /api/param?peripheral.output_pin.
PAGE 53

Allowed users admin, operator 6.6. PTZ The APIs below are related to pan/tilt/zoom control. These are equivalent to the features on the PTZ page of the WEB setting page and PTZ Controller of built-in viewer. Refer to the instruction manual for details on the PTZ page and PTZ Controller. (1) Settings for PTZ Control Getting Auto Return Mode from VN-V686 Format /api/param?camera.motion.auto_return.mode Example of response camera.motion.auto_return.mode=home&200 OK Interpretation Acquire Auto Return mode.
PAGE 54

Accepted(camera.status=save) Interpretation Change timeout of Auto Return in seconds. Specify 60, 120, 180, 300, 600, 1200, 1800 or 3600. 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 Auto Return Status from VN-V686 Format /api/param?camera.motion.auto_return.status Example of response camera.motion.auto_return.status=on&200 OK Interpretation Acquire status of Auto Return.
PAGE 55

Allowed users admin, operator Specify target for Intelligent Tracking for VN-V686 Format /api/param?camera.motion.auto_tracking(2).target=sx-sy /api/param?camera.motion.auto_tracking(2).target=sx-sy-R-G-B Example to specify position (10, 20) /api/param?camera.motion.auto_tracking(2).target=s10-s20 Example to specify position (10, 20) and color (255, 0, 0) /api/param?camera.motion.auto_tracking(2).target=s10-s20-255-0-0 Example of Response camera.motion.auto_tracking(2).
PAGE 56

/api/param?camera.motion.auto_tracking(2).restarttime Example of response camera.motion.auto_tracking(1).restarttime=10&200 OK Interpretation Acquire restart time of Auto Tracking or Intelligent tracking in seconds. In case of Auto tracking, if there is no motion, the camera goes to home position after the restart time, and restarts Auto Tracking. In case of Intelligent tracking, if the camera loses the target, the camera goes to home position after the restart time, and restarts Intelligent Tracking.
PAGE 57

Getting Tracking Zoom setting of Intelligent Tracking from VN-V686 Format /api/param?camera.motion.auto_tracking(2).zoom Example of response camera.motion.auto_tracking(2).zoom=on&200 OK Interpretation Acquire tracking zoom setting of Intelligent Tracking. When it is on, Intelligent tracking changes zoom position automatically. When it is off, Intelligent tracking keeps current zoom position.
PAGE 58

Interpretation Acquire maximum zoom of Intelligent Tracking. Zoom limit can not be bigger than maximum zoom. Value from 1.00 to 21.37 is returned. Allowed users admin, operator, user Setting Maximum Zoom of Intelligent Tracking for VN-V686 Format /api/param?camera.motion.auto_tracking(2).max_zoom=data Example of Response camera.motion.auto_tracking(2).max_zoom&202 Accepted(camera.status=save) Interpretation Change maximum zoom of Intelligent Tracking. Zoom limit can not be bigger than maximum zoom.
PAGE 59

current resolution is QVGA. Allowed users admin, operator, user Setting Dead Zone of Intelligent Tracking for VN-V686 Format /api/param?camera.motion.auto_tracking(2).dead_zone=data Example of Response camera.motion.auto_tracking(2).dead_zone&202 Accepted(camera.status=save) Interpretation Change dead zone of Intelligent Tracking. Motion smaller than dead zone is ignored by Intelligent tracking. Horizontal value is from 0 to 320, and vertical value is from 0 to 240.
PAGE 60

Accepted(camera.status=save) Interpretation Change On/Off of Pan Limit. Specify "on" or "off". 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 Left Side of Pan Limit from VN-V686 Format /api/param?camera.motion.pan.limit.left Example of response camera.motion.pan.limit.left=90.00&200 OK Interpretation Acquire left side of Pan Limit in degrees.
PAGE 61

Getting Tilt Limit from VN-V686 Format /api/param?camera.motion.tilt.limit.upper Example of response camera.motion.tilt.limit.upper=5&200 OK Interpretation Acquire Tilt Limit in degrees. Allowed users admin, operator, user Setting Tilt Limit for VN-V686 Format /api/param?camera.motion.tilt.limit.upper=data Example to set horizontal /api/param?camera.motion.tilt.limit.upper=5 Example of Response camera.motion.tilt.limit.upper&202 Accepted(camera.status=save) Interpretation Set Tilt Limit.
PAGE 62

off : Auto Flip function does not activate. full_digital : This is Digital Flip on Web page. The top/bottom and left/right of the image flips when the object has passed the bottom of the camera, at the position of 135 degrees. half : Thi is Mode1 on Web page. When the camera faces bottom, it rotates 180 degrees horizontally and stops. In this case, the operating direction of the camera is the same as that of the Pan/Tilt lever. full : This is Mode2 on Web page.
PAGE 63

Moving to Specified Pan Position for VN-V686 Format /api/param?camera.motion.pan=data Example to move to absolute 90 degrees Example to move to relative 45 degrees /api/param?camera.motion.pan=90.00 /api/param?camera.motion.pan=+45.00 Example of Response camera.motion.pan&200 OK Interpretation Move to specified pan position. To move to absolute position, specify from 0.00 to 359.99. Allowed users admin, operator Pan Operation for VN-V686 Format /api/param?camera.motion.pan.
PAGE 64

Format /api/param?camera.motion.variable_pantiltspeed.status Example of Response camera.motion.variable_pantiltspeed.status=on&200 OK Interpretation Acquire current setting of variable pan/tilt speed. "on" or "off" is returned. Allowed users admin, operator, user Setting Status of Variable Pan/Tilt Speed for VN-V686 Format /api/param?camera.motion.variable_pantiltspeed.status=data Example to set on /api/param?camera.motion.variable_pantiltspeed.status=on Example of Response camera.motion.
PAGE 65

Setting Direction of Tilt Operation for VN-V686 Format /api/param?camera.motion.tilt.mode=data Example to set to up /api/param?camera.motion.tilt.mode=up Example of Response camera.motion.tilt.mode&200 OK Interpretation Set direction of tilt operation. Specify up or down. Allowed users admin, operator Setting Speed of Tilt Operation for VN-V686 Format /api/param?camera.motion.tilt.speed=data Example to set maximum speed /api/param?camera.motion.tilt.speed=100 Example of Response camera.motion.tilt.
PAGE 66

means Wide edge and 99.99 means Tele edge. Allowed users admin, operator Zoom Operation for VN-V686 Format /api/param?camera.motion.zoom.status=data Example to start zoom /api/param?camera.motion.zoom.status=start Example of Response camera.motion.zoom.status&200 OK Interpretation Start or stop zoom operation. Specify start or stop. Allowed users admin, operator Setting Direction of Zoom Operation for VN-V686 Format /api/param?camera.motion.zoom.mode=data Example to set to Tele /api/param?camera.
PAGE 67

zoom is Tele edge, focus can be from 0.00 to about 78. When focus is set to auto, easy_auto is returned. Allowed users admin, operator, user Moving to Specified Focus Position for VN-V686 Format /api/param?camera.focus=data Example to move to absolute 50.00 /api/param?camera.focus=50.00 Example to move to relative 5 Near /api/param?camera.focus=+5.00 Example to move to relative 5 Far Example to set to auto /api/param?camera.focus=-5.00 /api/param?camera.
PAGE 68

Interpretation Set speed of focus operation. Specify 0 to 100. The speed is 4 steps internally. Allowed users admin, operator (3) Preset Position Getting Current Preset Position from VN-V686 Format /api/param?camera.status Example of response camera.status=3&200 OK Interpretation Acquire current preset position after moving to preset position. "none" is returned after moved from preset position.
PAGE 69

Moving to Preset Position for VN-V686 Format /api/param?camera.position(number).status=goto Example of Response camera.position(3).status&200 OK Interpretation Move to specified preset position. Specify from 0 to 99 as position number. Allowed users admin, operator Getting Title of Preset Position from VN-V686 Format /api/param?camera.position(number).comment Example of response camera.position(3).comment=entrance&200 OK Interpretation Acquire title of specified preset position.
PAGE 70

Example of Response camera.motion.auto_pan.status&200 OK Interpretation Start/stop auto pan. Specify start, stop, goto_start or goto_end. Allowed users admin, operator Getting Direction of Auto Pan from VN-V686 Format /api/param?camera.motion.auto_pan.mode Example of response camera.motion.auto_pan.mode=left&200 OK Interpretation Acquire direction of auto pan. "left", "right" or "return" is returned. Allowed users admin, operator, user Setting Direction of Auto Pan for VN-V686 Format /api/param?camera.
PAGE 71

Interpretation Set current position as start position of auto pan. Pan/tilt/zoom/focus positions are saved. Caution: Though Moving to tilt position over 90 degrees is possible when auto flip mode is digital flip, select tilt position under 90 degrees as start position of auto pan. Allowed users admin, operator Setting Current Position as End Position of Auto Pan for VN-V686 Format /api/param?camera.motion.auto_pan.end_point=present Example of Response camera.motion.auto_pan.
PAGE 72

seconds, and limited number of commands can be recorded. When the duration or command number is over, error response is returned to pan/tilt/zoom/focus command as below. 206 Partial Content, auto_trace(timeout) 206 Partial Content, auto_trace(memoryfull) If stop is specified after those limitations, "206 Partial Content" is returned. After the stop commad, normal response is returned to pan/tilt/zoom/focus command.
PAGE 73

Allowed users admin, operator, user Getting Preset Postion Number of Auto Patrol from VN-V686 Format /api/param?camera.motion.auto_patrol(number1).position(number2) Example to get preset position number of patrol nuber 3 in mode 1 /api/param?camera.motion.auto_patrol(0).position(3) Example of response camera.motion.auto_patrol(0).position(3)=5&200 OK Interpretation Acquire preset position number of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2.
PAGE 74

is saved by the API, camera.motion.auto_patrol.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Saving Preset Position Number/Duarion of Auto Patrol for VN-V686 Format /api/param?camera.motion.auto_patrol(number).status=save Example of Response camera.motion.auto_patrol(0).status&202 Accepted(camera.motion.auto_patrol.status=save) Interpretation Save preset position number and duration of specified mode of auto patrol.
PAGE 75

number. Allowed users admin, operator, user Setting Status of a Privacy Masking Area for VN-V686 Format /api/param?camera.private_mask.area(number).status=data Example of Response camera.private_mask.area(number).status&202 Accepted(camera.status=save) Interpretation Change each status of privacy masking area. Specify from 0 to 7 as area number. Specify "on" or "off". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
PAGE 76

"clear" or "exit". When editing is started, zoom is changed to Wide edge, and pan/tilt positions are restored if the privacy masking area has settings. Pan/tilt position of the privacy masking area can be changed by pan/tilt APIs. Allowed users admin, operator Setting Width of Privacy Masking Area for VN-V686 Format /api/param?camera.private_mask.width=data Example to expand the width 1 step /api/param?camera.private_mask.width=+ Example of Response camera.private_mask.
PAGE 77

Caution: Motion detect does not work during auto tracking. Allowed users admin, operator Getting Motion Detect Sensitivity from VN-V686 Format /api/param?camera.detection.level Example of response camera.detection.level=20&200 OK Interpretation Acquire the motion detect sensitivity. A value between 0 to 100 will be returned. The larger the value, the higher will be the sensitivity. Allowed users admin, operator, user Setting Motion Detect Sensitivity for VN-V686 Format /api/param?camera.detection.
PAGE 78

Example /api/param?camera.detection.area=000102030405060708090001 Example of response camera.detection.area&202 Accepted(camera.status=save) Interpretation Change the motion detect mask. Specify using a 24 ASCII character string. Refer to the item on "Getting Motion Detect Mask from VN-V686" on the interpretation of this character string. To mask all blocks, specify all zeros in the ASCII character string. The change is saved by the API, camera.status=save.
PAGE 79

Getting IP Address from VN-V686 Format /api/param?network.interface.ip Example of Response network.interface.ip=192.168.0.2&200 OK Interpretation Acquire the current IP address. Allowed users admin, operator, user Setting IP Address for VN-V686 Format /api/param?network.interface.ip=data Example /api/param?network.interface.ip=192.168.0.2 Example of Response network.interface.ip&202 Accepted(network.interface.status=restart) Interpretation Change the IP address. To validate the change, use "network.
PAGE 80

Interpretation Acquire the current default gateway. Allowed users admin, operator, user Setting Default Gateway for VN-V686 Format /api/param?network.gateway=data Example /api/param?network.gateway=192.168.0.254 Example of Response network.gateway&200 OK Interpretation Change the default gateway. To set static default gateway, disable DHCP. Default gateway can not be changed when DHCP is enabled. Specify IP address in same segment with VN-V686's IP address. Specify 0.0.0.
PAGE 81

Example /api/param?network.dns.status=on Example of Response network.dns.status&200 OK Interpretation Change status of DNS server setting, or validate changes to DNS server settings. Specify "on", "off" or "restart". Changes of DNS server settings become valid by "restart". Allowed users admin, operator Getting DNS Server IP Address from VN-V686 Format /api/param?network.dns.ip Example of Response network.dns.ip=10.0.0.150&200 OK Interpretation Acquire IP address of DNS server.
PAGE 82

Allowed users admin, operator, user Setting TOS Value of JPEG for VN-V686 Format /api/param?network.interface.dscp.video.jpeg=data Example /api/param?network.interface.dscp.video.jpeg=56 Example of Response network.interface.dscp.video.jpeg&202 Accepted(network.interface.status=restart) Interpretation Change TOS that includes DHCP field for JPEG. The range of set value is between 0 to 255 though MSB 6 bits in the value is valid. To validate the change, use "network.interface.status=restart" API.
PAGE 83

Example /api/param?network.interface.ttl.unicast=56 Example of Response network.interface.ttl.unicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of unicast. The range of set value is between 1 to 255. To validate the change, use "network.interface.status=restart" API. Allowed user admin Getting Multicast TTL Value from VN-V686 Format /api/param?network.interface.ttl.multicast Example of Response network.interface.ttl.multicast=16&200 OK Interpretation Acquire TTL of multicast.
PAGE 84

Allowed user admin Getting Network Negotiation Setting from VN-V686 Format /api/param?network.interface.negotiation Example of Response network.interface.negotiation=auto&200 OK Interpretation Acquire the network Negotiation setting. Either auto, 100full, 100half, 10full or 10half will be returned. Allowed users admin, operator, user Setting Network Negotiation for VN-V686 Format /api/param?network.interface.negotiation=data Example /api/param?network.interface.
PAGE 85

Allowed users admin, operator 6.13. Multicast Streaming The APIs below are related to manual streaming. These are equivalent to the features on the Streaming page of the WEB setting page. Refer to the instruction manual for details on the Streaming page. Getting Status of JPEG Multicast Streaming from VN-V686 Format /api/param?network.destination(1).status Example of Response network.destination(1).status=off&200 OK Interpretation Acquire status of JPEG multicast streaming.
PAGE 86

"network.destination(1).host=start" API. Allowed user admin Getting JPEG Multicast Port Number from VN-V686 Format /api/param?network.destination(1).port Example of Response network.destination(1).port=49152&200 OK Interpretation Acquire JPEG multicast port number. Allowed users admin, operator Setting JPEG Multicast Port Number for VN-V686 Format /api/param?network.destination(1).port=data Example /api/param?network.destination(1).port=49152 Example of Response network.destination(1).
PAGE 87

Format /api/param?network.destination(2).status Example of Response network.destination(2).status=off&200 OK Interpretation Acquire status of MPEG-4 multicast streaming. Either on or off will be returned. Allowed users admin, operator Setting Status of MPEG-4 Multicast Streaming, or Save Changes for VNV686 Format /api/param?network.destination(2).status=data Example /api/param?network.destination(2).status=start Example of Response network.destination(2).
PAGE 88

Allowed users admin, operator Setting MPEG-4 Multicast Port Number for VN-V686 Format /api/param?network.destination(1).port=data Example /api/param?network.destination(1).port=59152 Example of Response network.destination(1).port&202 Accepted(network.destination(1).host=save) Interpretation Change MPEG-4 multicast port number. Specify from 2 to 65534. To validate the change, use "network.destination(2).host=save" API. After the save, start streaming by "network.destination(2).host=start" API.
PAGE 89

Interpretation Acquire the IP address setting of the restricted client. Setting is possible up to 10 items. Specify a value between 1 to 10 for the number. The following will be returned if subnet mask was specified. Example of Response 2 network.access_control(stream_out).host(1)=10.0.0.0/24&200 OK The above example indicates that the range is between 10.0.0.0 to 10.0.0.255. There are also cases when FQDN instead of IP address is set. Example of Response 3 network.access_control(stream_out).
PAGE 90

Example /api/param?network.ntp.status=on Example of Response network.ntp.status&200 OK Interpretation Change the on/off status of SNTP client, or validate changes to settings. Specify "on", "off" or "restart". as on or off. IP address of NTP server and access interval are validated by "restart". Allowed users admin, operator Getting NTP Server Address from VN-V686 Format /api/param?network.ntp.host Example of Response network.ntp.host=10.0.0.100&200 OK Interpretation Acquire IP address of NTP server.
PAGE 91

Getting Access Interval Unit of NTP from VN-V686 Format /api/param?network.ntp.unit Example of Response network.ntp.unit=hour&200 OK Interpretation Acquire the unit of interval for accessing the NTP server. "min", "hour" or "day" is returned. Allowed users admin, operator, user Setting Access Interval Unit of SNTP for VN-V686 Format /api/param?network.ntp.unit=data Example /api/param?network.ntp.unit=day Example of Response network.ntp.unit&202 Accepted(network.ntp.
PAGE 92

Timezone Character String GMT-12 GMT-11 GMT-10 Hawaii GMT-9:30 GMT-9 Alaska GMT-8 Pacific GMT-7 Arizona Mountain GMT-6 Central GMT-5 East-Indiana Eastern GMT-4 Atlantic GMT-3:30 GMT-3 GMT-2 GMT-1 UTC London GMT+1 Berlin Rome Madrid Paris CET GMT+2 EET GMT+3 GMT+3:30 GMT+4 GMT+4:30 GMT+5 GMT+5:30 India GMT+5:45 GMT+6 GMT+6:30 GMT+7 GMT+8 Description Timezone that is 12 hours earlier than the Greenwich Mean Time. Timezone that is 11 hours earlier than the Greenwich Mean Time.
PAGE 93

GMT+8:45 GMT+9 GMT+9:30 Japan GMT+10 GMT+10:30 GMT+11 GMT+11:30 GMT+12 GMT+12:45 Timezone that is 8 hours and 45 minutes later than the Greenwich Mean Time. Timezone that is 9 hours later than the Greenwich Mean Time. Timezone that is 9 hours and 30 minutes later than the Greenwich Mean Time. Same timezone as GMT+9. Timezone that is 10 hours later than the Greenwich Mean Time. Timezone that is 10 hours and 30 minutes later than the Greenwich Mean Time.
PAGE 94

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 Interpretation Restore all VN-V686 settings to factory defaults. Upon doing so, all transmission services that are in progress will be terminated. Initializing takes a few minutes.
PAGE 95

Allowed users admin, operator, user Setting Time of Auto Cleaning for VN-V686 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" API. Allowed user admin 6.18. Getting Status The APIs below are related to status acquisition.
PAGE 96

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-V686. 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.
PAGE 97

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.
PAGE 98

returned. Allowed users admin, operator, user Getting Mode of FTP Server from VN-V686 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. Also called PORT mode. TCP connection for data is established from 20 port of FTP server to 10020 port of VN-V686.
PAGE 99

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-V686 VN-V686 uses the following protocols and port numbers.
PAGE 100

- TimeFormat Set from 0 to 6 to select time format 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 - DispMotion Set 1 to display motion detect (MPEG-4 viewer does not have this property.) - FolderName Folder name to save JPEG. The folder is created under MyDocuments. (MPEG-4 viewer does not have this property.
PAGE 101

(2) Getting Multicast Execute Play method after setting properties below.