JVC VN-V686U manual

IP Camera VN-V686U 　　 API GUIDE This document provides a description of protocols and API of VN-V686. Refer Readme file in the CD-ROM for updated informa tion. 2007.12.11. JVC LST0652-001A 1[...]

Updates Version Date Updates 1.00Beta 2007/12/11 Beta release. 2[...]

Custom Application Software Devel opment Guide VN-V686 can be used from a custom application software by ut ilizing 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/Focu[...]

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 H TTP 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<CRLF> Host: 192.168.0.2<CRLF><CRLF> Note <CRLF> denotes the line feed code ( 0x0D, 0x0A ). 3) VN[...]

Example of Booundary and pan/tilt/zoom information: --foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 31200<CRLF> X-Puls-Pan: 0<CRLF> X-Puls-Tilt: 0<CRLF> X-Posi-Zoom: 0<CRLF><CRLF> 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 190[...]

Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentic ation is also not necessary. Example GET /api/video?encode=jpeg&framerate=30&ptz_info=off HTTP/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Parameter value is indicated using =. Do not insert space before and after =. Example framerate=1 Pa[...]

x-vnv686_response: encode=jpeg&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF> 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 AP[...]

2007101413050912 3UTC up of the year/month/day, hour/minute/second, millisecond and timezone code. (reserved) 13 alarm = 00000000 (reserved) Camera ID 50 camera = input01 Stores camera information set at VN-V686. Motion Detect Setting 11 motion = 1 Specified as 1 when the motion detect is ON. Motion Detect Result 7 md = 1 Specified as 1 if motion i[...]

Note <CRLF> denotes the line feed code ( 0x0D, 0x0A ). 3) VN-V686 returns HTTP response. Example HTTP/1.1 200 OK<CRLF> Connection: close<CRLF> Content-Type: video/mp4v-es<CRLF> Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-V686 Network Camera<CRLF> x-vnv686_response: encode=mpeg4&framerate=15&f[...]

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> 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 1900[...]

encode For specifying compression format. For example, specify as encode=mpeg4 to ge t 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-vnv6[...]

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 There are VOL, Userdata1, GOV and Userdata2 before each I-[...]

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. Sourc e port number can be any value. system.id<CRLF> Response VN-V686 that received this packet sends udp packet to the source por[...]

5. Using API that Requires Basic Au thentication Basic authentication is required for APIs which are explained in Section 6. This se ction 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. The following is an example of API f[...]

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<CRLF> Connection: close<CRLF> Content-Length: 80<CRLF> Content-type: text/plain<CRLF> Date: [...]

