Instruction/ maintenance manual of the product VN-V25U JVC
Go to page of 88
IP Camera VN-V25U/26U API GUIDE This document provides a description of protocols and API of VN-V25/26. Refer Readme file in the CD-ROM for updated informa tion.
Updates Version Date Updates 1.00 2007/11/1 First release. 1.01 2007/11/27 Model Name in JPEG is corrected from VN-V25 to VN-V25U. Description about disconnect of 11th alarm clie nt is corrected. 1.02 2008/1/19 "boudary" in JPEG stream is deleted.
Custom Application Software Devel opment Guide VN-V25/26 can be used from a custom application software by utilizing the API and protocols for VN-V25/26. The following operations are possible. ● Getting JPEG from VN-V25/26. ● Getting MPEG-4 from VN-V25/26.
Content 1. Getting JPEG from VN-V25/26 via HTTP 2. Getting MPEG-4 from VN-V25/26 via HTTP 3. API to Search VN-V25/26 4. Getting Alarm from VN-V25/26 via TCP 5. Using API that Requires Basic Authentication 6. API for Getting/Changing Parameters of VN-V25/26 7.
This document describes APIs of VN-V25/26. Differences of VN-V25 and VN- V26 are as below. Function VN-V25 VN-V26 Low Lux Easy Day&Night B&W Mode (True Day&Night) Audio Server none Mic is embedded Audio Output none Audio Output Terminal 1.
Details of JPEG file format is explained later. 5) When the client wants to stop current JPEG transmission, the client disconnects TCP80. VN-V25/26 does not accept further API via current TCP that is used for JPEG transmission.
Parameter Description encode For specifying compression format. For example, specify as encode=jpeg to ge t JPEG. framerate For specifying the frame rate. For example, specify as framerate =5 to get at 5 fps. Specify as framerate=- 5 to get at 1/5 fps, or in other words, 1 frame in 5 seconds.
JPEG file from VN-V25/26 is JFIF compliant and consist of the following. FFD8 Start Code FFE0 Application Segment FFFE Comment Segment 1 FFFE Comment Segment 2 (reserved) FFC4 DHT Huffman Table FFDB D.
Item names and values, excluding the version information that does not include =, are stored in the following forma t. Example: When width=640, the 13-byte area will be written as follows. 2. Getting MPEG-4 from VN-V25/26 via HTTP 2.1. Basic Procedures 1) The client establishes a TCP connection to port number 80.
Details of MPEG-4 stream is explained later. 5) When the client wants to stop current MPEG-4 transmission, the client disconnects TCP80. VN-V25/26 does not accept further API via current TCP that is used for JPEG transmission.
Content-Type: video/mp4v-es<CRLF> Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-V25 Network Camera<CRLF> x-vnv25_response: encode=mpeg4&framerate=30&framesize=vga<CRLF><CRLF> 2.
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 GOV GOV of MPEG-4 Video Userdata2 Userdata Da.
2) When motion is detected from the video image of VN-V25/26, or when there are changes to the ala rm input (make or break), VN-V25/26 will send out alarm information in the following format. The first 2 lines indic ate the current alarm input status (make or break).
Example GET /api/param?network.interface.subnetmask HTTP/1.1<CRLF> Accept: text/plain<CRLF> Host: 192.168.0.2<CRLF> Authorization: Basic YWRtaW46dm4tdjJ4<CRLF><CRLF> Specify the response format by Accept line. Plain text response is returned when this is specified a s text/plain.
6. API for Getting/Changin g Parameters of VN-V25/26 This section provides description of APIs for getting/changing parameters of VN-V25/26. Make use of the AP I explained in this section in the way as mentioned in Section 5 .
/api/param?ParamA.ParamB.ParamC=Data&ParamA.ParamB.ParamD=Data The upper limit of this character string is 1024 bytes. The maximum number of parameters that c an be set at a time is 15. Status settings, i.e. network.interface.status, ne twork.dns.
Example of response camera.id=Camera01&200 OK Sender Camera 01<somename@somecompany.com> Allowed users admin, operator, user Setting Camera ID in JPEG from VN-V25/26 Format /api/param?camera.id=data Example /api/param?camera.id=Camera01 Example when setting as blank /api/param?camera.
Getting Black level from VN-V25/26 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.
Getting Enhance Band from VN-V25/26 Format /api/param?camera.image.enhance.band Example of response camera.image.enhance.band=high&200 OK Interpretation Acquire enhance band setting. Value of enhance band is high or low. When lcd1, lcd2 or crt is set to monitor type, enhance band setting is ignored.
Example of response camera.image.color=50&200 OK Interpretation Acquire color level value. Range of color level is between 0 to 100. The va lue is mapped to 11 internal levels. The larger the value, the stronger will be the color. Allowed users admin, operator, user Setting Color Level for VN-V25/26 Format /api/param?camera.
Allowed users admin, operator, user Setting Limit of Sense Up for VN-V2 5/26 Format /api/param?camera.image.senseup_limit=data Example /api/param?camera.image.senseup_limit=4 Example of response camera.image.senseup_limit &202 Accepted(camera.status=save) Interpretation Change limit of sense up.
Allowed users admin, operator, user Setting Shutter Speed for VN-V25/26 Format /api/param?camera.shutter=data Example of setting a value /api/param?camera.shutter=60 Example of 1 step change /api/param?camera.shutter=+ Example of response camera.shutter &202 Accepted(camera.
Setting B&W Mode (True Day&Night) for VN-V26 (VN-V26 Only) Format /api/param?camera.image.true_daynight=data Example /api/param?camera.image.true_daynight=bw Example of response camera.image.true_daynight &202 Accepted(camera.status=save) Interpretation Change B&W mode setting.
Setting White Balance for VN-V25/26 Format /api/param?camera.image.white_balance=data Example /api/param?camera.image.white_balance=auto Example of response camera.image.white_balance &202 Accepted(camera.status=save) Interpretation Change white balance setting.
Interpretation Change B-gain white balance setting. Spe cify s0 to s255. The s before number means "step". D efault value is s219.The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Example of response encode(1).framesize=vga&200 OK Interpretation Acquire JPEG frame size setting. "vga" or "qvga" is returned. Allowed users admin, operator, user Setting JPEG Frame Size for VN-V25/26 Format /api/param?encode(1).
Interpretation Acquire the file size setting of JPEG. If the re sponse is 40k for example, the setting is 40KB. Allowed users admin, operator, user Setting JPEG File Size Setting for VN-V25/26 Format /api/param?encode(1).quality=Data Example /api/param?encode(1).
Interpretation Change MPEG-4 frame size. Specify "vga" or "qvga". When frame size of JPEG and MPEG-4 are same, privacy masking is available for both compression. When the y are not same, compression on QVGA can have privacy masking.
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 Getting MPEG-4 Frame Rate Setting from VN-V25/26 Format /api/param?encode(2).framerate Example of response encode(2).
Getting MPEG-4 Priority Setting from VN -V25/26 Format /api/param?encode(2).priority Example of response encode(2).priority=motion&200 OK Interpretation Acquire priority of MPEG-4 encoding.
Format /api/param?audio.input(1).gain Example of response audio.input(1).gain=32&200 OK Interpretation Acquire mic gain. "0", "20", "26" or "32" is returned. "32" mea sn 32 dB. Allowed users admin, operator, user Setting Mic Gain for VN-V26 Format /api/param?audio.
Specify "on", "off" or "restart". By "restart", changes to alarm action and alarm trigger are enabled. By "on" after "restart", the alarm action starts working with the changed settings.
When sending via UDP is specified, udpto, IP address, port number and the character string to be sent will be returned. Segments are indicated by /. Example of Response application.
Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify obje ct01. If none is specified instead of object01, JPEG is not attached to the mail.
Specify pinout, distinction between make/break (m1 or b1) and the time (millisec ond) when alarm output is specified. Segments are indicated by /. The time is 0 or from 100 to 5000. When the time is 0, alarm output doe s not come back to previous state.
range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. 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.
Format /api/param?application.event(Number).filter(WeekOfDay).type Example When Getting Type of Sunday filter of Alarm No. 1 /api/param?application.event(1).filter(sunday).type Example of Response application.event(1).filter(sunday).type=mask&200 OK Interpretation Acquire filter type of the alarm ac tion for the specified alarm number.
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.
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.
Allowed users admin, operator, user Setting SMTP Server Port Number for VN -V25/26 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.
Setting "POP before SMTP" for VN-V25 /26 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.
Getting POP Server User Name Setting from VN-V2 5/26 Format /api/param?application.pop.user Example of Response application.pop.user=somename&200 OK Response example when setting field is left bla nk application.pop.user=&200 OK Interpretation Acquire the user name setting of the POP server.
Getting FTP Server Address Setting fro m VN-V25/26 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 server address setting used for FTP transmission via alarm.
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 alarm.
File Name Example Camera.jpg Allowed users admin, operator Setting File Naming of Periodic FTP for VN-V25/26 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.
File Name Example Camera_20060207201315001.jpg When /api/param?application.ftp.naming_option is set to "type2", the file name is as ***.jpg a nd "***" can be set by this API.
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 returned value is 0, it means infinite output. Allowed users admin, operator, user Setting Alarm Output Time for VN-V25/26 Format /api/param?peripheral.
Example of response camera.private_mask.status=on&200 OK Interpretation Acquire the on/off status of privacy masking. Allowed users admin, operator, user Setting Privacy Masking to On/Off for VN-V2 5/26 Format /api/param?camera.private_mask.status=data Example of Response camera.
Setting Motion Detect to On/Off for VN-V2 5/26 Format /api/param?camera.detection.status=data Example of Response camera.detection.status&202 Accepted(camera.status=save) Interpretation Change the on/off status of motion detect. The change is saved by the API, camera.
camera.detection.area=01000000000000000080 Allowed users admin, operator, user Setting Motion Detect Mask for VN-V25/26 Format /api/param?camera.detection.area=data Example /api/param?camera.detection.area=00010203040506070809 Example of response camera .
Example of Response network.interface.dhcp.status&202 Accepted(network.interface.status=restart) Interpretation Change the DHCP setting. Specify "on" or "off". To validate the change, use "network.interface.status=restart" API that reboots VN-V25/26 in about 1 minute.
Allowed user admin Getting Default Gateway from VN-V25/26 Format /api/param?network.gateway Example of Response network.gateway=192.168.0.254&200 OK Interpretation Acquire the current default gateway. Allowed users admin, operator, user Setting Default Gateway for VN-V25/26 Format /api/param?network.
Interpretation Acquire the on/off status of the DNS server. Either on or off will be returned. Allowed users admin, operator, user Setting DNS Server Status to On/Off, o r Validate Changes for VN-V25/26 Format /api/param?network.dns.status=data Example /api/param?network.
Getting TOS Value of JPEG from VN-V25 /26 Format /api/param?network.interface.dscp.video.jpeg Example of Response network.interface.dscp.video.jpeg=56&200 OK Interpretation Acquire TOS that includes DHCP field for JP EG. Allowed users admin, operator, user Setting TOS Value of JPEG for VN-V25 /26 Format /api/param?network.
Interpretation Acquire TOS that includes DHCP field for Audio. Allowed users admin, operator, user Setting TOS Value of Audio fo r VN-V26 (VN-V26 Only) Format /api/param?network.interface.dscp.audio=data Example /api/param?network.interface.dscp.audio=56 Example of Response network.
Example of Response network.interface.ttl.multicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of multicast. The range of se t value is between 1 to 255. To validate the change, use "network.interface.status=restart" API.
Allowed user admin 6.11. Protocol The APIs below are related to protocol. These are equivalent to the features on the Protocol pa ge of the WEB setting page. Refer to the instruction manual for details on the Protocol page. Getting Port Number of HTTP from VN-V25/26 Format /api/param?network.
Example /api/param?network.destination(1).status=start Example of Response network.destination(1).status&200 OK Interpretation Start/stop JPEG multicast stre aming, or save changes to multicast streaming settings. Specify "start", "stop" or "save".
"network.destination(1).host=save" API. After the save, start streaming by "network.destination(1).host=start" API. Allowed user admin Getting Frame Rate of JPEG Multicas t from VN-V25/26 Format /api/param?network.destination(1).framerate Example of Response network.
Getting MPEG-4 Multicast Address from VN-V25 /26 Format /api/param?network.destination(2).host Example of Response network.destination(2).host=225.0.1.2&200 OK Interpretation Acquire MPEG-4 multicast address. Allowed users admin, operator Setting MPEG-4 Multicast Address for VN-V25 /26 Format /api/param?network.
Allowed users admin, operator Setting Status of Audio Multica st Streaming, or Save Changes for VN-V26 (VN-V26 Only) Format /api/param?network.destination(3).status=data Example /api/param?network.destination(3).status=start Example of Response network.
Format /api/param?network.destination(3).port=data Example /api/param?network.destination(3).port=59152 Example of Response network.destination(3).port&202 Accepted(network.destination(31).host=save) Interpretation Change audio multicast port number.
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).
"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-V25/ 26 Format /api/param?network.ntp.host Example of Response network.
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-V25/26 Format /api/param?network.
GMT-11 Timezone that is 11 hours earlier tha n the Greenwich Mean Time. GMT-10 Timezone that is 10 hours earlier tha n the Greenwich Mean Time. Hawaii Same timezone as GMT-10 GMT-9:30 Timezone that is 9 hours and 30 minutes earlier than the Greenwich Mean Time.
Japan Same timezone as GMT+9. GMT+10 Timezone that is 10 hours later tha n the Greenwich Mean Time. GMT+10:30 Timezone that is 10 hours and 30 minutes later than the Greenwich Mean Time. GMT+11 Timezone that is 11 hours later tha n the Greenwich Mean Time.
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-V25/26 settings to factory defa ults.
Example of Response camera.identify=off&200 OK Interpretation Acquire LED blinking setting. "on" or "off" is returned. If thie is "on", LED is blinking. Allowed users admin, operator, user Setting LED blinking mode for VN-V2 5/26 Format /api/param?camera.
system.session.sending(01).to.session=http&200 OK system.session.sending(01).from.encode=jpeg&200 OK system.session.sending(01).from.framerate=1&200 OK system.session.sending(01).from.framesize=vga&200 OK In case of MPEG-4, system.session.
Getting Firmware Revisions Format /api/param?system.software.revision Example of Response system.software.revision=1.00&200 OK Interpretation Acquire revisions of the firmware. Allowed users admin, operator, user 6 .20. Others These are APIs of features not found on the WEB setting page.
Example /api/param?application.ftp.mode=active Example of Response application.ftp.mode&200 OK Interpretation Change the mode of FTP server that is used by alarm action. Se t active or passive. Default is active. active mode: Standard mode of FTP server.
3) VN-V26 returns HTTP response. Example HTTP/1.1 200 OK<CRLF> Connection: close<CRLF> Content-type: audio/ulaw<CRLF> Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-V.
Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentic ation is also not necessary. Example GET /api/audio?assured=1&lowdelay=1 HTTP/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Parameter value is indicated using =.
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-V26 Network Camera<CRLF> x-vnv26_response: encode=ulaw&lowdelay=1&assured=1<CRLF><CRLF> 7.4. Restrictions Access restriction VN-V26 has access restriction feature that enables to deny access from a specific IP address.
Example /api/receive?from=network&from.ip=10.0.0.100&from.protocol=tcp_passive&from.ip_translate =on&to=audio Specify the client IP address for from.ip=. When from.ip_translate is set to off, VN-V26 will standby to re ceive audio data from the IP address specified at from.
Timing of Data Sending 512 bytes, or in other words, 64 msec of audio data may be sent during each transmission. Send audio data at intervals as evenly as possible. A part of the data may be lost if audio data exceeding 2 seconds are sent to VN-V26 a t one time.
Specify 30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1, -2, -3, -5, -10, -15, -20, or -30. To specify a frame rate lower than 1fps, use "-". For exmaple, specify -5 for 1/5fps. - DispTitle Set 1 to display Camera ID - DispTimeCode Set 1 to display Time - TimeFormat Set from 0 to 6 to select time format 0: YYYY/MM/DD HH:MM:SS.
</OBJECT> For VN-V26, modify CLASSID and CODEBASE lines as below. CLASSID="CLSID:00706 F54-DA22-419F-B20A-BBE 4E1C4E017" CODEBASE="./v26j.cab #version=1,0,1,0"> (2) Getting Multicast For VN-V25, execute Play method after setting properties below.
} function play_click( ) { JPEGViewer.Play (); } function still_clic k(obj) { if(obj.value== " Play "){ obj.value="Pause"; JPEGViewer.
(4) Seamless Switching Sample code of VisualBasic for switching to 192.168.0.200. Sleep over one fram e is required between methods. VNviewcnt1.Stop Sleep 100 VNviewcnt1.
HEIGHT= 480 CLASSID="CLSID:B5F92E 48-2ABA-48AB-91A9-7B126691FE 2F" CODEBASE="./v25m.ca b#version=1,0,1,0"> <PARAM NAME="Mu ltiIP" VALUE="225.
MPEG4Viewer.Se tStill(1); } } </SCRIPT> <BODY STYLE="font-f amily:sans-serif;" onBeforeUnload="stop_clic k()" onload="p lay_click()"> <font size="6&qu.
The built-in audio client of VN-V25/26 consists of ActiveX control. The ActiveX is availa ble for customized audio client. 11.1. Audio Monitor (1) Properties of ActiveX - StreamType Set 0 for HTTP, se.
} // Control for v olume function moni_mu teOff_click() { Monitor.Volume = monitor_volume*10; } function moni_mu teOn_click() { Monitor.Volume = 0; } function moni_up_ click() { if(monitor_volu me<10) monitor_volume++; Monitor.Volume = monitor_volume*10; } function moni_do wn_click() { if(monitor_volu me >0) monitor_volume --; Monitor.
</OBJECT> <FORM name="myForm"><D IV STYLE=" position: absolute; top:50px; lef t:10px;"> <br> SOUND MONITOR <!-- Cont rols --> <INPUT TYPE="BUT.
(3) HTML Example for audio monitor <HTML> <HEAD> <META HTTP-EQUIV="Cont ent-Type" CONTENT="tex t/html; charset=euc -jp"> <TITLE>V26 Send AUDIO Sample</TITLE> <SCRIPT LANGUAGE ="JavaScript"> // Start audio send ing function play_click () { Sound.
<PARAM NAME="Pa ssword" VALUE="vn-v 2x"> <!-- Pa ssword of operat or --> </OBJECT> <FORM name="myForm"><D IV STYLE=" position: absolute; t.
An important point after buying a device JVC VN-V25U (or even before the purchase) is to read its user manual. We should do this for several simple reasons:
If you have not bought JVC VN-V25U yet, this is a good time to familiarize yourself with the basic data on the product. First of all view first pages of the manual, you can find above. You should find there the most important technical data JVC VN-V25U - thus you can check whether the hardware meets your expectations. When delving into next pages of the user manual, JVC VN-V25U you will learn all the available features of the product, as well as information on its operation. The information that you get JVC VN-V25U will certainly help you make a decision on the purchase.
If you already are a holder of JVC VN-V25U, but have not read the manual yet, you should do it for the reasons described above. You will learn then if you properly used the available features, and whether you have not made any mistakes, which can shorten the lifetime JVC VN-V25U.
However, one of the most important roles played by the user manual is to help in solving problems with JVC VN-V25U. Almost always you will find there Troubleshooting, which are the most frequently occurring failures and malfunctions of the device JVC VN-V25U along with tips on how to solve them. Even if you fail to solve the problem, the manual will show you a further procedure – contact to the customer service center or the nearest service center
