JVC 157WP manual

IP Camera API GUIDE VN-H37/ 137/2 37/237VP VN-H57/ 157WP/2 57/25 7VP This document provides info rmation of protocol and API of JVC new IP cameras, VN-H series. Specifications subject to change without not ice. 2012.06.29. (V4.00) © 2012 JVC K EN W OOD Corp oration[...]

Updates Version Date Updates 1.00 2012/1/31 New release 1.01a 2012/02/23 Corrections of typographica l error Page 5, section 2.1: chang e boundar y to server_push Page 6, section 2.2: chang e boundar y to server_push Page 14, Gett ing Enhance of Scene F ile: change 11 internal leve ls to 14 internal levels. Page 15, Sett ing Enhance of Scene File: [...]

Version Date Updates 2.01 2012/05/08 Page 5, “JVC A PI for Audio ” is added. Page 5, “Getti ng Audio fro m the Camera via HT TP” is added. Page 5, “Sendi ng Audio to t he Camera” is added. Page 33, sectio n 10, JVC A PI for Audio is a dded. Page 36, sectio n 11, Gettin g and Setting Alarm Action: “audiopla y” and “pinout” are ad[...]

Preface This document is for VMS to support JVC new cameras, VN -H37/137/237. If VMS supports only streaming, i.e. VM S does not have camera setting pages, the chapte r "Streaming Protocol" provides how to get strea m from a camera. If VMS hav e setting page of the camera , focusing on nece ssary functional ities is recommended. Typi cal [...]

Content 1. Streaming Pr otocol 2. JVC Protoc ol: JPEG Str eaming 3. JVC Protoc ol: H.264 Str eaming 4. JVC Protoc ol: MPEG-4 Streaming 5. RTSP/RTP 6. API to Search Camera 7. Using A PI that Requires Basic A uthentication 8. JVC A PI for Camera 9. JVC A PI for Encode 10. JVC A PI for A udio (VN-H57/157WP/2 57/257VP) 11. JVC A PI for Al arm 12. JVC A[...]

35. PSIA 36. FAQ[...]

1. Streaming Protoc ol - Both JVC pr otocol and sta ndard RTS P/RTP are sup ported. - JPEG, H.264 baseline pr ofile, and H.26 4 high profile are supported. M PEG-4 wi ll be supporte d in future. - Maxim um resolution is 19 20x1080. - VN-H series ca n send 3 d ifferent resolu tion stream s of J PEG sim ultaneously. - VN-H series ca n send 3 d iffere[...]

4) When the client wants to stop curren t JPEG transmission, the client disconnects TCP80. The camera does not accept further API via current TCP that is used for JPEG transmission. To change parameter, disconnect current TCP to stop the JPEG transm ission, connect new TCP, and send API with new parameter. 2.2. A PI Format Structure Unlike APIs for[...]

structured JPEG. When framerate=0 is specified, Server Push is disabled even i f server_push=on is specified. 2.3. Response When API with server_push=on is successfully received. The camera will return 200 OK. The x-vnh37_respo nse line indicates actual parameter. Example of VN-H137 HTTP/1.1 200 OK<CRLF> Content-Type: multipart/x-mixed-replac[...]

Refer the instruction manual for detailed infomation. 2.5. JPEG File Format Sent Out by the came ra JPEG file from the camera is JFIF compliant a nd consist of the following. FFD8 Start Code FFE0 Application Segment FFFE Comment Segment 1 FFFE Comment Segment 2 (reserved) FFC4 DHT Huffman Table FFDB DQT Quantization Table FFDD DRI Restart Interval [...]

Example: W hen width=640, the 13-byte area w ill be written as follows. 3. JVC Protocol: H.2 64 Streaming 3.1. Basic Procedures 1) The client establishes a TCP connection to port num ber 80. 2) The client sends out API. Example to get H.264 high profile st ream encoded b y first chan nel of the ca mera GET /api/video?encode=h264(1) HT TP/1.1<CRL[...]

Unlike APIs fo r g etting/setting p arameters, Accept line is not requi red. Basic a uthentication i s also no t necessary. Example GET /api/video?encode=h264(1) HT TP/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Parameter value is indicated using =. Do not insert space before and after =. Example encode=h264(1) Parameter Description e[...]

H.264 str eam form the camera is sequence o f I Pi cture and P Pi cture. Ratio of I Picture a nd P Picture depends o n I-Frame interval setting. Encode page of W eb has the setting. Example of H.264 Stream HTTP response Sequence Parameter Set Picture Parameter Set User data I Picture User data P Picture ~ User data I Picture There are Se quence Par[...]

