Page 2 - Updates; Version
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 client is corrected. 1.02 2008/1/19 "boudary" in JPEG stream is deleted.Sample value of gamma is corrected."type=VN...
Page 3 - Custom Application Software Development Guide; Sending
Custom Application Software Development 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. ● Getting Alarm from VN-V25/26. ● Getting or...
Page 4 - Content
Content 1. Getting JPEG from VN-V25/26 via HTTP2. Getting MPEG-4 from VN-V25/26 via HTTP3. API to Search VN-V25/264. Getting Alarm from VN-V25/26 via TCP5. Using API that Requires Basic Authentication6. API for Getting/Changing Parameters of VN-V25/267. Getting Audio from VN-V26 via HTTP8. Sending A...
Page 5 - ) The client establishes a TCP connection to port number 80.; Example
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. Getting JPEG from VN-V25/26 via HTTP ...
Page 6 - Details of JPEG file format is explained later.; Example framerate=1; GET
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. To change parameter, disconnect current TCP to stop the JPEG transmissio...
Page 7 - Parameter Description; encode; indicates actual parameter.; Access restriction; the instruction manual for detailed information.
Parameter Description encode For specifying compression format. For example, specify as encode=jpeg to get 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. Selectio...
Page 9 - name; HTTP Response
Item names and values, excluding the version information that does not include =, are stored in the following format. 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 po...
Page 10 - Details of MPEG-4 stream is explained later.
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. To change parameter, disconnect current TCP to stop the MPEG-4 transmissi...
Page 11 - instruction manual for detailed information.; Example of MPEG-4 stream
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.4. Restrictions Access restriction VN-V25/26 has access restriction featur...
Page 12 - Data Structure before I-VOP; Userdata1; Data Structure of Userdata2; Protocol; ) The client establishes a TCP connection to port number 32040.
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 Data Structure of Userdata2 Item Example Note Start Code 0x000001B2 Start code of userdata in MPEG-4 Video P...
Page 13 - ) The client can disconnect TCP32040 to end the alarm acquisition.; Maximum number of clients; Using API that Requires Basic Authentication
2) When motion is detected from the video image of VN-V25/26, or when there are changes to the alarm input (make or break), VN-V25/26 will send out alarm information in the following format. The first 2 lines indicate the current alarm input status (make or break). The following 1 line indicates whe...
Page 14 - string and enter this in the Authorization line.
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 as te...
Page 15 - explained in this section in the way as mentioned in Section 5; be
6. API for Getting/Changing Parameters of VN-V25/26 This section provides description of APIs for getting/changing parameters of VN-V25/26. Make use of the API explained in this section in the way as mentioned in Section 5 . 6.1. General (1) Getting parameter ● Specify API in GET line according to t...
Page 16 - Saving Changes of Camera Settings; changes to camera settings are restored.; Getting Camera ID stored in JPEG from VN-V25/26; ID is used as sender's display name of alarm mail. If you want to; Setting Sender
/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 can be set at a time is 15. Status settings, i.e. network.interface.status, network.dns.status, network.ntp.status, etc., can not be acquir...
Page 17 - ee; Example of setting; enhance band setting and gamma setting are ignored.
Example of response camera.id=Camera01&200 OK Sender Camera 01<[email protected]> 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.id=%0...
Page 19 - Acquire enhance band setting. Value of enhance band is high or low.
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 igno...
Page 20 - numbers mean frame number of sense up.
Example of response camera.image.color=50&200 OK Interpretation Acquire color level value. Range of color level is between 0 to 100. The value 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...
Page 23 - Getting Auto Exposure Reference from VN-V25/26; image becomes brighter.; Setting Auto Exposure Reference for VN-V25/26; setting is restored by reboot.
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. Speci...
Page 25 - change is not saved, the setting is restored by reboot.; Saving Changes of Encode Settings for VN-V25/26
Interpretation Change B-gain white balance setting. Specify 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. Allowed users admin, operator Getting Back Light...
Page 26 - not same, compression on QVGA can have privacy masking.; Getting JPEG Rate Control Setting from VN-V25/26; files remains constant.; Getting JPEG File Size Setting from VN-V25/26
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).framesize=data Example /api/param?encode(1).frames...
Page 27 - Setting JPEG File Size Setting for VN-V25/26
Interpretation Acquire the file size setting of JPEG. If the response 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).quality=30k Example of response encode...
Page 29 - become I-Frame and frame rate becomes 30fps.
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).framerate=15&200 OK Interpretat...
Page 31 - Setting Mic Gain for VN-V26; When Getting the on/off status of alarm action No. 1
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" measn 32 dB. Allowed users admin, operator, user Setting Mic Gain for VN-V26 Format /api/para...
Page 32 - When Getting action of alarm action No. 1; OK; status of the alarm action.
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. If "restart" is not set after changes to alarm action and...
Page 33 - When setting action of Alarm No. 1; ssage; used to set the alarm action to off.
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.event(1).action=udpto/10.0.0.100/20000/Message&200 OK When alarm output is specified, pinout, distinction between m...
Page 34 - Setting Example; Setting Example; space; Setting Example
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 object01. If none is specified instead of object01, JPEG is not attached to the mail....
Page 35 - Getting Alarm Filter Setting from VN-V25/26; When Getting Setting of Sunday filter of Alarm No. 1
Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) 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 does not come back to previous state. Setting Example /api/param?application.event(1)....
Page 39 - Getting SMTP Server Address Setting from VN-V25/26; Acquire the address setting of the SMTP server.; Setting SMTP Server Address for VN-V25/26; Acquire the port number setting of the SMTP server.
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. T...
Page 40 - Setting SMTP Server Port Number for VN-V25/26; Change the port number setting of the SMTP server.; Getting Sender Mail Address Setting from VN-V25/26; Alphanumeric and followings are available.
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. Allowed us...
Page 41 - Getting POP Server Address Setting from VN-V25/26; Acquire the address setting of the POP server.; Getting POP Server Port Number Setting from VN-V25/26; Acquire the port number setting of the POP server.; Setting POP Server Port Number for VN-V25/26; Change the port number setting of the POP 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. Specify as "simple" when setting t...
Page 42 - Setting POP Server Password for VN-V25/26; follows when this is to be left blank.
Getting POP Server User Name Setting from VN-V25/26 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. T...
Page 43 - Getting FTP Server Address Setting from VN-V25/26; to leave the setting field blank as follows.; Getting FTP Server Path Setting from VN-V25/26
Getting FTP Server Address Setting from 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 blank application.ftp.host=&200 OK Interpretation Acquire the FTP server address setting used for...
Page 46 - to Pre and Post duration is invalid.; Getting Alarm Output Time Setting from VN-V25/26
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.jpg Allowed users admin, operator Getting Parameters of Pre/Post Recording from VN-V2...
Page 47 - Getting Alarm Output Status from VN-V25/26
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-V25/26 ...
Page 48 - Getting Privacy Masking Color from VN-V25/26; Acquire the on/off status of motion detect.
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-V25/26 Format /api/param?camera.private_mask.status=data Example of Response camera.private_mask.stat...
Page 49 - the change is not saved, the setting is restored by reboot.; Getting Motion Detect Sensitivity from VN-V25/26; value, the higher will be the sensitivity.; Setting Motion Detect Sensitivity for VN-V25/26; Getting Motion Detect Mask from VN-V25/26
Setting Motion Detect to On/Off for VN-V25/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.status=save. If the change is...
Page 50 - the setting is restored by reboot.; Enabling Network Setting Changes; Changes of f
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 .detection.area&202 Accepted(camera.status...
Page 53 - Getting DNS Server IP Address from VN-V25/26; Acquire IP address of DNS server.; Setting DNS Server IP Address for VN-V25/26
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, or Validate Changes for VN-V25/26 Format /api/param?network.dns.status=data Example /api/param?network.dns.status=on Example of Resp...
Page 55 - Getting Multicast TTL Value from VN-V25/26
Interpretation Acquire TOS that includes DHCP field for Audio. Allowed users admin, operator, user Setting TOS Value of Audio for 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.interface.dscp.aud...
Page 56 - Getting Network Negotiation Setting from VN-V25/26
Example of Response network.interface.ttl.multicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of multicast. The range of set value is between 1 to 255. To validate the change, use "network.interface.status=restart" API. Allowed user admin Getting MTU Value ...
Page 57 - admin; Getting Port Number of HTTP from VN-V25/26; Change; Getting Status of JPEG Multicast Streaming from VN-V25/26
Allowed user admin 6.11. Protocol The APIs below are related to protocol. These are equivalent to the features on the Protocol page 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.http.por...
Page 58 - Multicast stream is RTP compliant.; Getting JPEG Multicast Address from VN-V25/26; Acquire JPEG multicast address.; Setting JPEG Multicast Address for VN-V25/26; Getting JPEG Multicast Port Number from VN-V25/26; Acquire JPEG multicast port number.; Setting JPEG Multicast Port Number for VN-V25/26
Example /api/param?network.destination(1).status=start Example of Response network.destination(1).status&200 OK Interpretation Start/stop JPEG multicast streaming, or save changes to multicast streaming settings. Specify "start", "stop" or "save". Changes of multicast str...
Page 59 - Getting Frame Rate of JPEG Multicast from VN-V25/26; Acquire JPEG multicast frame rate.; Setting Frame Rate of JPEG Multicast for VN-V25/26
"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 Multicast from VN-V25/26 Format /api/param?network.destination(1).framerate Example of Response network.destination(1).fra...
Page 62 - Getting Deny/Allow Setting of Client Restrictions from VN-V25/26; restrictions are applied to getting JPEG.; Getting IP Address Setting of Restricted Client from VN-V25/26; When Getting the first IP address
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. Specify from 2 to 65534. To validate the chan...
Page 63 - instead of IP address is set.; Setting IP Address of Restricted Client for VN-V25/26; When setting the first IP address
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).host(1)=somedivision.somecompany.com&a...
Page 65 - Setting Access Interval Unit of SNTP for VN-V25/26; second are denoted in 2-digit decimal numbers.
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.ntp.unit=data Example /api/param?network.ntp.unit=day...
Page 67 - Japan
Japan Same timezone as GMT+9. GMT+10 Timezone that is 10 hours later than 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 than the Greenwich Mean Time. GMT+11:30 Timezone that is 11 hours and 30 mi...
Page 68 - Initialization; off during initializing.; Firmware Update; the WEB setting page.
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 defaults. Upon doing so, all transmission services th...
Page 69 - Getting Sending Status; out in the following examples.
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-V25/26 Format /api/param?camera.identify=data Exam...
Page 70 - Getting Log; Number of seconds after startup, Alarm input, Motion detect, Error; system alive time: 2142sec; Getting Model Name; Acquire the model name.
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.sending(01).from.encode=mpeg4 is returned. In...
Page 71 - Getting Firmware Revisions; Acquire revisions of the firmware.; Getting Alarm Input Status from VN-V25/26
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. Restart...
Page 72 - Getting Control Port Number of FTP Server from VN-V25/26; plus one is the port number for control.; Setting Control Port Number of FTP Server for VN-V25/26; number for data plus one is the port number for control.
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. Set active or passive. Default is active. active mode: Standard mode of FTP server. Also called PORT mode. TCP connection for ...
Page 73 - ) VN-V26 sends out audio data after returning HTTP response.
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-V26 Network Camera<CRLF> x-vnv26_response: encode=ulaw&lowdelay=1&assured=1<CRLF>...
Page 74 - assured; Recent; lowdelay; transmission overhead will be enhanced. Default value is 1.
Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication 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 =. Do not insert space before and aft...
Page 76 - Restrictions on Number of Clients; Time stamp in 8kHz
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 receive audio data from the IP address specified at from.ip. When from...
Page 77 - Timing of Data Sending; Protocol / Port Number
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 at one time. 9. List of Protocols and Port Numbers ...
Page 78 - For VN-V25, execute Play method after setting properties below.
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 ...
Page 83 - - Reload of ActiveX is required to change Multicast property.
MPEG4Viewer.SetStill(1); } } </SCRIPT> <BODY STYLE="font-family:sans-serif;" onBeforeUnload="stop_click()" onload="play_click()"> <font size="6"> SAMPLE TEXT </font><br> <OBJECT ID= MPEG4Viewer" WIDTH = 641 HEIGHT= 481 CLASSID="...
Page 87 - // Terminate the ActiveX when this HTML is closed
(3) HTML Example for audio monitor <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=euc-jp"> <TITLE>V26 Send AUDIO Sample</TITLE> <SCRIPT LANGUAGE="JavaScript"> // Start audio sending function play_click() { Sound.P...
Page 88 - (1) Low Frame rate due to long delay of network; Causes of Low Frame Rate
<PARAM NAME="Password" VALUE="vn-v2x"> <!-- Password of operator --> </OBJECT> <FORM name="myForm"><DIV STYLE=" position:absolute; top:50px; left:10px;"> <br> SOUND SEND <!-- Controls --> <INPUT TYPE="BUTTON" VALUE=...