-
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. 2007.12.11.
-
Updates Version Date 1.00Beta 2007/12/11 Updates Beta release.
-
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.
-
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.
-
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&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.
-
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. Range of X-Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185 degrees. 500 and 18500 mean horizontal.
-
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&ptz_info=off HTTP/1.1 Host: 192.168.0.2 Parameter value is indicated using =. Do not insert space before and after =. Example framerate=1 Parameter Description encode For specifying compression format.
-
x-vnv686_response: encode=jpeg&framerate=30&framesize=vga&ptz_info=off 1.4. Restrictions Access restriction VN-V686 has access restriction feature that enables to deny access from a specific IP address. If JPEG is requested from the IP address of access restriction, VN-V686 disconnects the TCP connection after API is sent. Restriction by maximum bitrate of VN-V686 The maximum bitrate of VN-V686 is about 20 Mbps.
-
(reserved) 2007101413050912 3UTC alarm = 00000000 camera = input01 motion = 1 md = 1 Camera ID Motion Detect Setting Motion Detect Result 13 50 11 7 Pan position 13 pan = 123.45 Tilt position 14 Tilt = 123.45 Zoom position 13 zoom = 12.34 Preset Posision Number Stabilizer status 15 position = 99 15 stabilizer = 0 Fan status 8 fan = 0 up of the year/month/day, hour/minute/second, millisecond and timezone code. (reserved) Stores camera information set at VN-V686.
-
Note denotes the line feed code (0x0D, 0x0A). 3) VN-V686 returns HTTP response. Example HTTP/1.1 200 OK Connection: close Content-Type: video/mp4v-es Date: Tue, 02 Oct 2007 07:33:12 GMT Server: JVC VN-V686 Network Camera x-vnv686_response: encode=mpeg4&framerate=15&framesize=vga&ptz_info=off 4) VN-V686 sends out MPEG-4 data after returning HTTP response. HTTP Response and MPEG-4 stream sent out by VN-V686 are as follows. HTTP Response VOP of MPEG-4 (No.
-
Example of Booundary and pan/tilt/zoom information: --foo Content-Type: image/jpeg Content-Length: 5914 X-Puls-Pan: 0 X-Puls-Tilt: 0 X-Posi-Zoom: 0 Range of X-Puls-Pan is from 0 to 35999. Range of X-Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185 degrees. 500 and 18500 mean horizontal. Range of X-Posi-Zoom is from 0 to 9999. Details of MPEG-4 stream is explained later.
-
encode For specifying compression format. For example, specify as encode=mpeg4 to get MPEG-4. ptz_info To add pan/tilt/zoom information before MPEG-4 VOP data. Specify on or off. Even if ptz_info=off, pan/tilt/zoom information is stored in JPEG comment segemnt. 2.3. Response When API is successfully received VN-V686 will return 200 OK. The x-vnv686_response line indicates actual parameter. Example HTTP/1.
-
P-VOP: Inter frame compressed data with previous frame Ratio of I-VOP and P-VOP depends on I-Frame interval setting. Encode page of Web has the setting. First VOP can be I-VOP or P-VOP. If client want to decode from I-VOP, please skip P-VOP and wait first I-VOP. Example of MPEG-4 stream HTTP Response P-VOP P-VOP P-VOP VOL I-VOP P-VOP There are VOL, Userdata1, GOV and Userdata2 before each I-VOP.
-
3. API to Search VN-V686 VN-V686 in LAN can be searched by broadcast packet that includes this API. Search VN-V686 in LAN Protocol Send udp packet with following text in UDP payload to destination port number 80. Source port number can be any value. system.id Response VN-V686 that received this packet sends udp packet to the source port number of the search packet. UDP payload of response packet has model name, IP address, and subnet mask. VN-V686 waits 0-0.
-
5. Using API that Requires Basic Authentication Basic authentication is required for APIs which are explained in Section 6. This section provides general explanation of those APIs. 5.1. Procedure 1) The client establishes a TCP connection to port number 80. 2) The client sends API. API has following structure. GET Accept: Host: space space space Authorization: Basic API Characters space text/plain (or text/html) IP Address of VN-V686 space HTTP/1.
-
3) VN-V686 returns a response to the client. In the following example, current subnet mask is 255.0.0.0. In addition, 255.0.0.0 is followed by & and 200 OK, indicating that getting parameter is successful. Example HTTP/1.1 200 OK Connection: close Content-Length: 80 Content-type: text/plain 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.
-
(2) Setting parameter ● Specify API in GET line according to the format below when setting a parameter for VN-V686. /api/param?ParamA.ParamB.ParamC=Data Parameter values are indicated using =. Do not insert space before and after =. The upper limit of this character string is 1024 bytes. ● Response will be in the following format. ParamA.ParamB.ParamC&200 OK An error code will be returned when setting is not properly performed. Example: ParamA.ParamB.ParamC&401 Unauthorized 6.2.
-
Sender Camera01 Allowed users admin, operator, user Setting Camera ID in JPEG from VN-V686 Format /api/param?camera.id=data Example /api/param?camera.id=Camera01 Example when setting as blank /api/param?camera.id=%00 Example of response camera.id&202 Accepted(camera.status=save) Interpretation Change the camera ID stored in comment segment of JPEG. Maximum size is 40 bytes. To set as blank, specify as %00(0x25, 0x30, 0x30). To use space, specify as %20(0x25, 0x32, 0x30).
-
Getting Black level from VN-V686 Format /api/param?camera.image.pedestal Example of response camera.image.pedestal=50&200 OK Interpretation Acquire black level setting. Range of pedestal is between 0 to 100, and it is mapped to 3 internal levels. The larger the value, the brighter will be the black. Allowed users admin, operator, user Setting Black level for VN-V686 Format /api/param?camera.image.pedestal=data Example of setting a value /api/param?camera.image.
-
Getting Active Gamma Level from VN-V686 Format /api/param?camera.image.gamma.activelevel Example of response camera.image.gamma.activelevel=0&200 OK Interpretation Acquire active gamma level setting. Value of active gamma level is from 0 to 100, and 11 steps internally. Thie setting is valid when gamma setting is "active". Allowed users admin, operator, user Setting Active Gamma Level for VN-V686 Format /api/param?camera.image.gamma.activelevel=data Example of response camera.image.gamma.
-
levels. The larger the value, the sharper will be the image. Allowed users admin, operator, user Setting Enhance for VN-V686 Format /api/param?camera.image.enhance=data Example of setting a value /api/param?camera.image.enhance=50 Example of 1 step change /api/param?camera.image.enhance=+ Example of response camera.image.enhance&202 Accepted(camera.status=save) Interpretation Change enhance setting. Specify 0 to 100, "+" or "-". The value is mapped to 11 internal levels.
-
Allowed users admin, operator, user Setting Stabilizer for VN-V686 Format /api/param?camera.image.stabilizer=data Example of setting /api/param?camera.image.stabilizer=on Example of response camera.image.stabilizer&202 Accepted(camera.status=save) Interpretation Change stabilizer setting. Specify "on" or "off". When stabilizer is on, image is zoomed (x 1.3) by EZoom. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
-
Setting DNR for VN-V686 Format /api/param?camera.image.dnr=data Example of setting /api/param?camera.image.dnr=on Example of response camera.image.dnr&202 Accepted(camera.status=save) Interpretation Change DNR setting. Specify "on" or "off". DNR improves noise in dark image. DNR is valid when AGC is autoM or autoH. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
-
disabled. It becomes bigger 1 step by specifying "+", smaller 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. Sense up works when shutter speed is 1/60 or 1/100. Allowed users admin, operator Getting ALC priority from VN-V686 Format /api/param?camera.auto_exposure.priority Example of response camera.auto_exposure.priority=motion&200 OK Interpretation Acquire ALC priority.
-
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. If the change is not saved, the setting is restored by reboot. To set from 250 to 10000, sense up setting must be 0. Allowed users admin, operator Getting B&W Mode from VN-V686 Format /api/param?camera.image.
-
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. Allowed users admin, operator Getting Light setting for focus in B&W mode from VN-V686 Format /api/param?camera.image.true_daynight.light Example of response camera.image.true_daynight.light=normal&200 OK Interpretation Acquire light setting for focus in B&W mode. "normal" or "infrared" is returned.
-
camera.motion.auto_pan.image=save. Getting Iris from VN-V686 Format /api/param?camera.iris Example of response camera.iris=autoM&200 OK Interpretation Acquire iris setting. When iris is manual, value from 0 to 100 is returned. When iris is auto,"autoL", "autoM" or "autoH" is returned. 100 means full open. Allowed users admin, operator, user 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.
-
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. When White Balance setting is changed by API, the change is temporal. To save current White Balance setting for preset position, use camera(num).status=save. To save current White Balance setting for Auto Pan and Auto Trace, use camera.
-
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. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting B-Gain of White Balance from VN-V686 Format /api/param?camera.image.white_balance.b Example of response camera.
-
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.status=save) Interpretation Change Back Light Compensation setting. Specify "off", "a", "b", "c" or "d". Refer the instruction manual for detailed information of "a", "b", "c" and "d". 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.
-
not same, compression on QVGA can have privacy masking. The change is saved by the API, encode(1).status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting JPEG Rate Control Setting from VN-V686 Format /api/param?encode(1).cbr_mode Example of response encode(1).cbr_mode=afs&200 OK Interpretation Acquire the rate control setting of JPEG. Quantization table is fixed in the case of vfs (VariableFileSize).
-
selection. Each of these choices corresponds to the file sizes as follows. Level File Size Setting for VGA File Size Setting for QVGA 1 2 3 4 80k 60k 40k 30k 27k 20k 13k 10k 5 25k 8k 6 7 20k 15k 7k 5k When rate control is set to vfs and a file size that is not stated above is specified, the closest choice will be displayed on the WEB setting page. The change is saved by the API, encode(1).status=save. If the change is not saved, the setting is restored by reboot.
-
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).status=save) Interpretation Change the bitrate setting of MPEG-4. Specify from 64000 to 8000000. The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
-
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. If I-Frame interval is not 30, 60, 120, 150, 180, 210 or 240, real frame rate becomes larger than the setting. Refer I-Frame interval API for details. The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
-
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. Alarm Setting The APIs below are related to alarm setting. These are equivalent to the features on the Alarm page of the WEB setting page. Refer to the instruction manual for details on the Alarm page. Getting On/Off of Alarm Action from VN-V686 Format /api/param?application.event(Number).status Example When Getting the on/off status of alarm action No.
-
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. Note that alarm numbers are different from the alarm input pin numbers. A separate API (/api/param?application.event(Number).status) is used to acquire the on/off status of the alarm action.
-
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).status/goto&200 OK When B&W mode is specified, true_daynight/bw, true_daynight/color, true_daynight/autoH, true_daynight/autoM or true_daynight/autoL will be returned. Example of Response when B&W mode is bw application.event(1).action=camera.image.true_daynight/bw&200 OK Alarm action of event number 6 is periodic FTP.
-
For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available. Setting Example /api/param?application.event(1).action=mailto/somebody@somecompany.com/object0 1/Alarm%20ON The character string "Alarm from VN-V686" will be stored in the title field of the mail. Specify recftp, FTP number and the object for PrePostRecording+FTP.
-
Specify preset position number when preset position is specified. Setting Example /api/param?application.event(1).action=camera.position(2).status/goto Specify true_daynight/bw, true_daynight/color, true_daynight/autoH, true_daynight/autoM or true_daynight/autoL when B&W mode is specified. Setting Example /api/param?application.event(1).action=camera.image.true_daynight/bw Alarm action of event number 6 is periodic FTP. Event 1 to 5 can not be set to periodic FTP.
-
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Specify on to enable the filter, off to disable the filter. The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart. Allowed users admin, operator Getting Alarm Filter Time from VN-V686 Format /api/param?application.event(Number).filter(WeekOfDay).time Example When Getting Time of Sunday filter of Alarm No. 1 /api/param?application.event(1).filter(sunday).
-
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).type=mask&200 OK Interpretation Acquire filter type 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.
-
When only 1 Trigger is set: m1 will be returned in the case of make for alarm input 1. b1 will be returned in the case of break for alarm input 1. m2 will be returned in the case of make for alarm input 2. b2 will be returned in the case of break for alarm input 2. v1 will be returned for motion detection of video. ncbws will be returned for IR filter OFF. ncbwe will be returned for IR filter ON. efans will be returned for fan stop. camera.position(num).status will be returned for preset position.
-
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).trigger=v1 Interval can be set to periodic ftp assigned to event(6). Set "i1500" for interval 1500 seconds. Setting Example /api/param?application.event(6).trigger=i1500 When setting Trigger upon combining 2 alarm inputs, specify as m1(50)b2.
-
Format /api/param?application.smtp.port Example of Response application.smtp.port=25&200 OK Interpretation Acquire the port number setting of the SMTP server. Allowed users admin, operator, user Setting SMTP Server Port Number for VN-V686 Format /api/param?application.smtp.port=data Example /api/param?application.smtp.port=25 Example of Response application.smtp.port&200 OK Interpretation Change the port number setting of the SMTP server.
-
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.event.smtp.type&200 OK Interpretation Change the "POP before SMTP" setting. Specify as "simple" when setting to off and "pbs" when setting to on. Allowed users admin, operator Getting POP Server Address Setting from VN-V686 Format /api/param?application.pop.
-
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.user=somename&200 OK Response example when setting field is left blank application.pop.user=&200 OK Interpretation Acquire the user name setting of the POP server.
-
Allowed users admin, operator (Note: There is no API for reading passwords.) Getting FTP Server Address Setting from VN-V686 Format /api/param?application.ftp.host Example of Response application.ftp.host=192.168.0.200&200 OK Response example when setting field is left blank application.ftp.host=&200 OK Interpretation Acquire the FTP server address setting used for FTP transmission via alarm. Allowed users admin, operator, user Setting FTP Server Address for VN-V686 Format /api/param?application.ftp.
-
Allowed users admin, operator Getting FTP Server User Name Setting from VN-V686 Format /api/param?application.ftp.user Example of Response application.ftp.user=somename&200 OK Response example when setting field is left blank application.ftp.user=&200 OK Interpretation Acquire the FTP server user name setting used for FTP transmission via alarm. Allowed users admin, operator Setting FTP Server User Name for VN-V686 Format /api/param?application.ftp.user=data Example /api/param?application.ftp.
-
File Name Example Camera_20060207201315001.jpg When type2 is set, the file name is as ***.jpg. "***" can be gotten by another API, /api/param?application.ftp.naming_option. File Name Example Camera.jpg Allowed users admin, operator Setting File Naming of Periodic FTP for VN-V686 Format /api/param?application.ftp.naming=data Example /api/param?application.ftp.naming=type1 Example of Response application.ftp.naming&200 OK Interpretation Change file naming of periodic FTP.
-
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.jpg When /api/param?application.ftp.naming_option is set to "type2", the file name is as ***.jpg and "***" can be set by this API. File Name Example Camera.
-
Getting Alarm Output Time Setting from VN-V686 Format /api/param?peripheral.output_pin.pin(Number).duration Example /api/param?peripheral.output_pin.pin(1).duration Example of Response peripheral.output_pin.pin(1).duration=500&200 OK Interpretation Acquire the current alarm output duration in millisecond. Specify 1 or 2 to Number. When returned value is 0, it means infinite output. Allowed users admin, operator, user Setting Alarm Output Time for VN-V686 Format /api/param?peripheral.input_pin.
-
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. "home", "auto_pan", "auto_patrol(1)", "auto_patrol(2)", "auto_patrol(3)", "auto_trace" or "auto_tracking" will be returned. Allowed users admin, operator, user Setting Auto Return Mode for VN-V686 Format /api/param?camera.motion.auto_return.
-
Interpretation Acquire status of Auto Return. "on" or "off" will be returned. Allowed users admin, operator, user Setting Auto Return Status for VN-V686 Format /api/param?camera.motion.auto_return.status=data Example of Response camera.motion.auto_return.status&202 Accepted(camera.status=save) Interpretation Change status of Auto Return. Specify "on" or "off" to change the status. Specify "start" or "stop" for manual operation. "on" or "off" is saved by the API, camera.status=save.
-
Interpretation Change detection level of Auto Tracking. 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. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Restart Time of Auto Tracking from VN-V686 Format /api/param?camera.motion.auto_tracking.restarttime Example of response camera.motion.auto_tracking.
-
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. "on" or "off" will be returned. Allowed users admin, operator, user Setting On/Off of Pan Limit for VN-V686 Format /api/param?camera.motion.pan.limit.status=data Example of Response camera.motion.pan.limit.status&202 Accepted(camera.status=save) Interpretation Change On/Off of Pan Limit. Specify "on" or "off". The change is saved by the API, camera.
-
Moving to Left/Right Side of Pan Limit for VN-V686 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 Interpretation Move to left/right side of Pan Limit. Specify goto_leftlimit or goto_rightlimit. Allowed users admin, operator Getting Tilt Limit from VN-V686 Format /api/param?camera.motion.tilt.limit.upper Example of response camera.motion.tilt.limit.
-
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. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Auto Flip Setting from VN-V686 Format /api/param?camera.motion.tilt.auto_flip Example of response camera.motion.tilt.auto_flip=full_digital&200 OK Interpretation Acquire setting of auto flip. off, full_digital, half, full or full_reverse is returned.
-
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.
-
Getting Status of Variable Pan/Tilt Speed from VN-V686 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.
-
Allowed users admin, operator 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.
-
Interpretation Move to specified zoom position. To move to absolute position, specify from 0.00 to 99.99. 0.00 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.
-
0.00 means Near edge and 99.99 means Far edge. When zoom is Wide edge, focus can be from 0.00 to 99.99. When 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.
-
Example of Response camera.focus.speed&200 OK 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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
"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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
"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).
-
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).
-
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.
-
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).
-
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.
-
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.
-
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.
-
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.
-
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.
-
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. These are equivalent to the features on the Operation page of the WEB setting page.
-
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.log Response Return the following information.
-
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.
-
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.
-
Allowed user admin, operator 7. List of Protocols and Port Numbers Used with VN-V686 VN-V686 uses the following protocols and port numbers.
-
- 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.) - OpPassword Operator password required to display position title 8.2.
-
Execute Play method after setting properties below. (3) HTML Sample
-
}
SAMPLE TEXT
(2) Getting Multicast Execute Play method after setting properties below.