Pan position 16 digipan = 123 Indicates pan p osition in pi xels from 0 to 1278. Tilt position 17 digitilt = 123 Indicates tilt pos ition in p ixels from 0 to 9 58. Zoom pos ition 17 digi zoom = 1.23 Ind icates zoom value from 1.00 to 8.00. Preset Posision Number 15 position = 19 Indi cates prese t position n um ber after moving to preset position [...]

Unlike APIs fo r g etting/setting p arameters, Accept line is not requi red. Basic a uthentication i s also no t necessary. Example GET /api/video?encode=mpeg4 HTT P/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Parameter value is indicated using =. Do not insert space before and after =. Example encode=h264 Parameter Description encode[...]

Ratio of I-VOP and P-VOP depends on I-Frame inte rval setting. Encode page of Web has the setting. First VOP can be I-VOP or P-VOP. If clie nt want to decode from I-VOP, please skip P-VOP and wait first I-VOP. Example of MPEG-4 Stream HTTP response P-VOP P-VOP P-VOP VOL I-VOP P-VOP ~ There are VOL, Userdata1, GOV and Us erdata2 before each I-VOP. D[...]

5. RTSP/RTP 5.1. URI RTSP of the cam era is RF C2326 com pliant. Three encoders can be ena bled in the cam era at its m aximum . Each encoder's U RI for RT SP is: Encoder Chan nel URI of RT SP 1 rtsp://ipaddress/P SIA/Strea ming/channe ls/0 2 rtsp://ipaddress/P SIA/Strea ming/channe ls/1 3 rtsp://ipaddress/P SIA/Strea ming/channe ls/2 To know [...]

waits 0-0.7 second before sending response to avoid too many responses are sent in short period from man y cameras. Response Example s y stem. id=VN-H37(192.168.0.2/24)&200 OK<CRLF> 7. Using API that Req uires Basic Au thentication Basic authentication is required for JVC API explained in Section 7 or la ter. This section provides general[...]

admin:jvc Base64 encoding of this string yields YWRtaW 46anZj. Enter this in the Authorization line. Default password for each username is jvc. 3) The camera returns a response to the client. I n the following example, current subnet mask is 255.0.0.0. In addition, 255.0.0.0 is followed by & and 200 OK, indicating that getting parameter is succ[...]

W hen an error occurs, an error code w ill be returned instead of indicating a v alue in the body of HTT P response. Example: ParamA.ParamB.ParamC&401 Unau thorized W hen multiple APIs for getting are performed at one time, a response will be returned for each setting. ParamA.ParamB.ParamC&200 OK<CRLF> ParamA.ParamB.ParamD&200 OK&[...]

Format /api/param?camera.id Example of response camera.id=VN-H37 &200 OK Response example when setting field is left blank camera.id=&200 OK Interpretation Acquire Camera ID comment. This comment is stored in comment segment of JPEG. The Camera ID is used as sender's display name of alarm mail. If you want to set sender's m ail ad[...]

Allowed users admin, operator, user Getting Preset Data of Scene File Format /api/param?camera.scene(number).status Example of getting scene file 0 /api/pa ram?camera.scene(0).status Example of response camera.scene(0).status=General-55--0.45-30-au to-off-0-51-off-low-53-mid-autoM-2-combo-color-8-8-auto W-107-65-off-off-0-normal&200 OK Interpre[...]

Getting Auto Exposure Re ference of a Scene File Format /api/param?camera.scene(number).auto_exposure.reference Example of response camera.scene(0).auto_exposure.referenc e=0&200 OK Interpretation Acquire auto ex posure refere nce. A number from -5 to 5 i s returned. W he n the number is bigger , image becomes brighter. Allowed users admin, ope[...]

Getting Enhance of a Scene File Format /api/param?camera.scene(number).image.enhance Example of response camera.scene(0).image.en hance=50&200 OK Interpretation Acquire enhance setting . The enhance is equal to sharpness of image. Range of enhance is between 0 to 100, and it is mapped to 14 internal levels. The larger the value, the sharper wil[...]

Interpretation Acquire white balance setting. "autoW ", "autoN", or "manual" is returned. Allowed users admin, operator, user Setting White Balance of a Scene File Format /api/param?camera.scene(number).image.white_bala nce=data Example /api/param?camera.scene(0).image.white_ balance=auto Example of response camera.sce[...]

Setting B-Gain of White Bala nce of a Scene File Format /api/param?camera.scene(number).image.white_bala nce.b=data Example /api/param?camera.scene(0).image.white_ balance.b=s100 Example of response camera.scene(0).image.white_balance .b&202 Accepted(camera.status=save) Interpretation Change B-gain white ba lance setting. Specify s0 to s255. Th[...]

