IP CameraVN-V686U API GUIDEThis document provides a description of protocols and API of VN-V686.Refer Readme file in the CD-ROM for updated informati
Target position of Intelligent tracking 30 track_area = 90,420-150,460 Indicates position of Intelligent tracking target. The numbers are to
- TimeFormat Set from 0 to 6 to select time format0: YYYY/MM/DD HH:MM:SS.mm1: YYYY/MM/DD HH:MM:SS2: DD/MM/YYYY HH:MM:SS3: MM/DD/YYYY HH:MM:SS
<PARAM NAME="DispHeight" VALUE="240"> <PARAM NAME="FrameRate" VALUE="15">
if(obj.value==" Play "){ obj.value="Pause"; JPEGViewer.SetStill(0); }else{ obj.value=" Play "
VNviewcnt1.Play8.4. HTML Example for MPEG-4 viewer(1) Getting MPEG-4 at display size QVGAExecute Play method after setting properties below.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML4.0 Transitional//EN"><HTML><HEAD> <META http-equiv="Content-Type" con
<form name="myForm"><table><tr><td><INPUT TYPE="BUTTON" NAME="still_btn" VALUE="Pause&qu
HTTP Response and MPEG-4 stream sent out by VN-V686 are as follows.When ptz_info=on is specified, boundary, pan/tilt/zoom information and MPEG-4 VOP w
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 no
Server: JVC VN-V686 Network Camera<CRLF>x-vnv686_response: encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF&
There are VOL, Userdata1, GOV and Userdata2 before each I-VOP. Data Structure before I-VOP Item Note VOL VOL of MPEG-4 Video Userdata1 Reserved GO
Response Example system.id=VN-V686U(192.168.0.2/24)&200 OK<CRLF>4. Getting Alarm from VN-V6864.1. Procedure1) The client establishes
The following is an example of API for Getting subnet mask of VN-V686.ExampleGET /api/param?network.interface.subnetmask HTTP/1.1<CRLF>Accept: t
Date: Fri, 13 MAY 2005 07:33:12 GMT<CRLF>Server: JVC VN-V686 API Server<CRLF>network.interface.subnetmask=255.0.0.0&200 OK<CRLF>
An error code will be returned when setting is not properly performed. Example:ParamA.ParamB.ParamC&401 Unauthorized6.2. CameraThese APIs are rela
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 e
UpdatesVersion Date Updates1.00 2007/12/13 First release.1.01 2008/4/25 Limitation of Registering Preset Position is added.Fixed auto patrol number fo
Example of setting a value /api/param?camera.image.pedestal=50Example of 1 step change /api/param?camera.image.pedestal=+Example of response camera
Example of response camera.image.gamma.activelevel&202 Accepted(camera.status=save)Interpretation Change active gamma level setting. Specify fro
becomes sharper 1 step by specifying "+", softer 1 step by specifying "-". The change is saved by the API, camera.status=save. If
reboot.Allowed users admin, operatorGetting Stabilizer Level from VN-V686Format /api/param?camera.image.stabilizer.levelExample of response camera.
Getting AGC from VN-V686Format /api/param?camera.image.brightnessExample of response camera.image.brightnesss=autoL&200 OKInterpretation Acquir
"quality" is returned. In case of "motion", AGC is used before using sense up. In case of "quality", sense up is used be
Interpretation Acquire B&W mode. "color", "bw", "autoL", "autoM" or "autoH" is returned.Allowed
Allowed users admin, operator, userSetting Light for focus in B&W mode for VN-V686Format /api/param?camera.image.true_daynight.light=dataExample
Setting Iris for VN-V686Format /api/param?camera.iris=dataExample to set fixed value /api/param?camera.iris=50Example to set auto /api/param?camer
Interpretation Acquire white balance setting. "autoW", "autoN" or "manual" is returned.Allowed users admin, operator,
Custom Application Software Development GuideVN-V686 can be used from a custom application software by utilizing the API and protocols for VN-V686. Th
Interpretation Acquire B-gain of white balance setting. s0 to s255 is returned. The s before number means "step". Allowed users admin, ope
Example of response camera.image.blc=off&200 OKInterpretation Acquire Back Light Compensation setting. "off", "a", "b&q
Example /api/param?encode(1).framesize=qvgaExample of response encode(1).framesize&202 Accepted(encode(1).status=save)Interpretation Change JPE
Example of response encode(1).quality&202 Accepted(encode(1).status=save)Interpretation Change the file size setting of JPEG. The unit of set va
Getting MPEG-4 bitrate Setting from VN-V686Format /api/param?encode(2).bitrateExample of response encode(2).bitrate=8000000&200 OKInterpretation
Interpretation Acquire frame rate of MPEG-4 encoding. Allowed users admin, operator, userSetting MPEG-4 Frame Rate Setting for VN-V686Format /api/p
Setting MPEG-4 Priority Setting for VN-V686Format /api/param?encode(2).priority=dataExample /api/param?encode(2).priority=motionExample of response
Allowed users admin, operatorGetting Alarm Action from VN-V686Format /api/param?application.event(Number).actionExample When Getting action of alar
application.event(1).action=udpto/10.0.0.100/20000/Message&200 OKWhen alarm output is specified, pinout, distinction between make/break (m1 or b1)
Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number o
Content1. Getting JPEG from VN-V686 via HTTP2. Getting MPEG-4 from VN-V686 via HTTP3. API to Search VN-V6864. Getting Alarm from VN-V686 via TCP5. Usi
Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is specified. Segments are indicated by /. The
Example of Response application.event(1).filter(sunday).status&202 Accepted(application.event(1).status=restart)Interpretation Set filter settin
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.e
Example When Getting Trigger of Alarm No. 1 /api/param?application.event(1).triggerExample of Response application.event(1).trigger=m1&200 OKI
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 ala
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 w
Allowed users admin, operatorGetting "POP before SMTP" Setting from VN-V686Format /api/param?application.smtp.typeExample of Response app
Interpretation Acquire the port number setting of the POP server.Allowed users admin, operator, userSetting POP Server Port Number for VN-V686Format
Setting POP Server Password for VN-V686Format /api/param?application.pop.password=dataExample /api/param?application.pop.password=somewordExample of
Interpretation Change the FTP server directory setting used for FTP transmission. It is possible to set FTP transmission to a directory under the FTP
1. Getting JPEG from VN-V686 via HTTP 1.1. Basic Procedures1) The client establishes a TCP connection to port number 80.2) The client sends out API.Ex
Example of Response application.ftp.naming=default&200 OKInterpretation Acquire file naming of periodic FTP. "default", "type1&qu
File Name Example Camera.jpgAllowed users admin, operatorSetting User Define Name of File Naming for VN-V686Format /api/param?application.ftp.namin
For Post Duration /api/param?application.object.postrec&200 OKInterpretation Change parameters for PrePost + ftp. These parameters are used wh
Allowed users admin, operator6.6. PTZThe APIs below are related to pan/tilt/zoom control. These are equivalent to the features on the PTZ page of the
Accepted(camera.status=save)Interpretation Change timeout of Auto Return in seconds. Specify 60, 120, 180, 300, 600, 1200, 1800 or 3600. The change i
Allowed users admin, operatorSpecify target for Intelligent Tracking for VN-V686Format /api/param?camera.motion.auto_tracking(2).target=sx-sy
/api/param?camera.motion.auto_tracking(2).restarttimeExample of response camera.motion.auto_tracking(1).restarttime=10&200 OKInterp
Getting Tracking Zoom setting of Intelligent Tracking from VN-V686Format /api/param?camera.motion.auto_tracking(2).zoomExample of response camera.mo
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.All
current resolution is QVGA.Allowed users admin, operator, userSetting Dead Zone of Intelligent Tracking for VN-V686Format /api/param?camera.motion.a
When ptz_info=on is specified, boundary, pan/tilt/zoom information and JPEG file will be sent out continuously after HTTP Response as follows.Example
Accepted(camera.status=save)Interpretation Change On/Off of Pan Limit. Specify "on" or "off". The change is saved by the API, cam
Getting Tilt Limit from VN-V686Format /api/param?camera.motion.tilt.limit.upperExample of response camera.motion.tilt.limit.upper=5&200 OKInterp
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
Moving to Specified Pan Position for VN-V686Format /api/param?camera.motion.pan=dataExample to move to absolute 90 degrees /api/param?camera.motion
Format /api/param?camera.motion.variable_pantiltspeed.statusExample of Response camera.motion.variable_pantiltspeed.status=on&200 OKInterpretati
Setting Direction of Tilt Operation for VN-V686Format /api/param?camera.motion.tilt.mode=dataExample to set to up /api/param?camera.motion.tilt.mod
means Wide edge and 99.99 means Tele edge.Allowed users admin, operatorZoom Operation for VN-V686Format /api/param?camera.motion.zoom.status=dataExa
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, userMoving to
Interpretation Set speed of focus operation. Specify 0 to 100. The speed is 4 steps internally.Allowed users admin, operator(3) Preset PositionGetti
Moving to Preset Position for VN-V686Format /api/param?camera.position(number).status=gotoExample of Response camera.position(3).status&200 OKIn
1.2. API FormatStructure Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.Example
Example of Response camera.motion.auto_pan.status&200 OKInterpretation Start/stop auto pan. Specify start, stop, goto_start or goto_end.Allowed
Interpretation Set current position as start position of auto pan. Pan/tilt/zoom/focus positions are saved.Caution: Though Moving to tilt position ov
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/focu
Allowed users admin, operator, userGetting Preset Postion Number of Auto Patrol from VN-V686Format /api/param?camera.motion.auto_patrol(number1).pos
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, operat
number. Allowed users admin, operator, userSetting Status of a Privacy Masking Area for VN-V686Format /api/param?camera.private_mask.area(number).st
"clear" or "exit". When editing is started, zoom is changed to Wide edge, and pan/tilt positions are restored if the privacy maski
Caution: Motion detect does not work during auto tracking.Allowed users admin, operatorGetting Motion Detect Sensitivity from VN-V686Format /api/par
Example /api/param?camera.detection.area=000102030405060708090001Example of response camera.detection.area&202 Accepted(camera.status=save)Inter
Getting IP Address from VN-V686Format /api/param?network.interface.ipExample of Response network.interface.ip=192.168.0.2&200 OKInterpretation
HTTP/1.1 200 OK<CRLF>Content-Type: multipart/x-mixed-replace;boundary=--foo<CRLF>Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>Server: JV
Interpretation Acquire the current default gateway.Allowed users admin, operator, userSetting Default Gateway for VN-V686Format /api/param?network.
Example /api/param?network.dns.status=onExample of Response network.dns.status&200 OKInterpretation Change status of DNS server setting, or val
Allowed users admin, operator, userSetting TOS Value of JPEG for VN-V686Format /api/param?network.interface.dscp.video.jpeg=dataExample /api/param?
Example /api/param?network.interface.ttl.unicast=56Example of Response network.interface.ttl.unicast&202 Accepted(network.interface.status=resta
Allowed user adminGetting Network Negotiation Setting from VN-V686Format /api/param?network.interface.negotiationExample of Response network.interf
Allowed users admin, operator6.13. Multicast StreamingThe APIs below are related to manual streaming. These are equivalent to the features on the Str
"network.destination(1).host=start" API.Allowed user adminGetting JPEG Multicast Port Number from VN-V686Format /api/param?network.destina
Format /api/param?network.destination(2).statusExample of Response network.destination(2).status=off&200 OKInterpretation Acquire status of MPE
Allowed users admin, operatorSetting MPEG-4 Multicast Port Number for VN-V686Format /api/param?network.destination(1).port=dataExample /api/param?n
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 n
FFD8 Start Code FFE0 Application Segment FFFE Comment Segment 1 FFFE Comment Segment 2 (reserved) FFC4 DHT Huffman Table FFDB DQT Quantization Table
Example /api/param?network.ntp.status=onExample of Response network.ntp.status&200 OKInterpretation Change the on/off status of SNTP client, or
Getting Access Interval Unit of NTP from VN-V686Format /api/param?network.ntp.unitExample of Response network.ntp.unit=hour&200 OKInterpretation
Timezone Character String Description GMT-12 Timezone that is 12 hours earlier than the Greenwich Mean Time. GMT-11 Timezone that is 11 hours earli
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 Tim
6.17. MaintenanceThe APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the WEB setting page. Refe
Allowed users admin, operator, userSetting Time of Auto Cleaning for VN-V686Format /api/param?camera.motion.pan.auto_cleaning.time=dataExample of Re
system.session.sending(01).from.framesize=vga&200 OKIn case of MPEG-4, system.session.sending(01).from.encode=mpeg4 is returned. In case of multic
Example of Response system.software.revision(net)=V1-00&200 OKInterpretation Acquire firmware revisions of streaming manager.Allowed users admi
returned.Allowed users admin, operator, userGetting Mode of FTP Server from VN-V686Format /api/param?application.ftp.modeExample of Response applic
number for data plus one is the port number for control.Allowed user admin, operator7. List of Protocols and Port Numbers Used with VN-V686VN-V686 us
Komentarze do niniejszej Instrukcji