JVC VN-V686U Instrukcja Użytkownika

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

Note <CRLF> denotes the line feed code (0x0D, 0x0A).3) VN-V686 returns HTTP response.ExampleHTTP/1.1 200 OK<CRLF>Connection: close<CRLF

- Set unique Multicast address and port to each Multicast stream if multiple multicast streams are required.9. FAQ(1) Low Frame rate due to long delay

Example of Booundary and pan/tilt/zoom information:--foo<CRLF>Content-Type: image/jpeg<CRLF>Content-Length: 5914<CRLF>X-Puls-Pan: 0&

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

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 set

3. API to Search VN-V686VN-V686 in LAN can be searched by broadcast packet that includes this API.Search VN-V686 in LANProtocol Send udp packet w

5. Using API that Requires Basic Authentication Basic authentication is required for APIs which are explained in Section 6. This section provides gene

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 & a

(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

Sender Camera01<[email protected]>Allowed users admin, operator, userSetting Camera ID in JPEG from VN-V686Format /api/p

Getting Black level from VN-V686Format /api/param?camera.image.pedestalExample of response camera.image.pedestal=50&200 OKInterpretation Acquir

UpdatesVersion Date Updates1.00Beta 2007/12/11 Beta release.2

Getting Active Gamma Level from VN-V686Format /api/param?camera.image.gamma.activelevelExample of response camera.image.gamma.activelevel=0&200

levels. The larger the value, the sharper will be the image.Allowed users admin, operator, userSetting Enhance for VN-V686Format /api/param?camera.i

Allowed users admin, operator, userSetting Stabilizer for VN-V686Format /api/param?camera.image.stabilizer=dataExample of setting /api/param?came

Setting DNR for VN-V686Format /api/param?camera.image.dnr=dataExample of setting /api/param?camera.image.dnr=onExample of response camera.image.d

disabled. It becomes bigger 1 step by specifying "+", smaller 1 step by specifying "-". The change is saved by the API, camera.sta

Interpretation Change shutter speed setting. Specify 60, 100, 250, 500, 1000, 2000, 4000, 10000, "+" or "-". To set 1/60 for exam

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

camera.motion.auto_pan.image=save.Getting Iris from VN-V686Format /api/param?camera.irisExample of response camera.iris=autoM&200 OKInterpretati

Note of White Balance Setting: After power on, White Balance setting of Home position is applied. After moving to preset position, White Balance setti

Interpretation Change R-gain white balance setting. Specify s0 to s255. The s before number means "step". Default value is s85. The change

Custom Application Software Development GuideVN-V686 can be used from a custom application software by utilizing the API and protocols for VN-V686. Th

Format /api/param?camera.image.blc=dataFormat of setting ON /api/param?camera.image.blc=aExample of response camera.image.blc&202 Accepted(came

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

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

Setting MPEG-4 bitrate Setting for VN-V686Format /api/param?encode(2).bitrate=DataExample /api/param?encode(2).bitrate=2000000Example of response en

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

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, operator6.4

Example of Response application.event(1).action=mailto/[email protected]/none/Message&200 OKInterpretation Acquire the alarm action of the

When preset position is specified, position number will be returned. Example of Response when position number is 2 application.event(1).action=camera.

For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.&q

Specify preset position number when preset position is specified.Setting Example /api/param?application.event(1).action=camera.position(2).status/goto

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 sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Specify on to enable the filter, off to disable the filter.The

Example When Getting Type of Sunday filter of Alarm No. 1 /api/param?application.event(1).filter(sunday).typeExample of Response application.event

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.

specify ncbwe for IR Filter ON. specify efans for fan stop. specify camera.position(num).status for preset position. "num" is from

Format /api/param?application.smtp.portExample of Response application.smtp.port=25&200 OKInterpretation Acquire the port number setting of the

returned when this is set to on.Allowed users admin, operator, userSetting "POP before SMTP" for VN-V686Format /api/param?application.smtp

Example of Response application.pop.port&200 OKInterpretation Change the port number setting of the POP server.Allowed users admin, operatorGet

Allowed users admin, operator(Note: There is no API for reading passwords.)Getting FTP Server Address Setting from VN-V686Format /api/param?applicati

Allowed users admin, operatorGetting FTP Server User Name Setting from VN-V686Format /api/param?application.ftp.userExample of Response application

File Name Example Camera_20060207201315001.jpgWhen type2 is set, the file name is as ***.jpg. "***" can be gotten by another API, /api/para

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

Interpretation Change user define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?application.ftp.naming_option i

Getting Alarm Output Time Setting from VN-V686Format /api/param?peripheral.output_pin.pin(Number).durationExample /api/param?peripheral.output_pin

PTZ Controller.(1) Settings for PTZ ControlGetting Auto Return Mode from VN-V686Format /api/param?camera.motion.auto_return.modeExample of response

Interpretation Acquire status of Auto Return. "on" or "off" will be returned.Allowed users admin, operator, userSetting Auto Ret

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

Format /api/param?camera.motion.pan.limit.statusExample of response camera.motion.pan.limit.status=off&200 OKInterpretation Acquire On/Off of P

Moving to Left/Right Side of Pan Limit for VN-V686Format /api/param?camera.motion.pan.status=dataExample to move ot left side /api/param?camera.mot

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 c

Moving to Specified Pan Position for VN-V686Format /api/param?camera.motion.pan=dataExample to move to absolute 90 degrees /api/param?camera.motion

Getting Status of Variable Pan/Tilt Speed from VN-V686Format /api/param?camera.motion.variable_pantiltspeed.statusExample of Response camera.motion.

Example of Booundary and pan/tilt/zoom information:--foo<CRLF>Content-Type: image/jpeg<CRLF>Content-Length: 31200<CRLF>X-Puls-Pan: 0

Allowed users admin, operatorSetting Direction of Tilt Operation for VN-V686Format /api/param?camera.motion.tilt.mode=dataExample to set to up /ap

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 e

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.0

Example of Response camera.focus.speed&200 OKInterpretation Set speed of focus operation. Specify 0 to 100. The speed is 4 steps internally.Allo

Moving to Preset Position for VN-V686Format /api/param?camera.position(number).status=gotoExample of Response camera.position(3).status&200 OKIn

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

Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.Example GET /api/video?encode=jp

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

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

x-vnv686_response: encode=jpeg&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF>1.4. RestrictionsAccess restrictionVN-V686 h

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

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

20071014130509123UTC up of the year/month/day, hour/minute/second, millisecond and timezone code. (reserved) 13 alarm = 00000000 (reserved) Came

Setting Time of Auto Cleaning for VN-V686Format /api/param?camera.motion.pan.auto_cleaning.time=dataExample of Response camera.motion.pan.auto_clea

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

Interpretation Acquire firmware revisions of streaming manager.Allowed users admin, operator, userGetting Firmware Revisions of PTZ ControllerFormat

Allowed users admin, operator, userGetting Mode of FTP Server from VN-V686Format /api/param?application.ftp.modeExample of Response application.ftp

Allowed user admin, operator7. List of Protocols and Port Numbers Used with VN-V686VN-V686 uses the following protocols and port numbers. Protocol /

- 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

Execute Play method after setting properties below. <OBJECT ID="JPEGViewer" WIDTH = 640 HEIGHT= 480 CLASSID=&qu

}</SCRIPT><BODY STYLE="font-family:sans-serif;" onBeforeUnload="stop_click()" onload="play_click()"><font

HEIGHT= 240 CLASSID="CLSID:062774CF-C5DB-4683-909F-9B1AB013CF35" CODEBASE="./v686m.cab#version=1,0,1,0">

MPEG4Viewer.Play();}function still_click(obj){ if(obj.value==" Play "){ obj.value="Pause"; MPEG4Viewer.SetSti