Interpretation Change limit of sense up. Specify 0, 2, 4, 8, 16, 32, 60, "+" or "-". It becomes bigger 1 step by specifying "+", smaller 1 step by specifying "-". The change of scene file 0 is saved by the API, camera.scene(0).status=save. If the change is not saved, the setting is restored by reboot. Allowed[...]

Example of response camera.scene(0).shutte r&202 Accepted(camera.scene.status=save) Interpretation Change shutter speed setting. Specify "auto100", "auto1000", 30, 50, 60, 100, 250, 500, 1000, 2000, 4000, 10000 or "flickerless", "+" o r "-". To set 1/60 for example, specify 60. It becomes shorte[...]

by the API, camera.scene(0).status=sa ve. If the change is not saved, the setting is restored by reboot. The AGC setting is limited by Day and Night sett ing. Change Day and Night first, then change AGC setting. Allowed users admin, operator Getting Back Light Compensation of a Scene File Format /api/param?camera.scene(number).image.blc Example of [...]

9. JVC A PI for Encode These APIs are related to camera settings . Same functions are shown on the Encode page of the WEB setting page. Refer to the instruction manual for details on the Encode page. Though multiple encode is available, there are limita tions to set multiple encode channels. If VMS does not get multiple streams from a camera, s ett[...]

Interpretation Acquire resolution of the encode channel. Encode channel is from encode(1) to encode(3). Allowed users admin, operator, user Setting Resolution (Frame Size) Format /api/param?encode(number).framesize=data Example /api/param?encode(1).framesize=1920 x1080 Example of response encode(1).t y pe&202 Accepte d(encode.status=save) Inter[...]

Getting H.264 or MPEG-4 bitrate Format /api/param?encode(number).bitrate Example of response encode(1).bitrate=4000000&2 00 OK Interpretation Acquire the bitrate setting of H.264 or MPEG-4. This API is valid when compression fo rmat is h264high, h264baseline or mpeg4. If the response is 4000000 for example, the setting is 4M bps. Allowed users [...]

Allowed users admin, operator, user Setting H.264 or MPEG-4 I-Frame Interval Format /api/param?encode(number).iframeinterval=data Example /api/param?encode(1).iframein terval=15 Example of response encode(1).iframeinte rval&202 Accepted(encode.status=save) Interpretation Change I-Frame interval of H.264 or MPEG-4. This API is valid when compres[...]

Example of response video.output.status&2 00 OK Interpretation Change monitor out sta tus. Specify on to enable the monitor out, off to disable the monitor out. Allowed users admin, operator 10. JVC A PI for Au dio (VN-H57/157WP/257/257V P) These APIs are related to audio s ettings. Same fu nctions are shown on the Audio page o f th e WEB setti[...]

