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 information. 2008.1.19.
Updates Version Date Updates 1.00 2007/11/1 First release. 1.01 2007/11/27 1.02 2008/1/19 Model Name in JPEG is corrected from VN-V25 to VN-V25U. Description about disconnect of 11th alarm client is corrected. "boudary" in JPEG stream is deleted. Sample value of gamma is corrected. "type=VN-V25" in MPEG-4 is corrected as "type=VNV25U". APIs of VN-V26U are added.
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 changing VN-V25/26 settings. ● Sending Multicast from VN-V25/26. ● Getting Audio from VN-V26. ● Sending Audio to VN-V26. ● Customization of VN-V25/26's built-in viewer.
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. Getting Audio from VN-V26 via HTTP 8. Sending Audio to VN-V26 via HTTP 9. List of Protocols and Port Numbers Used with VN-V25/26 10. Customizing VN-V25/26's Built-in Viewer 11. Customizing VN-V26's Built-in Audio Client 12.
This document describes APIs of VN-V25/26. Differences of VN-V25 and VN-V26 are as below. Function Low Lux Audio Server Audio Output VN-V25 Easy Day&Night none none VN-V26 B&W Mode (True Day&Night) Mic is embedded Audio Output Terminal 1. Getting JPEG from VN-V25/26 via HTTP 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 HTTP/1.1 Host: 192.168.0.
HTTP Response JPEG (No. 1) JPEG (No. 2) ,,, 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 transmission, connect new TCP, and send API with new parameter. 1.2. API Format Structure GET space API space HTTP/1.
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. Selection range is as follows. 30, 25, 15, 10, 7.
JPEG file from VN-V25/26 is JFIF compliant and consist of the following. Start Code Application Segment Comment Segment 1 Comment Segment 2 (reserved) DHT Huffman Table DQT Quantization Table DRI Restart Interval SOF Frame Information Data Start Segment End Code FFD8 FFE0 FFFE FFFE FFC4 FFDB FFDD FFC0 FFDA FFD9 The following information is stored in the comment segment 1. Each item has a fixed length.
Item names and values, excluding the version information that does not include =, are stored in the following format. name space = space value (stuffed with 0x00) fixed length for each item Example: When width=640, the 13-byte area will be written as follows. w i d t h = 6 4 0 0x00 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. 2) The client sends out API. Example GET /api/video?encode=mpeg4 HTTP/1.
,,, 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 transmission, connect new TCP, and send API with new parameter. 2.2. API Format Structure GET space API space HTTP/1.
Content-Type: video/mp4v-es Date: Tue, 02 Oct 2007 07:33:12 GMT Server: JVC VN-V25 Network Camera x-vnv25_response: encode=mpeg4&framerate=30&framesize=vga 2.4. Restrictions Access restriction VN-V25/26 has access restriction feature that enables to deny access from a specific IP address. If MPEG-4 is requested from the IP address of access restriction, VN-V25/26 disconnects the TCP connection after API is sent.
P-VOP There are VOL, Userdata1, GOV and Userdata2 before each I-VOP.
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 whether motion has been detected. peripheral.input_pin.pin(1).status=break peripheral.input_pin.pin(2).status=break video.input(1).detection(motion).
Example GET /api/param?network.interface.subnetmask HTTP/1.1 Accept: text/plain Host: 192.168.0.2 Authorization: Basic YWRtaW46dm4tdjJ4 Specify the response format by Accept line. Plain text response is returned when this is specified as text/plain. HTML response is returned when text/html is specified. HTML response is returned when Accept is not specified. These APIs for getting/setting parameters are protected by basic authentication.
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 the format below when getting a parameter from VN-V25/26. /api/param?ParamA.ParamB.ParamC It is possible to get multiple parameters at a time. Connect parameters with &. Do not insert space before and after &.
/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 acquired at a time. ● Response will be in the following format. ParamA.ParamB.ParamC&200 OK An error code will be returned when setting is not properly performed. Example: ParamA.ParamB.
Example of response camera.id=Camera01&200 OK Sender Camera01 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=%00 Example of response camera.id&202 Accepted(camera.status=save) Interpretation Change the camera ID stored in comment segment of JPEG. Maximum size is 40 bytes. To set as blank, specify as %00(0x25, 0x30, 0x30).
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 between 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 Black level for VN-V25/26 Format /api/param?camera.image.pedestal=data Example of setting a value /api/param?camera.image.
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. Allowed users admin, operator, user Setting Enhance Band for VN-V25/26 Format /api/param?camera.image.enhance.band=data Example of setting a value /api/param?camera.image.enhance.
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/26 Format /api/param?camera.image.color=data Example of setting a value /api/param?camera.image.color=50 Example of 1 step change /api/param?camera.image.color=+ Example of response camera.image.
Allowed users admin, operator, user Setting Limit of Sense Up for VN-V25/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. Specify 0, 2, 4, 8, 16, 32, 62, "+" or "-". It becomes bigger 1 step by specifying "+", smaller 1 step by specifying "-". The change is saved by the API, camera.status=save.
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.status=save) Interpretation Change shutter speed setting. Specify "auto", 30, 50, 60, 100, 250, 500, 1000, 2000, 4000, 10000 or "flickerless", "+" or "-". To set 1/60 for example, specify 60.
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. Specify "color", "bw", "autoH", "autoM" or "autoL". "color" enables IR filter and image becomes color. "bw" disables IR filter and image becomes black and white.
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. Specify "auto" or "manual". If "op_auto" is specified, one push auto white balance control is done, and setting becomes "manual". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
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 Compensation from VN-V25/26 Format /api/param?camera.image.blc Example of response camera.image.blc=off&200 OK Interpretation Acquire Back Light Compensation setting. "off", "a", "b", "c" or "d" is returned.
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).framesize=qvga Example of response encode(1).framesize&202 Accepted(encode(1).status=save) Interpretation Change JPEG frame size. Specify "vga" or "qvga". File size setting is changed automatically when frame size is changed.
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(1).quality&202 Accepted(encode(1).status=save) Interpretation Change the file size setting of JPEG. The unit of set values is in KB. VN-V25/26 will perform rate control with this file size as the target.
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 they 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 bitrate Setting from VN-V25/26 Format /api/param?encode(2).bitrate Example of response encode(2).
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 Interpretation Acquire frame rate of MPEG-4 encoding. Allowed users admin, operator, user Setting MPEG-4 Frame Rate Setting for VN-V25/26 Format /api/param?encode(2).framerate=data Example /api/param?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. "motion" or "quality" is returned. Allowed users admin, operator, user Setting MPEG-4 Priority Setting for VN-V25/26 Format /api/param?encode(2).priority=data Example /api/param?encode(2).priority=motion Example of response encode(2).priority&202 Accepted(encode(2).status=save) Interpretation Change priority of MPEG-4.
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/param?audio.input(1).gain=data Example /api/param?audio.input(1).gain=32 Example of response audio.input(1).gain&200 OK Interpretation Change mic gain. Specify "0", "20", "26" or "32". "32" measn 32 dB. Allowed users admin, operator 6.5.
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 alarm trigger, APIs to get settings of alarm action and alarm trigger return previous values. Allowed users admin, operator Getting Alarm Action from VN-V25/26 Format /api/param?application.event(Number).action Example When Getting action of alarm action No.
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 make/break (m1 or b1) and output time (millisecond) will be returned. Segments are indicated by /. Example of Response application.event(1).action=pinout/m1/1500&200 OK B&W mode is available for VN-V26.
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. Number of the character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
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).action=pinout/m1/1500 B&W mode is available for VN-V26. Specify true_daynight/bw, true_daynight/color, true_daynight/autoH, true_daynight/autoM or true_daynight/autoL when B&W mode is specified.
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.event(Number).status=restart. Allowed users admin, operator Getting Alarm Filter Time from VN-V25/26 Format /api/param?application.event(Number).filter(WeekOfDay).
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 action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6.
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. 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 filter OFF. (VN-V26 Only) ncbwe will be returned for IR filter ON.
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. The example above indicates that trigger will be activated when break is invoked at alarm input 2 within 50 seconds after make is invoked at alarm input 1.
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 users admin, operator Getting Sender Mail Address Setting from VN-V25/26 Format /api/param?application.smtp.mailfrom Example of Response application.smtp.mailfrom=somebody@somecompany.
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 to off and "pbs" when setting to on. Allowed users admin, operator Getting POP Server Address Setting from VN-V25/26 Format /api/param?application.pop.host Example of Response application.pop.host=192.168.0.
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. The user name is used as local part of sender mail address when sender mail address setting is blank. When the user name is blank, the local-part is set to "vn_c20". Example of Response application.pop.
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 FTP transmission via alarm. Allowed users admin, operator, user Setting FTP Server Address for VN-V25/26 Format /api/param?application.ftp.host=data Example /api/param?application.ftp.host=10.0.0.
Format /api/param?application.ftp.user Example of Response application.ftp.user=somename&200 OK Response example when setting field is left blank application.ftp.user=&200 OK Interpretation Acquire the FTP server user name setting used for FTP transmission via alarm. Allowed users admin, operator Setting FTP Server User Name for VN-V25/26 Format /api/param?application.ftp.user=data Example /api/param?application.ftp.user=somename Example of Response application.ftp.
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. Specify "default", "type1" or "type2". When default is set, the file name is as YYYYMMDDHHMMSS-NNN-2.jpg. Example 20060207201315-001-2.jpg When type1 is set, the file name is as ***YYYYMMDDHHMMSSNNN.jpg.
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-V25/26 Format To get Frame Rate /api/param?application.object.framerate To get Pre Duration /api/param?application.object.prerec To get Post Duration /api/param?application.object.
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 Format /api/param?peripheral.input_pin.pin(Number).duration=data Example /api/param?peripheral.input_pin.pin(1).duration=50 Example of response peripheral.input_pin.pin(1).
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.status&202 Accepted(camera.status=save) Interpretation Change the on/off status of privacy masking. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
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 not saved, the setting is restored by reboot. Allowed users admin, operator Getting Motion Detect Sensitivity from VN-V25/26 Format /api/param?camera.detection.level Example of response camera.detection.
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=save) Interpretation Change the motion detect mask. Specify using a 20 ASCII character string. Refer to the item on "Getting Motion Mask from VN-V25/26" on the interpretation of this character string.
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 IP Address from VN-V25/26 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 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.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 gateway, disable DHCP.
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 Response network.dns.status&200 OK Interpretation Change status of DNS server setting, or validate changes to DNS server settings. Specify "on", "off" or "restart".
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 JPEG. Allowed users admin, operator, user Setting TOS Value of JPEG for VN-V25/26 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.
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.audio&202 Accepted(network.interface.status=restart) Interpretation Change TOS that includes DHCP field for Audio. The range of set value is between 0 to 255 though MSB 6 bits in the value is valid.
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 VN-V25/26 Format /api/param?network.interface.mtu Example of Response network.interface.mtu=1420&200 OK Interpretation Acquire the MTU value.
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.port Example of Response network.http.port=80&200 OK Interpretation Acquire port number of HTTP server in 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 streaming settings become valid by "save". Multicast stream is RTP compliant. If power becomes off during multicast streaming, the streaming starts automatically after power on.
"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).framerate=10&200 OK Interpretation Acquire JPEG multicast frame rate. Allowed users admin, operator Setting Frame Rate of JPEG Multicast for VN-V25/26 Format /api/param?network.destination(1).
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.destination(2).host=data Example /api/param?network.destination(2).host=225.0.1.2 Example of Response network.destination(2).host&202 Accepted(network.destination(2).
Allowed users admin, operator Setting Status of Audio Multicast 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.destination(3).status&200 OK Interpretation Start/stop audio multicast streaming, or save changes to multicast streaming settings. Specify "start", "stop" or "save". Changes of multicast streaming settings become valid by "save".
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 change, use "network.destination(3).host=save" API. After the save, start streaming by "network.destination(3).host=start" API. Allowed user admin 6.13.
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&200 OK Allowed users admin, operator Setting IP Address of Restricted Client for VN-V25/26 Format /api/param?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.ntp.host=10.0.0.100&200 OK Interpretation Acquire IP address of NTP server. Either the IP address or FQDN will be returned. Allowed users admin, operator, user Setting NTP Server Address for VN-V25/26 Format /api/param?network.ntp.host=data Example /api/param?network.ntp.
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 Example of Response network.ntp.unit&202 Accepted(network.ntp.status=restart) Interpretation Change the unit of interval for accessing the NTP server. Specify "min", "hour" or "day". To validate the change, use "network.ntp.
GMT-11 GMT-10 Hawaii GMT-9:30 GMT-9 Alaska GMT-8 Pacific GMT-7 Arizona Mountain GMT-6 Central GMT-5 East-Indiana Eastern GMT-4 Atlantic GMT-3:30 GMT-3 GMT-2 GMT-1 UTC London GMT+1 Berlin Rome Madrid Paris CET GMT+2 EET GMT+3 GMT+3:30 GMT+4 GMT+4:30 GMT+5 GMT+5:30 India GMT+5:45 GMT+6 GMT+6:30 GMT+7 GMT+8 GMT+8:45 GMT+9 GMT+9:30 Timezone that is 11 hours earlier than the Greenwich Mean Time. Timezone that is 10 hours earlier than the Greenwich Mean Time.
Japan GMT+10 GMT+10:30 GMT+11 GMT+11:30 GMT+12 GMT+12:45 Same timezone as GMT+9. Timezone that is 10 hours later than the Greenwich Mean Time. Timezone that is 10 hours and 30 minutes later than the Greenwich Mean Time. Timezone that is 11 hours later than the Greenwich Mean Time. Timezone that is 11 hours and 30 minutes later than the Greenwich Mean Time. Timezone that is 12 hours later than the Greenwich Mean Time. Timezone that is 12 hours and 45 minutes later than 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 defaults. Upon doing so, all transmission services that are in progress will be terminated. Initializing takes a few minutes. Response is returned after initializing. Do not power off during initializing.
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 Example /api/param?camera.identify=on Example of Response camera.identify&202 Accepted(camera.status=save) Interpretation Change LED blinking setting. Specify "on" or "off". If "on" is set, LED starts blinking.
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 case of multicast, system.session.sending(01).to.ip becomes multicast IP address. Interpretation Acquire the sending status of 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 VN-V25/26 Format /api/param?system.status=restart Example of Response system.status&200 OK Interpretation Restarts VN-V25/26.
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 data is established from 20 port of FTP server to 10020 port of VN-V25/26. passive mode: TCP connection for data is established from VN-V25/26 to FTP server. Port number depends on FTP server.
3) VN-V26 returns HTTP response. Example HTTP/1.1 200 OK Connection: close Content-type: audio/ulaw Date: Tue, 02 Oct 2007 07:33:12 GMT Server: JVC VN-V26 Network Camera x-vnv26_response: encode=ulaw&lowdelay=1&assured=1 4) VN-V26 sends out audio data after returning HTTP response. Audio data with 12 bytes header will be sent out continuously after HTTP response. HTTP Response and audio data sent out by VN-V26 are as follows.
GET space API space HTTP/1.1 Host: space IP Address of VN-V26 0x0D 0x0A 0x0D 0x0A 0x0D 0x0A 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 Host: 192.168.0.2 Parameter value is indicated using =. Do not insert space before and after =. Example assured=1 Parameters are segmented using &. Do not insert space before and after &.
Date: Tue, 02 Oct 2007 07:33:12 GMT Server: JVC VN-V26 Network Camera x-vnv26_response: encode=ulaw&lowdelay=1&assured=1 7.4. Restrictions Access restriction VN-V26 has access restriction feature that enables to deny access from a specific IP address. If audio is requested from the IP address of access restriction, VN-V26 disconnects the TCP connection after API is sent. Restriction by maximum bitrate of VN-V26 The maximum bitrate of VN-V26 is about 20 Mbps.
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.ip_translate is set to on, VN-V26 will ignore from.ip and standby to receive audio data from the source IP address of this API. 2) VN-V26 returns a response. HTTP/1.
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 Used with VN-V25/26 VN-V25/26 uses the following protocols and port numbers.
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.
For VN-V26, modify CLASSID and CODEBASE lines as below. CLASSID="CLSID:00706F54-DA22-419F-B20A-BBE4E1C4E017" CODEBASE="./v26j.cab#version=1,0,1,0"> (2) Getting Multicast For VN-V25, execute Play method after setting properties below.
(4) Seamless Switching Sample code of VisualBasic for switching to 192.168.0.200. Sleep over one frame is required between methods. VNviewcnt1.Stop Sleep 100 VNviewcnt1.IP = "192.168.0.200" Sleep 100 VNviewcnt1.Play 10.4. HTML Example for MPEG-4 viewer (1) Getting MPEG-4 at display size QVGA For VN-V25, execute Play method after setting properties below. For VN-V26, modify CLASSID and CODEBASE lines as below. CLASSID="CLSID:44AAD243-8BCF-44E8-9EC5-2C3C746CFCAF" CODEBASE="./v26m.
MPEG4Viewer.SetStill(1); } }
SAMPLE TEXT
} // Control for volume function moni_muteOff_click() { Monitor.Volume = monitor_volume*10; } function moni_muteOn_click() { Monitor.Volume = 0; } function moni_up_click() { if(monitor_volume<10) monitor_volume++; Monitor.Volume = monitor_volume*10; } function moni_down_click() { if(monitor_volume >0) monitor_volume--; Monitor.Volume = monitor_volume*10; } // Initialize the screen to hide it function init_page(){ document.getElementById("Monitor").style.