(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[...]

Sender Camera 01<somename@somecompany.com> 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 [...]

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 be tween 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 [...]

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 gam ma setting is "active". Allowed us[...]

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(c[...]

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 stabili[...]

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 ima ge. DNR is valid when AGC is autoM or autoH. The cha[...]

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[...]

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 s[...]

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.lig[...]

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 re turned. When iris is auto,"autoL", "autoM" or "autoH" is returned. 100 means full open. Allowed [...]

Note of White Balance Setting: After power on, White Balance setting of Home position is applied. Afte r 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 s[...]

Interpretation Change R-gain white balance setting. Spe cify 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=sa ve. 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 [...]

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. Spec ify "off", "a", "b", "c" or "d". Refer the instruction manual for detailed[...]

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 Settin g from VN-V686 Format /api/param?encode(1).cbr_mode Example of response encode(1).cbr_mode=afs&200 OK Interpr[...]

selection. Each of these choices corresponds to the file sizes as follows. Level File Size Setting for VGA File Size Setting for QVGA 1 80k 27k 2 60k 20k 3 40k 13k 4 30k 10k 5 25k 8k 6 20k 7k 7 15k 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. [...]

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 [...]

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 MP EG-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. Refe[...]

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 pa ge of the WEB setting page. Refer to the instruction manual for details on the Alarm [...]

Example of Response application.event(1).action=mailto/somebody@somecompany.com/none/Message&200 OK Interpretation Acquire the alarm action of the specified ala rm 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 diffe rent from the alarm input pi[...]

When preset position is specified, position number will be returned. Example of Response when position numbe r 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 [...]

For example, specify 3 characters %20 when inserting a space in the character string. For e xample, 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 charact[...]

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=[...]

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.eve nt(Number).status=restart. Allowed users admin, operator Getting Alarm Filter Time from VN-V686 Format /api/param?application[...]

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 ac tion for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to eve[...]

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 fil[...]

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?applica[...]

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 Respon[...]

returned when this is set to on. Allowed users admin, operator, user Setting "POP before SMTP" for VN-V68 6 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 " si[...]

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-V6 86 Format /api/param?application.pop.user Example of Response application.pop.user=somename&200 OK Response example when setting field is left bla nk a[...]

Allowed users admin, operator (Note: There is no API for reading passwords.) Getting FTP Server Address Setting fro m 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 bla nk application.ftp.host=&200 OK Interpretation Acquire the FTP serv[...]

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 bla nk application.ftp.user=&200 OK Interpretation Acquire the FTP server user name setting used for FTP tra nsmission via[...]

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/p[...]

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 ***YYYMMDDHHMMS SNNN.jpg, and "***" can be set by this API. File Name Example Camera_20060207201315001.jpg When /api/param?application.ftp.nami[...]

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 millise cond. Specify 1 or 2 to Number. When returne[...]

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_pa[...]

Interpretation Acquire status of Auto Return. "on" or "off" will be returned. Allowed users admin, operator, user Setting Auto Return Status for VN-V6 86 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 o[...]

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 sa ved, the setting is restored by reboot. Allowed users admin, operator Getting Restart Time of Auto Tracking from VN -V686 Format /api/para[...]

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 o[...]

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[...]

speed is 4 steps internally. The speed is applied also to preset position of auto patrol. The change is sa ved 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 fro m VN-V686 Format /api/param?camera.motion.tilt.auto_flip Example of response camera.[...]

Moving to Specified Pan Posi tion for VN-V686 Format /api/param?camera.motion.pan=data Example to move to absolute 90 degrees /api/param?camera.motion.pan=90.00 Example to move to relative 45 degrees /api/param?camera.motion.pan=+45.00 Example of Response camera.motion.pan&200 OK Interpretation Move to specified pan position. To move to absolut[...]

Getting Status of Variable Pan/Til t 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 Settin[...]

Allowed users admin, operator Setting Direction of Tilt Operati on 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 Spee[...]

Interpretation Move to specified zoom position. To move to absolute position, spe cify 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 came[...]

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 Pos ition for VN-V686 Format /api/param?camera.focus=data Example to move [...]

Example of Response camera.focus.speed&200 OK Interpretation Set speed of focus operation. Specify 0 to 100. The spee d 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 curren[...]

Moving to Preset Position for VN-V6 86 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[...]

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-V6 86 Format /api/param?camera.motion.auto_pan.mode Example of response camera.motion.auto_pan.mode=left&200 OK Interpretation Acquire d[...]

Interpretation Set current position as start position of auto pan. Pan/tilt/z oom/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 En d Posi[...]

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. Afte[...]

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 pa trol 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&[...]

is saved by the API, camera.motion.auto_patrol.status=save. If the change is not saved, the se tting 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 Acc[...]

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 a s area numbe[...]

"clear" or "exit". When editing is started, zoom is changed to Wide edge, and pan/tilt positions a re restored if the privacy masking area has settings. Pan/tilt position of the privacy masking area can be cha nged by pan/tilt APIs. Allowed users admin, operator Setting Width of Privacy Masking A rea for VN-V686 Format /api/para[...]

Caution: Motion detect does not work during auto tracking. Allowed users admin, operator Getting Motion Detect Sensitivity fro m 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 val[...]

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 st[...]

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 Examp[...]

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 ga teway, disable DHCP. De[...]

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 se ttings. Specify "on", "off" or "restart". Changes of DNS server settings become valid by "restart". Allowed users admin, operator [...]

Allowed users admin, operator, user Setting TOS Value of JPEG for VN-V68 6 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 JP[...]

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 betwe en 1 to 255. To validate the change, use "network.interface.status=restart" API. Allowed user admin Getting Multicast[...]

Allowed user admin Getting Network Negotiation Setti ng from VN-V686 Format /api/param?network.interface.negotiation Example of Response network.interface.negotiation=auto&200 OK Interpretation Acquire the network Negotiation setting. Eithe r auto, 100full, 100half, 10full or 10half will be returned. Allowed users admin, operator, user Setting [...]

Allowed users admin, operator 6.13. Multicast Streaming The APIs below are related to manual streaming. These are equivalent to the features on the S treaming page of the WEB setting page. Refer to the instruction manual for details on the Streaming pa ge. Getting Status of JPEG Multicast Str eaming from VN-V686 Format /api/param?network.destinatio[...]

"network.destination(1).host=start" API. Allowed user admin Getting JPEG Multicast Port Numb er 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 [...]

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 VN- V686 Format /api/param?network.destinatio[...]

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 t[...]

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[...]

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 c hanges to settings. Specify "on", "off" or "restart". as on or off. IP address of NTP server and access interval are validated by "restart". Allowed [...]

Getting Access Interval Unit of NT P 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[...]

Timezone Character String Description GMT-12 Timezone that is 12 hours earlier than the Greenwich Mean Time . GMT-11 Timezone that is 11 hours earlier than the Greenwich Mean Time . GMT-10 Timezone that is 10 hours earlier than the Greenwich Mean Time . Hawaii Same timezone as GMT-10 GMT-9:30 Timezone that is 9 hours and 30 minutes earlier than the[...]

GMT+8:45 Timezone that is 8 hours and 45 minutes later than the Greenwich Mean Time. GMT+9 Timezone that is 9 hours later than the Greenwich Mean Time . GMT+9:30 Timezone that is 9 hours and 30 minutes later than the Greenwich Mean Time. Japan Same timezone as GMT+9. GMT+10 Timezone that is 10 hours later than the Greenwich Mean Time . GMT+10:30 Ti[...]

6.17. Maintenance The APIs below are related to maintenance. These are equivalent to the fea tures 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-[...]

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 a[...]

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 stre am can be occurred in random order, so it can happen that sending(01) is vacant though sending(02) has info[...]

Interpretation Acquire firmware revisions of streaming manager. Allowed users admin, operator, user Getting Firmware Revisions of PTZ C ontroller 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, operato[...]

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 ala rm action. Either active or passive is returned. active mode: Standard mode of FTP server. Also called PORT mo[...]

Allowed user admin, operator 7. List of Protocols and Po rt Numbers Used with VN-V686 VN-V686 uses the following protocols and port numbers. Protocol / Port Number Use TCP 80 WEB setting page, API for Getting status and changing settings, acquisition of JPEG from VN-V686 by client UDP 80 Search for VN-V686 TCP 20, 21 FTP TCP 25 SMTP (Mail by Alarm [...]

- 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 MyDocumen[...]

Execute Play method after setting properties below. <OBJECT ID="JPEGVi ewer" WIDTH = 640 HEIGHT= 480 CLASSID="CLSID:85D1C1 39-BE64-430E-955E-EE4939E A4520" CODEBASE="./v686j.cab #version=1,0,1,0"> <PARAM NAME="Mu ltiIP" VALUE="225.0.1.1"> <PARAM NAME="Mu ltiPort" VALUE="[...]

} </SCRIPT> <BODY STYLE="font-f amily:sans-serif;" onBeforeUnload="stop_clic k()" onload="p lay_click()"> <font size="6"> SAMPLE TEXT </font><br> <OBJECT ID="JPEGViewer " WIDTH = 641 HEIGHT= 481 CLASSID="CLSID:85D1C1 39-BE64-430E-955E-EE4939E A4520" STYLE=&[...]

HEIGHT= 240 CLASSID="CLSID:062 774CF-C5DB-4683-909F-9B1AB 013CF35" CODEBASE="./v686m.ca b#version=1,0,1,0"> <PARAM NAME="IP " VALUE="192 .168.0.2"> <PARAM NAME="Ht tpPort" VA LUE="80"> <PARAM NAME="DispWi dth" VALUE="320"> <PARAM NAME="DispH[...]

MPEG4Viewer.Play (); } function still_clic k(obj) { if(obj.value== " Play "){ obj.value="Pause"; MPEG4Viewer.Se tStill(0); }else{ obj.value=" Pla y "; MPEG4Viewer.Se tStill(1); } } </SCRIPT> <BODY STYLE="font-f amily:sans-serif;" onBeforeUnload="stop_clic k()" onload="p lay_click()&quo[...]

- Set unique Multicast address and port to each Multicast st ream if multiple multicast streams are required. 9. FAQ (1) Low Frame rate due to long delay of network - Causes of Low Frame Rate During transmission via TCP, VN-V686 sends out the following data by receiving the Ack of TCP. When network delay is long, reception of Ack will be delayed an[...]