Getting Mike Power Suppl y setting Format /api/param?audio.input(1).powersuppl y .status Example of response audio.input(1).powe rsupply .status=on&2 00 OK Interpretation Acquire mike power suppl y setting. "on" or "off" is returned. Allowed users admin, operator, user Setting Mike Power Supply Format /api/param?audio.input([...]

action. 5 alarm actions, 1 periodic FTP assigned to No.6, 1 pre/post F TP assigned to No.7, and 1 SD Card constant recording assigned to No.8, and SD Card alarm recording assigned to No.10 are available, so alarm action number can be 1 to 8 and 10. Note that alarm numbers are different from the alarm input pin numbers. Either on or off will be retu[...]

returned. Segments are indicated b y /. Example of Response application.event(1 ).action=udpto/10.0.0.100/20000/Message&200 OK W hen sw itch scene file is specified, scene file number will be returned. Example of Response when scene file number is 7 application.event(1).action=camera .image.scene(7).status/goto&200 OK W hen preset position [...]

Alarm action of event nu mber 10 is “SD Card alarm recording”. W hen “SD Card alarm re cording” is enabled, rec, SD Card number, and the attache d object number will be returned. Segments are indicated by /. The SD Card number is fixed as sd01 at all times. The object num ber is fixed as object(10). Parameters of SD Card recording can be go[...]

Specify tcp to, IP ad dress, p ort number, non e o r object(Number), and the character string to be s ent when s ending via TCP. Segments are indicated by /. The num ber of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number a fter %. space & / < > # % " { } | ^ [ ] ` For example, spe[...]

Alarm action of event number 7 is "PrePostRecording + FTP". Specif y recftp, FTP number and the object for PrePostRecording+FTP. The FTP numbe r is fixed as ftp01 at all times. The object is fixed as object(7). Parameters of FTP can be set by other APIs, application.ftp and application.object. En sure to set the FTP server (/api/param?app[...]

Example W hen setting Sunday filter of Alarm No. 1 /api/param?application.event(1).fil ter(sunday ).status=o n Example of Response application.event(1).filter(sunda y ).status&202 Accepted(application.event(1).status=restart) Interpretation Set filter setting of the alarm action for the specified alarm number. Up to 5 alarm actions can be speci[...]

pin numbers. Specify sunday, monday, tuesday, wednes day, thursday, friday or saturday for WeekOfDay. Specify sta rt time and end time in the format like hhmmss-hhmmss. Start time c an be from 000000 to 235959. En d time can be from 000001 to 240000. Start time must be earlier than end time. The changes to filter of alarm action is saved b y /api/p[...]

Getting Alarm Trigger Format /api/param?application.event(Numbe r).trigger Example W hen Getting Trigger of Alarm No. 1 /api/param?application.event(1).trig ger Example of Response application.event(1).trigge r=m1&200 OK Interpretation Acquire Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, pe[...]

application.event(1).trigger&202 Accep ted(application.event(1).status=restart) Interpretation Set Trigger of the alarm action for the specif ied alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, pre/post FTP assigned to No.7, SD Card constant recording is assigned to event No.8 and SD Card ala rm[...]

Getting SMTP Server Address Se tting Format /api/param?application.smtp.host Example of Response application.smtp.host=192.168. 0.200&200 OK Response example when setting field is left blank appli cation.smtp.host=&200 OK Interpretation Acquire the address setting of the SMTP server. Allowed users admin, operator, user Setting SMTP Server A[...]

Allowed users admin, operator, user Setting Sender Mail Address Format /api/param?application.smtp.mail from=data Example /api/param?application.smtp.mailfrom =somebody @somecomp any.com Example of Response application.smtp.mailfrom &200 OK Interpretation Change sender mail address set ting. Maximum text number of sender mail address is 96. Alp[...]

Setting POP Server Address Format /api/param?application.pop.host=data Example /api/param?application.po p.host=192.168.0.200 Example of Response application.pop.host&200 OK Interpretation Change the address setting of the POP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the POP server is no[...]

Example of Response application.pop.user&200 OK Interpretation Change the user name s etting of the POP server. T h e maximum user name size i s 64 bytes. Se t as follows when this is to be left blank . /api/param?application.pop.user= % 00 The user name is used as l ocal part of sender mail a ddress when sender mail address setting is blank. W[...]

Allowed users admin, operator Getting FTP Server Path Setting Format /api/param?application.ftp.path Example of Response application.ftp.path=subd ir1&200 OK Response example when setting field is left blank appli cation.ftp.path=&200 OK Interpretation Acquire the FTP server directory se tting used for FTP transmission via alarm. Allowed us[...]

Setting FTP Server Password Format /api/param?application.ftp.password=da ta Example /api/param?application.ftp.passwo rd=someword Example of Response application.ftp.password&200 OK Interpretation Change the FTP server password s etting used for FTP transmission via alarm. The maximum password size is 32 bytes. Set as follows when this setting[...]

/api/param?application.ftp.naming_option. File Name Example Camera.jpg Allowed users admin, operator Getting User Define Name of File Naming Format /api/param?application.ftp.naming_option Example of Response application.ftp.naming_option=abc&200 OK Interpretation Acquire user defin e name for file naming of periodic FTP. The maximum size is 16[...]

For Pre Duration /api/param?app lication.object(7).prerec=2&200 OK For Post Duration /api/param?a pplication.object(7).postrec=2&200 OK For Encoder No. /api/param?application.object(7).source=encode (1)&200 OK Interpretation Acquire parameters for PrePost. Allowed users admin, operator, user Setting Parameters of Pre/Post Recording for [...]

read_onl y Use LOCK switch is enabled on Use LOCK switch is disabled Allowed users admin, operator, user Setting SD Card to Use/Disable Format /api/param?storage.disk(1 ).status=data Example of Response storage.di sk(1).status&200 OK Interpretation Change the Use/Disable st atus of SD Car d. Specify “on” or “off”. In c ase of “ o n”[...]

Allowed users admin, operator Getting SD Card Capacit y Format /api/param?storage.disk(1 ).size Example of Response storage.di sk(1).size=30543M&200 OK Interpretation Acquire the capac ity of SD card in megabytes. Allowed users admin, operator Getting SD Card Recording Status Format /api/param?storage.disk(1 ).rec Example of Response storage.di[...]

To set recording qualit y to Mid /api/param?encode(3).t y pe=h264h igh /api/param?encode(3).framesize=1280x720 /api/param?encode(3).framerate=5 /api/param?encode(3).bitrate=76 8000 /api/param?encode(3).cbr_mode=cbr /api/param?encode(3).iframeinterval=5 To set recording qualit y to Low /api/param?encode(3).t y pe=h264h igh /api/param?encode(3).frame[...]

Allowed users admin, operator Getting Timeout of Auto Return Format /api/param?camera.motion.auto_return.timeout Example of response camera.motion.auto_return.timeo ut=60&200 OK Interpretation Acquire timeout of Auto Return in seconds. Allowed users admin, operator, user Setting Timeout of Auto Return Format /api/param?camera.motion.auto_return[...]

Setting Speed of Going to Pres et Position Format /api/param?camera.motion.position.speed=data Example to set horizontal /api/param?camera .motion.position.speed=100 Example of Response camera.motion .position.speed&202 Accepted(camera.status=save) Interpretation Set speed of going to preset position. Specify from 0 to 100. 5 is horizontal. 100[...]

Example of Response camera.motion .pan.mode&200 OK Interpretation Set direction of pan operation. Specify left or right. Allowed users admin, operator Setting Speed of Pan Operation Format /api/param?camera.motion.pan.speed=data Example to set maximum speed /api/param?camera.motion.pan.speed=100 Example of Response camera.motion .pan.speed&[...]

Example of Response camera.motion .tilt.status&200 OK Interpretation Start or stop tilt ope ration. Specify start or stop. Allowed users admin, operator Setting Direction of Tilt Operation Format /api/param?camera.motion.tilt.mode=data Example to set to up /api/param?camera .motion.tilt.mode=up Example of Response camera.motion .tilt.mode&2[...]

Example to move to relative multiple, 1 .5 Wide /api/param?camera.motion.zoom=-x1.5 Example of Response camera.motion .zoom&200 OK Interpretation Move t o specified zoom multiple. To move to ab solute multiple, speci fy from 1.00 to 8 .00 w ith "x". The API is valid when the resolution is 640x360 or 6 40x480. Allowed users admin, oper[...]

Example to move (958, 534) to center (pixel) /api/param?camera.motion.clickoncente r=s958-s534 Example to move (958, 534) to center (percentage) /api/param?camera.motion.clickoncente r=50.00-50.00 Interpretation M oving specified position to ce nter of image. To mo ve to X position, sp ecify from s0 to s1918 o r 0.00 to 100.00. To move to Y positio[...]

home position and it is registered with default se ttings when initilized. Other positions are unregistered by initializing. Allowed users admin, operator Moving to Preset Position Format /api/param?camera.position(number).status=goto Example of Response camera.positi on(3).status&200 OK Interpretation Move to specified preset position. Specify[...]

Example of response camera.motion.auto_patrol (0).status=moving&200 OK Interpretation Acquire current sta tus of auto patrol. "moving" or "stop" is returned. Allowed users admin, operator, user Getting Preset Postion Number of Aut o Pa trol Format /api/param?camera.motion.auto_patrol(0).position(num ber) Example to get prese[...]

20, 30, 45, 60, or 120. 0 means skip . 10 means 10 seconds. The change 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, operator Getting Speed of A u to Pa trol Format /api/param?camera.motion.auto_patrol(0).position(num ber).speed Example to get speed of[...]

Format /api/param?camera.private_mask.status Example of response camera.private_mask.s tatus=on&200 OK Interpretation Acquire the on/off status o f privacy masking. Allowed users admin, operator, user Setting Privacy Masking to On/Off Format /api/param?camera.private_mask.status=data Example of Response camera.private_mask.s tatus&202 Accep[...]

Format /api/param?camera.private_mask.area=data Example of Response camera.private_mask.a rea&202 Accepted(camera.status=save) Interpretation Change the a rea of privacy masking. Spe cify bi tmap by 510 characters of hex adecim al number. A bit for privacy masking i s 32x32 p ixels block, and 1 920x1080 i s divided to 6 0x34 bl ocks. F or examp[...]

Interpretation Change the motion det ect sensitivity. Specify a value b etween 0 to 1 00. The larger the value, t he higher will be the sensitivity. The c hange i s sa ved by the API, camera.status=save. If the c hange is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Motion Detect Mask Format /api/param?camera.[...]

page. Getting Tampering Detect On/O ff Status Format /api/param?camera.detection(tampering).status Example of response camera.detection(tampe ring).status=on&200 OK Interpretation Acquire the on/off status o f tampering detect. Allowed users admin, operator, user Setting Tampering Detect to On/O ff Format /api/param?camera.detection(tampering).[...]

Setting Tampering Detect Se nsitivity Format /api/param?camera.detection(tampering).temporal=da ta Example of response camera.detection(tampe ring).temporal&202 Accepted(camera.status=save) Interpretation Change the tampering detect time. Specify a value between 0 to 1 20. The change is saved by t he API, camera.status=save. If the chang e is n[...]

Getting IP A d dress 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 users admin, operator, user Setting IP A ddre ss Format /api/param?network.interface.ip=data Example /api/param?network.interface.ip =192.168.0.2 Example of Response netw[...]

Interpretation Acquire the current default gateway. Specify ipv4 or ipv6. Allowed users admin, operator, user Setting Default Gatew ay Format /api/param?network.gatewa y (ipv4)=data Example /api/param?network.gatewa y (i pv4)=192. 168.0.254 Example of Response network.gatewa y&200 OK Interpretation Change the default gate way. To set static def[...]

Example /api/param?network.dns.status=on Example of Response network.dns.status &200 OK Interpretation Change status of DNS s erver setting, or validate changes to DNS server settings. Specify "on", "off" or "restart". Changes of DNS server settings become valid by "restart". Allowed users admin, operator[...]

Format /api/param?network.interface.ipv6.link_local(Number) Exampleto get first link local address /a pi/param?network.interface.ipv6.link_local(1) Example of Response network.interface.ip v6.link_local(1)=fe80::280:88ff:fe41:400c&200 OK Interpretation Acquire the link local address of IPv6. Specify from 1 to 8 for Number, and get addresses fro[...]

Getting Unicast TTL Value Format /api/param?network.interface.ttl.unicast Example of Response network.interface.ttl .unicast=16&200 OK Interpretation Acquire TTL of unicast. 1-255 is returned. Allowed users admin, operator, user Setting Unicast TTL Format /api/param?network.interface.ttl.unicast=data Example /api/param?network.interface.ttl. un[...]

Setting MTU Value Format /api/param?network.interface.mtu=data Example /api/param?network.interface.m tu=1500 Example of Response network.interface.mtu&202 Accepted(network.in terface.status=restart) Interpretation Change the MTU value. T he range of set value is betw een 1280 to 1500. To validate the change, use "network.interface.status=[...]

Setting Port Number of HTTP Format /api/param?network.http.port=data Example of Response network.http.po rt&202 Accepted(network.http(configuration).status=restart) Interpretation Change port number of HTTP server in the cam era. Default value is 80. To validate the change, use "network.http(configuration).st atus=restart" or "ne[...]

Getting Status of ONVIF Protocol Format /api/param?network.onvif.status Example of Response network.onvif.status=on &200 OK Interpretation Acquire status of ONVIF Protocol in the camera. "on" or "off" is returned. Allowed users admin, operator, user Setting Status of ONVIF Protocol Format /api/param?network.onvif.status=data[...]

Getting Multicast A d dress Format /api/param?network.destination(num).host Example of Response network.destinatio n(1).host=225.0.1.1&200 OK Interpretation Acquire multicast address of specified encode channel. “num” is encoder channel from 1 to 3. Allowed users admin, operator Setting Multicast A dd ress Format /api/param?network.destinat[...]

Interpretation Acquire JPEG mul ticast frame r ate of spec ified encode ch annel. “ n um” i s encoder channel from 1 to 3. The API is valid when the encoder channel is set to JPEG. Allowed users admin, operator Setting Frame Rate of JPEG Multicast Format /api/param?network.destination(num).framerate=data Example /api/param?network.destination ([...]

Setting Audio Multicast Address Format /api/param?network.destination(4).host=data Example /api/param?network.destination (4).host=225.0.1.3 Example of Response network.destination(4).host&202 Accepted( network.destination(4).host=save) Interpretation Change audio multicast add ress. Specify from 224.0.0.0 to 239.255.255.255. To valida te the c[...]

restrictions are applied to getting video stream and bi-directional Audio. Allowed users admin, operator Setting Client Restriction to Deny/Allow Format /api/param?network.access_control(stream_out).logic=data Example /api/param?network.access_cont rol(stream_out).logic=deny Example of Response network.access_con trol(stream_out).logic&200 OK I[...]

Example /api/param?network.access_cont rol(stream_out).host(1)=%00 Allowed user admin 23. JVC A PI for Time The APIs below are related to time . These are equivalent to the features on the Time page of the W EB setting page. Refer to the instruction manual for details on the Time page. Getting On/Off of SNTP Client Format /api/param?network.ntp.sta[...]

Getting Access Interval to NTP Ser ver Format /api/param?network.ntp.interval Example of Response network.ntp.in terval=10&200 OK Interpretation Acquire the interval fo r accessing the NTP server. Unit can be gotten by "network.ntp.unit" API. Allowed users admin, operator, user Setting Access Interval to NTP Server Format /api/param?n[...]

second are denoted in 2-digit decimal numbe rs. Allowed users admin, operator, user Setting Time Format /api/param?s y s tem.date=d ata Example /api/param?s y ste m.da te=20050614171537 Example of Response s y ste m.da te&200 OK Interpretation Change th e time of the built-in clock in the cam era. Sp ecify in the order of year, month, day, hour[...]

Paris Same timezone as GMT+1. CET Same timezone as GMT+1. GMT+2 Timezone that is 2 hours later than the Greenwich Mean Time. EET Same timezone as GMT+2 GMT+3 Timezone that is 3 hours later than the Greenwich Mean Time. GMT+3:30 Timezone that is 3 hours and 30 minu tes later than the Greenwich Mean Time. GMT+4 Timezone that is 4 hours later than the[...]

Interpretation Change the password of a dmin(0), admin(1), admin(2 ) o r ad min(3). Set a password between 4 to 16 characters. There is no API for Getting passwords. Allowed user admin Setting Password of operator Format /api/param?s y s tem.password. operator(num)=data2 Example /api/param?system.password.op erator(0)=someword Example of Response s[...]

W EB setting page. Refer to the instruction manual for details on the Maintenance page. Restart the Camera Format /api/param?s y s tem.status =restart Example of Response s y ste m.sta tus&200 OK Interpretation Restarts the camera. Allowed users admin Initialization Format /api/param?s y s tem.status =initialize Example of Response s y ste m.st[...]

Interpretation Change LED setting. Speci fy "on" or "off". If "on" is set, LED becomes off after restarting. To validate the change, use "camera.status=save" API. Allowed users admin, operator Getting LED blinking mode Format /api/param?camera.identif y Example of Response camera.identi fy =off&200 OK Int[...]

system.session.sending_count=2&200 OK system.session.sending_max=5&200 OK system.session.sending(01).bitrate=326k&200 OK system.session.sending(01).to.ip=10.0.0.100 &200 OK system.session.sending(01).to.port=1536&200 OK system.session.sending(01).to.protocol=tcp_passive&200 OK system.session.sending(01).to.session=ht tp&[...]

Allowed users admin, operator, user Getting Firmware Revisions Format /api/param?s y s tem.softw are.revision Example of Response s y ste m.so ftware.revision=1.00&200 OK Interpretation Acquire revisions of the firmware. Allowed users admin, operator, user Getting Software ID Format /api/param?s y s tem.softw are.programid Response Return softw[...]

Setting Mode of FTP Server Format /api/param?application.ftp.mode=data 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 al arm action. Set active or passive. Default is active. active mode: Standard mode of FTP server. Also called PORT mod[...]

Example /api/param?network.rtsp.port=554 Example of Response network.rtsp.port&202 Accepted(n etw ork.rtsp(con figuration).status=restart) Interpretation Change port number of RTSP server. Default is 554. Allowed user admin, operator 29. Getting A udio from the Camera via H TTP (VN-H57/157WP/2 57/257VP) 29.1. Basic Procedures 1) The client esta[...]

Structure of 12 bytes header is as below. First 4 bytes is payload type for u -Law. 5) When the client wants to stop curren t audio transmission, the client disconnects TCP80. The camera d oes not accept further API via c urrent TCP that is used for a udio transmission. To cha nge parameter, dsconnect current TCP to stop the audio tra nsmission, co[...]

shorten the audio delay time. To enable stabl e playback in a network where jitter occurs, it is recommended that this be specified as assured=1. Default value is 1. lowdelay Specifying as lowdelay=1 disables the Nag le a lgorithm of TCP, and audio d e lay time will be shortened. W hen low delay=0 is specified , the Nagle algorithm is enabled and a[...]

30.1. Procedures 1) The client establishes a TCP connection to port num ber 80. 2) The client sends out API. API has following structure. Refer to Section 5 on details of the Accept and Authorization lines. The API characters are as follows. /api/receive?from=network&from.ip=data1&from.p rotocol=tcp_passive&from.ip_translate=on&to=a[...]

4) The client continues to send 512 bytes of u-Law data with a 12-byte header. 5) To end, disconnect TCP49298. 30.2. Restrictions Restrictions on Nu mber of Clients Only 1 cl ient is allowed to send audio d ata to the c amera. the c amera w ill return an er ror for t his API a nd TC P will be disconnected when this function is curren tly in use by [...]

31.3. Example of message sequence C->S DESCRIBE rtsp://192.168.0.20/PSIA/Streaming/t racks RTSP/1.0 CSeq: 1 S->C RTSP/1.0 200 OK CSeq: 1 Content-Base: rtsp://192.168.0.20/PSIA/Streaming/tracks/ Content-Type: application/sdp Content-Length: 267 v=0 o=- 401875008 1 IN IP4 0.0.0.0 s=Media Presentation c=IN IP4 0.0.0.0 t=0 0 m=video 0 RTP/AVP 96 [...]

S->C RTSP/1.0 200 OK CSeq: 3 Session: 401875008 Status: pause C->S PLAY rtsp://192.168.0.20/PSIA/Streaming /tracks RTSP/1.0 CSeq: 4 Range: clock=20120518T135717Z Session: 401875008 S->C RTSP/1.0 200 OK CSeq: 4 Session: 401875008 C->S GET_PARAMETER rtsp://192.168.0.20/PSI A/Streaming/tracks RTSP/1.0 CSeq: 5 Connection: Keep-Alive Session[...]

200 OK,count=1&t_size=7731371<CRLF> <CRLF> 0<CRLF> <CRLF> 0<CRLF> Interpretation Acquire total number of fi les and file size. Specify start time an d end time, t hen CHUNKED HTTP response will be returned. The value o f count is total number of files. The value of t_size is file size. Allowed users admin, operator[...]

C800<CRLF> Data(2) size of file1 data(2) of file1 (50 kB) ... C800<CRLF> Data(1) size of file2 data(1) of file2 (50 kB) C800<CRLF> Data(2) size of file2 data(2) of file2 (50 kB) ... 0<CRLF> End of file Interpretation Specify start time and end time, then CHUNKED HTTP respo nse and H.264 elementary stream data will be returne[...]

- Audio Sending Client It can send audio from PC to the camera. How to download Act iveX controls: i) Please input URL below in Internet Explorer’s url form. http://(IP Address)/ IntegratedViewer.cab Ex.) W hen IP address of the camera is “192.168.0.2”: http://192.168.0.2/IntegratedViewer.cab ii) Download dialog box is showed. Please click sa[...]

W indowsVista : Documents W indows7 : Documents Default: In case of VN-H37: VN-H37 In case of VN-H137: VN-H137 In case of VN-H237: VN-H237 In case of VN-H237VP: VN-H237VP In case of VN-H57: VN-H57 In case of VN-H157WP: VN-H157 In case of VN-H257: VN-H257 In case of VN-H257VP: VN-H257VP OpPassword Operator Password of the camera PTZ Cont rol Client [...]

34.3. Method of ActiveX Control JPEG /H.264 Viewer Method M eaning Play() Start playback Stop() Stop playback Capture() *JPEG only Save still image of JPEG (Saved folder is specified by “Folde r Name” of property) PTZ Cont rol Client Method Meaning Initialize() Initialize PTZ Control Client *It must be called before using ptz con trol Destroy()[...]

JPEG/H.264 Viewer <OBJECT ID="Viewer" WIDTH = 1920 HEIGHT= 1080 CLASSID="CLSID:C0795FC0-14E7 -4A78-A928-88C3FBD2A1D0" CODEBASE="./IntegratedViewer.ca b#version=1,0,1, 37" </OBJECT> PTZ Control Client <OBJECT ID="PTZCtrl" WIDTH = 1 HEIGHT= 1 CLASSID="CLSID:06731D1A-BD3C-49B7-8433-77C730D27F 06[...]

// *************** Viewer *************** function play_click(play_btn, ip, http_port) { if(play_btn.value == "Play"){ InitViewer(ip, http_port); Viewer.Play(); play_btn.value = "Stop"; } else{ Viewer.Stop(); play_btn.value = "Play"; } } function capture_click() { Viewer.Capture(); } function InitViewer(ip, http_port) [...]

function InitSender(ip, http_port) { AudioSender.Password = "jvc"; AudioSender.IP = ip.value; AudioSender.Port = http_port.value; } // *************** PTZ Control *************** var f_init = 0; function PTControl(num){ if (f_init == 0) InitPTZCtrl(); PTZCtrl.ManualCtrl(num); } function ZoomControl(num){ if (f_init == 0) InitPTZCtrl(); PT[...]

</OBJECT> <!-- PTZ Control ActiveX --> <OBJECT ID="PTZCtrl" WIDTH = 1 HEIGHT= 1 CLASSID="CLSID:5506B06A-9FED-4dc0-9 9E1-9AEF2F2B0509"> </OBJECT> <FORM NAME="myForm"> <table> <tr> <td> VN-H37 IP Address <INPUT TYPE="TEXT" NAME="IP" VALUE="1 92.1[...]

- Set unique Multicast address and port number t o each Multicast s tream if multiple multicast stre ams are requi red in the system. - Reload of ActiveX control is requi red to change Multicast property. 35. PSIA - PSIA Account Default User Name: psia Default Password: jvc - RTSP URI See Chapter 4. 36. FAQ (1) Low Frame rate due to long delay of n[...]