Download Print this page

Advertisement

IP Camera API GUIDE
VN-H37/137/237/237VP
VN-H57/157WP/257/257VP
This document provides information of protocol and API of JVC new IP cameras,
VN-H series.
Specifications subject to change without notice.
2012.06.29. (V4.00)
© 2012 JVC KENWOOD Corporation
1

Advertisement

   Summary of Contents for Jvc VN-H37

  • Page 1

    IP Camera API GUIDE VN-H37/137/237/237VP VN-H57/157WP/257/257VP This document provides information of protocol and API of JVC new IP cameras, VN-H series. Specifications subject to change without notice. 2012.06.29. (V4.00) © 2012 JVC KENWOOD Corporation...

  • Page 2

    Page 30, section 9, Getting and Setting I-Frame Interval : MPEG-4 is added. Page 31, section 9, Getting and Setting Monitor Out is added. Page 59, section 16, JVC API for Tampering Detect is added. Page 69, section 18, Getting and Setting Status of PSIA Protocol is added.

  • Page 3

    3.00 2012/05/21 Page 5, 13. JVC API for SD Card Record is added. Page 5, 31. Getting SD Card data from the Camera via RTSP/RTP is added. Page 5, 32. Exporting H.264 data from SD Card to the PC is added.

  • Page 4

    Preface This document is for VMS to support JVC new cameras, VN-H37/137/237. If VMS supports only streaming, i.e. VMS does not have camera setting pages, the chapter "Streaming Protocol" provides how to get stream from a camera. If VMS have setting page of the camera, focusing on necessary functionalities is recommended.

  • Page 5: Table Of Contents

    JVC API for Audio (VN-H57/157WP/257/257VP) ........

  • Page 6

    PSIA ................................... . 1 0 8 FAQ .

  • Page 7: Streaming Protocol

    1. Streaming Protocol - Both JVC protocol and standard RTSP/RTP are supported. - JPEG, H.264 baseline profile, and H.264 high profile are supported. MPEG-4 will be supported in future. - Maximum resolution is 1920x1080. - VN-H series can send 3 different resolution streams of JPEG simultaneously.

  • Page 8: Api Format

    4) When the client wants to stop current 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 transmission, connect new TCP, and send API with new parameter.

  • Page 9

    Example of VN-H137 HTTP/1.1 200 OK<CRLF> Content-Type: multipart/x-mixed-replace;boundary=foo<CRLF> Date: Tue, 06 Mar 2012 13:32:57 GMT<CRLF> Server: JVC VN-H137 Network Camera<CRLF> x-vnh37_response: encode=jpeg&framerate=5.0&framesize=1920x1080&server_push=on&ptz_info=off<CRLF> <CRLF> When API without server_push option is successfully received. The camera will return 200 OK. The x-vnh37_response line indicates actual parameter.

  • Page 10

    The following information is stored in the comment segment 1. Each item has a fixed length. Item Size Example Note Version Information JVC V1.0 Indicates the version of information stored in the comment segment. File Size size = 123456 Indicates JPEG size in bytes.

  • Page 11: Jvc Protocol: H.264 Streaming

    Example: When width=640, the 13-byte area will be written as follows. 0x00 0x00 3. JVC Protocol: H.264 Streaming 3.1. Basic Procedures 1) The client establishes a TCP connection to port number 80. 2) The client sends out API. to get H.264 high profile stream encoded by first channel of the camera Example GET /api/video?encode=h264(1) HTTP/1.1<CRLF>...

  • Page 12

    Example of VN-H137 HTTP/1.1 200 OK<CRLF> Connection: Keep-Alive<CRLF> Content-Type: video/mp4v-es<CRLF> Date: Tue, 06 Mar 2012 15:10:55 GMT<CRLF> Server: JVC VN-H137 Network Camera<CRLF> x-vnh37_response: encode=h264&framesize=1920x1080<CRLF> 3.4. Restrictions Access restriction The camera has access restriction feature that enables to deny access from a specific IP address. If H.264 is requested from the IP address of access restrictions, the camera disconnects the TCP connection after API is send.

  • Page 13

    H.264 stream form the camera is sequence of I Picture and P Picture. Ratio of I Picture and P Picture depends on I-Frame interval setting. Encode page of Web has the setting. Example of H.264 Stream HTTP response Sequence Parameter Set Picture Parameter Set User data I Picture...

  • Page 14: Jvc Protocol: Mpeg-4 Streaming

    Indicates preset position number after moving to Number preset position . In other cases, position = NA. 4. JVC Protocol: MPEG-4 Streaming 4.1. Basic Procedures 1) The client establishes a TCP connection to port number 80. 2) The client sends out API.

  • Page 15

    Example of VN-H137 HTTP/1.1 200 OK<CRLF> Connection: Keep-Alive<CRLF> Content-Type: video/mp4v-es<CRLF> Date: Tue, 06 Mar 2012 15:10:55 GMT<CRLF> Server: JVC VN-H137 Network Camera<CRLF> x-vnh37_response: encode=mpeg4&framesize=640x480<CRLF> 4.4. Restrictions Access restriction The camera 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 restrictions, the camera disconnects the TCP connection after API is send.

  • Page 16

    Ratio of I-VOP and P-VOP depends on I-Frame interval setting. Encode page of Web has the setting. First VOP can be I-VOP or P-VOP. If client 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...

  • Page 17: Rtsp/rtp

    5. RTSP/RTP 5.1. RTSP of the camera is RFC2326 compliant. Three encoders can be enabled in the camera at its maximum. Each encoder's URI for RTSP is: Encoder Channel URI of RTSP rtsp://ipaddress/PSIA/Streaming/channels/0 rtsp://ipaddress/PSIA/Streaming/channels/1 rtsp://ipaddress/PSIA/Streaming/channels/2 To know compression format of each channel, open Encoder setting page by IE described in INSTRUCTIONS manual, or issue "encode"...

  • Page 18: Using Api That Requires Basic Authentication

    Response Example system.id=VN-H37(192.168.0.2/24)&200 OK<CRLF> 7. Using API that Requires Basic Authentication Basic authentication is required for JVC API explained in Section 7 or later. This section provides general explanation of those APIs. 7.1. Procedure 1) The client establishes a TCP connection to port number 80.

  • Page 19

    Content-Length: 80<CRLF> Content-type: text/plain<CRLF> Date: Fri, 13 MAY 2011 07:33:12 GMT<CRLF> Server: JVC VN-H37 API Server<CRLF> network.interface.subnetmask=255.0.0.0&200 OK<CRLF> 4) The client disconnects TCP80 to end the use of API. Note: APIs for getting/setting parameters are not restricted by the access restriction function.

  • Page 20: Jvc Api For Camera

    ParamA.ParamB.ParamC&200 OK<CRLF> ParamA.ParamB.ParamD&200 OK<CRLF> 8. JVC API for Camera These APIs are related to camera settings. Same functions are shown on the Camera page of the WEB setting page. Refer to the instruction manual for details on the Camera page.

  • Page 21

    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 set sender's mail address, s Camera ID is used as sender's display name of alarm mail. If you want to Setting Sender Mail Address".

  • Page 22

    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/param?camera.scene(0).status Example of response camera.scene(0).status=General-55--0.45-30-auto-off-0-51-off-low-53-mid-autoM-2-combo-color-8-8-auto W-107-65-off-off-0-normal&200 OK Interpretation Acquire preset data of specified scene file. The preset data is joined with hyphen as follows. scenename-color-monitortype -gamma-shutter-brightness.highgain -auto_focus-iris-pedestal-autoblack...

  • Page 23

    Getting Auto Exposure Reference of a Scene File Format /api/param?camera.scene(number).auto_exposure.reference Example of response camera.scene(0).auto_exposure.reference=0&200 OK Interpretation Acquire auto exposure reference. A number from -5 to 5 is returned. When the number is bigger, image becomes brighter. Allowed users admin, operator, user Setting Auto Exposure Reference of a Scene File Format /api/param?camera.scene(number).auto_exposure.reference=data Example /api/param?camera.scene(0).auto_exposure.reference=0...

  • Page 24

    Getting Enhance of a Scene File Format /api/param?camera.scene(number).image.enhance Example of response camera.scene(0).image.enhance=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 will be the image. Allowed users admin, operator, user Setting Enhance of a Scene File Format /api/param?camera.scene(number).image.enhance=data...

  • Page 25

    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_balance=data Example /api/param?camera.scene(0).image.white_balance=auto Example of response camera.scene(0).image.white_balance&202 Accepted(camera.scene.status=save) Interpretation Change white balance setting. Specify "autoW", "autoN", or "manual". If "op_auto" is specified, one push auto white balance control is done, and setting becomes "manual".

  • Page 26

    Setting B-Gain of White Balance of a Scene File Format /api/param?camera.scene(number).image.white_balance.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 balance setting. Specify s0 to s255. The s before number means "step". Default value is s219. 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.

  • Page 27

    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.

  • Page 28

    "+", longer 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 users admin, operator Getting Day and Night Setting of a Scene File (for VN-H37 and VN-H237VP) Format /api/param?camera.scene(number).image.true_daynight Example of response camera.scene(0).image.true_daynight=off&200 OK Interpretation Acquire Day and Night setting.

  • Page 29

    by the API, camera.scene(0).status=save. If the change is not saved, the setting is restored by reboot. The AGC setting is limited by Day and Night setting. 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 response camera.scene(0).image.blc=off&200 OK Interpretation Acquire Back Light Compensation setting.

  • Page 30: Jvc Api For Encode

    9. JVC API 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 limitations to set multiple encode channels. If VMS does not get multiple streams from a camera, setting only first channel is recommended that can simplify such limitations.

  • Page 31

    Interpretation Change resolution of the encode channel. Set "1920x1080", "quadvga", "1280x720", "vga", "qvga" or "640x360". The change of the first encode channel is availed by the API, encode(1). Maximum resolution of VN-H37/137/237/57/157/257 is 1920x1080. Maximum resolution of VN-V17/217 is 1280x720.

  • Page 32

    Getting H.264 or MPEG-4 bitrate Format /api/param?encode(number).bitrate Example of response encode(1).bitrate=4000000&200 OK Interpretation Acquire the bitrate setting of H.264 or MPEG-4. This API is valid when compression format is h264high, h264baseline or mpeg4. If the response is 4000000 for example, the setting is 4Mbps. Allowed users admin, operator, user Setting H.264 or MPEG-4 bitrate Format /api/param?encode(number).bitrate=Data...

  • Page 33

    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).iframeinterval=15 Example of response encode(1).iframeinterval&202 Accepted(encode.status=save) Interpretation Change I-Frame interval of H.264 or MPEG-4. This API is valid when compression format is h264high, h264baseline or mpeg4. In case of H.264, specify 5, 10, 15, 30, 60, 90, or 120. In case of MPEG-4, specify 15 or 30.

  • Page 34: Jvc Api For Audio (vn-h57/157wp/257/257vp)

    Interpretation Change monitor out status. Specify on to enable the monitor out, off to disable the monitor out. Allowed users admin, operator 10. JVC API for Audio (VN-H57/157WP/257/257VP) These APIs are related to audio settings. Same functions are shown on the Audio page of the WEB setting page.

  • Page 35: Jvc Api For Alarm

    Interpretation Change mike power supply setting. Specify "on" or "off". Allowed users admin, operator 11. JVC API for Alarm These APIs are related to alarm settings. Same functions are shown on the Alarm page of the WEB setting page. Refer to the instruction manual for details on the Alarm page.

  • Page 36

    action. 5 alarm actions, 1 periodic FTP assigned to No.6, 1 pre/post FTP 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 returned.

  • Page 37

    returned. Segments are indicated by /. Example of Response application.event(1).action=udpto/10.0.0.100/20000/Message&200 OK When switch 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 When preset position is specified, position number will be returned. Example of Response when position number is 2 application.event(1).action=camera.position(2).status/goto&200 OK [VN-H57/157WP/257/257VP Only] When audio file playback is specified, audio file number will be returned.

  • Page 38

    For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available. Setting Example /api/param?application.event(1).action=mailto/somebody@somecompany.com/object(1)/Message%20O The character string "Alarm from VN-H37" will be stored in the title field of the mail.

  • Page 39

    Specify tcpto, IP address, port number, none or object(Number), and the character string to be sent when sending via TCP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %. &...

  • Page 40

    Alarm action of event number 7 is "PrePostRecording + FTP". Specify recftp, FTP number and the object for PrePostRecording+FTP. The FTP number 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. Ensure to set the FTP server (/api/param?application.ftp.host, /api/param?application.object.framerate etc.) before setting PrePostRecording+FTP.

  • Page 41

    Example When setting Sunday filter of Alarm No. 1 /api/param?application.event(1).filter(sunday).status=on Example of Response application.event(1).filter(sunday).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 specified, periodic FTP is assigned to event No.6, and pre/post FTP assigned to No.7. Therefore the number of event(number) can be set between the range of 1 to 7.

  • Page 42

    pin numbers. Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Specify start time and end time in the format like hhmmss-hhmmss. Start time can be from 000000 to 235959. End time can be from 000001 to 240000. Start time must be earlier than end time. The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart.

  • Page 43

    Getting Alarm Trigger Format /api/param?application.event(Number).trigger Example When Getting Trigger of Alarm No. 1 /api/param?application.event(1).trigger Example of Response application.event(1).trigger=m1&200 OK Interpretation Acquire Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, periodic FTP is assigned to event No.6, pre/post FTP assigned to No.7, SD Card constant recording to event No.8 and SD Card alarm recording to No.10.

  • Page 44: Jvc Api For Alarm Environment

    Setting Example /api/param?application.event(1).trigger=m1(100)b2 Allowed users admin, operator 12. JVC API for Alarm Environment The APIs below are related to alarm environment setting. These are equivalent to the features on the Alarm Environment page of the WEB setting page. Refer to the instruction manual for details on the Alarm Environment...

  • Page 45

    Getting SMTP Server Address Setting 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 application.smtp.host=&200 OK Interpretation Acquire the address setting of the SMTP server. Allowed users admin, operator, user Setting SMTP Server Address Format /api/param?application.smtp.host=data Example /api/param?application.smtp.host=192.168.0.200 Example of Response application.smtp.host&200 OK...

  • Page 46

    Allowed users admin, operator, user Setting Sender Mail Address Format /api/param?application.smtp.mailfrom=data Example /api/param?application.smtp.mailfrom=somebody@somecompany.com Example of Response application.smtp.mailfrom&200 OK Interpretation Change sender mail address setting. Maximum text number of sender mail address is 96. Alphanumeric and followings are available. ! # $ % & ' * + - / = ? ^ _ ` { } | ~ POP user name is used as local part of sender mail address when sender mail address setting is blank.

  • Page 47

    Setting POP Server Address Format /api/param?application.pop.host=data Example /api/param?application.pop.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 not set. It is also possible to leave the setting field blank as follows.

  • Page 48

    Example of Response application.pop.user&200 OK Interpretation Change the user name setting of the POP server. The maximum user name size is 64 bytes. Set as follows when this is to be left blank. /api/param?application.pop.user=%00 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_h37".

  • Page 49

    Allowed users admin, operator Getting FTP Server Path Setting Format /api/param?application.ftp.path Example of Response application.ftp.path=subdir1&200 OK Response example when setting field is left blank application.ftp.path=&200 OK Interpretation Acquire the FTP server directory setting used for FTP transmission via alarm. Allowed users admin, operator, user Setting FTP Server Path Format /api/param?application.ftp.path=data Example /api/param?application.ftp.path=subdir1...

  • Page 50

    Setting FTP Server Password Format /api/param?application.ftp.password=data Example /api/param?application.ftp.password=someword Example of Response application.ftp.password&200 OK Interpretation Change the FTP server password setting used for FTP transmission via alarm. The maximum password size is 32 bytes. Set as follows when this setting is to be left blank. /api/param?application.ftp.password=%00 Allowed users admin, operator (There is no API for Getting passwords.)

  • Page 51

    /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 define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?application.ftp.naming_option is set to "type1", the file name is as ***YYYMMDDHHMMSSNNN.jpg, and "***"...

  • Page 52: Jvc Api For Sd Card Record

    FTP is valid when encode type is set to JPEG. Allowed users admin, operator 13. JVC API for SD Card Record The APIs below are related to SD Card Recording. These are equivalent to the features on the SD Card Record page of the WEB setting page.

  • Page 53

    read_only LOCK switch is enabled 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.disk(1).status&200 OK Interpretation Change the Use/Disable status of SD Card. Specify “on” or “off”. In case of “on”, SD Card can be use.

  • Page 54

    Allowed users admin, operator Getting SD Card Capacity Format /api/param?storage.disk(1).size Example of Response storage.disk(1).size=30543M&200 OK Interpretation Acquire the capacity 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.disk(1).rec=on&200 OK Interpretation Acquire the status of SD card recording.

  • Page 55: Jvc Api For Digital Ptz

    WEB setting page. Refer to the instruction manual for details on the PTZ page. Basic authentication is required for JVC API explained in Section 7 or later. This section provides general explanation of those APIs. The API is valid when the resolution is 640x360 or 640x480.

  • Page 56

    Allowed users admin, operator Getting Timeout of Auto Return Format /api/param?camera.motion.auto_return.timeout Example of response camera.motion.auto_return.timeout=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.timeout=data Example of Response camera.motion.auto_return.timeout&202 Accepted(camera.status=save) Interpretation Change timeout of Auto Return in seconds.

  • Page 57

    Setting Speed of Going to Preset 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 is fastest. The speed is 4 steps internally. The speed is applied also to preset position of auto patrol. The change is saved by the API, camera.status=save.

  • Page 58: Tilt Operation

    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&200 OK Interpretation Set speed of pan operation. Specify 0 to 100. The speed is 8 steps internally. Allowed users admin, operator Getting Pan Operation Status Format /api/param?camera.motion.pan.status...

  • Page 59

    Example of Response camera.motion.tilt.status&200 OK Interpretation Start or stop tilt operation. 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&200 OK Interpretation Set direction of tilt operation. Specify up or down. Allowed users admin, operator Setting Speed of Tilt Operation Format /api/param?camera.motion.tilt.speed=data...

  • Page 60

    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 to specified zoom multiple. To move to absolute multiple, specify from 1.00 to 8.00 with "x". The API is valid when the resolution is 640x360 or 640x480. Allowed users admin, operator Zoom Operation Format /api/param?camera.motion.zoom.status=data...

  • Page 61

    Example to move (958, 534) to center (pixel) /api/param?camera.motion.clickoncenter=s958-s534 Example to move (958, 534) to center (percentage) /api/param?camera.motion.clickoncenter=50.00-50.00 from s0 to s1918 or Interpretation Moving specified position to center of image. To move to X position, specify 0.00 to 100.00. To move to Y position, specify from s0 to s1078 or 0.00 to 100.00. Allowed users admin, operator (3) Preset Position Getting Current Preset Position...

  • Page 62: Jvc Api For Auto Patrol

    32. To erase title, specify %00, i.e. 0x25 0x30 0x30 in binary data. Use %20 to set space. Allowed users admin, operator 15. JVC API for Auto Patrol The APIs below are related to Auto Patrol. These are equivalent to the features on the AutoPatrol page of the WEB setting page.

  • Page 63

    Example of response camera.motion.auto_patrol(0).status=moving&200 OK Interpretation Acquire current status of auto patrol. "moving" or "stop" is returned. Allowed users admin, operator, user Getting Preset Postion Number of Auto Patrol Format /api/param?camera.motion.auto_patrol(0).position(number) Example to get preset position number of patrol nuber 3 /api/param?camera.motion.auto_patrol(0).position(3) Example of response camera.motion.auto_patrol(0).position(3)=5&200 OK Interpretation Acquire preset position number of specified patrol number of auto patrol.

  • Page 64: Jvc Api For Privacy Masking

    Interpretation Save preset position number and duration of auto patrol. Allowed users admin, operator 16. JVC API for Privacy Masking The APIs below are related to privacy masking. These are equivalent to the features on the Privacy Masking page of the WEB setting page. Refer to the instruction manual for details on the Privacy Masking page.

  • Page 65

    Format /api/param?camera.private_mask.status 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 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.

  • Page 66: Jvc Api For Motion Detect

    Allowed users admin, operator 17. JVC API for Motion Detect The APIs below are related to motion detection. These are equivalent to the features on the Motion Detection page of the WEB setting page. Refer to the instruction manual for details on the Motion Detection page.

  • Page 67: Jvc Api For Tampering Detect

    Allowed users admin, operator 18. JVC API for Tampering Detect The APIs below are related to the Tampering detection. These are equivalent to the features on the Tampering Detection page of the WEB setting page. Refer to the instruction manual for details on the Tampering Detection...

  • Page 68

    page. Getting Tampering Detect On/Off Status Format /api/param?camera.detection(tampering).status Example of response camera.detection(tampering).status=on&200 OK Interpretation Acquire the on/off status of tampering detect. Allowed users admin, operator, user Setting Tampering Detect to On/Off Format /api/param?camera.detection(tampering).status=data Example of Response camera.detection(tampering).status&202 Accepted(camera.status=save) Interpretation Change the on/off status of tampering detect. The change is saved by the API, camera.status=save.

  • Page 69: Jvc Api For Network Basics

    API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator 19. JVC API for Network Basics The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page.

  • Page 70

    Getting IP Address 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 Address Format /api/param?network.interface.ip=data Example /api/param?network.interface.ip=192.168.0.2 Example of Response network.interface.ip&202 Accepted(network.interface.status=restart) Interpretation Change the IP address. To validate the change, use "network.interface.status=restart" API that reboots the camera in about 1 minute.

  • Page 71

    Interpretation Acquire the current default gateway. Specify ipv4 or ipv6. Allowed users admin, operator, user Setting Default Gateway Format /api/param?network.gateway(ipv4)=data Example /api/param?network.gateway(ipv4)=192.168.0.254 Example of Response network.gateway&200 OK Interpretation Change the default gateway. To set static default gateway, disable DHCP. Default gateway can not be changed when DHCP is enabled.

  • Page 72

    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". Changes of DNS server settings become valid by "restart". Allowed users admin, operator Getting DNS Server IP Address Format /api/param?network.dns.ip Example of Response network.dns.ip=10.0.0.150&200 OK Interpretation Acquire IP address of DNS server.

  • Page 73

    Format /api/param?network.interface.ipv6.link_local(Number) Exampleto get first link local address /api/param?network.interface.ipv6.link_local(1) Example of Response network.interface.ipv6.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 from 1 till vacant address is returned. There is no API for setting link local address of IPv6. Allowed users admin, operator, user Getting Global Address of IPv6 Format /api/param?network.interface.ipv6.global(Number)

  • Page 74

    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.unicast=56 Example of Response network.interface.ttl.unicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of unicast. The range of set value is between 1 to 255. To validate the change, use "network.interface.status=restart"...

  • Page 75: Jvc Api For Protocol

    "network.interface.status=restart" API. Allowed user admin 20. JVC API for 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.

  • Page 76

    Setting Port Number of HTTP Format /api/param?network.http.port=data Example of Response network.http.port&202 Accepted(network.http(configuration).status=restart) Interpretation Change port number of HTTP server in the camera. Default value is 80. To validate the change, use "network.http(configuration).status=restart" or "network.http.status=restart" API. Allowed users admin, operator Getting Status of AMX Discovery Protocol Format /api/param?network.amx.beacon.status Example of Response network.amx.beacon.status=on&200 OK Interpretation Acquire status of AMX Discovery Protocol in the camera.

  • Page 77: Jvc Api For Multicast Streaming

    “on”, status of ONVIF protocol will not be “on”. Allowed users admin, operator 21. JVC API for Multicast Streaming The APIs below are related to manual streaming. These are equivalent to the features on the Streaming page of the WEB setting page.

  • Page 78

    Getting Multicast Address Format /api/param?network.destination(num).host Example of Response network.destination(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 Address Format /api/param?network.destination(num).host=data Example /api/param?network.destination(1).host=225.0.1.1 Example of Response network.destination(1).host&202 Accepted(network.destination(1).host=save) Interpretation Change multicast address of specified encode channel.

  • Page 79

    Interpretation Acquire JPEG multicast frame rate of specified encode channel. “num” is 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(1).framerate=30 Example of Response...

  • Page 80: Jvc Api For Access Restrictions

    API. Allowed user admin 22. JVC API for Access Restrictions The APIs below are related to access restrictions. These are equivalent to the features on the Access Restrictions page of the WEB setting page. Refer to the instruction manual for details on the Access Restrictions page.

  • Page 81

    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_control(stream_out).logic=deny Example of Response network.access_control(stream_out).logic&200 OK Interpretation Change the deny/allow setting of client restrictions. Specify as deny or allow. These restrictions are applied to getting video stream and bidirectional Audio.

  • Page 82: Jvc Api For Time

    Example /api/param?network.access_control(stream_out).host(1)=%00 Allowed user admin 23. JVC API for Time The APIs below are related to time. These are equivalent to the features on the Time page of the WEB setting page. Refer to the instruction manual for details on the Time page.

  • Page 83

    Getting Access Interval to NTP Server Format /api/param?network.ntp.interval Example of Response network.ntp.interval=10&200 OK Interpretation Acquire the interval for 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?network.ntp.interval=data Example /api/param?network.ntp.interval=60 Example of Response...

  • Page 84

    second are denoted in 2-digit decimal numbers. Allowed users admin, operator, user Setting Time Format /api/param?system.date=data Example /api/param?system.date=20050614171537 Example of Response system.date&200 OK Interpretation Change the time of the built-in clock in the camera. Specify in the order of year, month, day, hour, minute and second.

  • Page 85: Jvc Api For Password

    To validate the change, use "system.status=restart" API. Allowed user admin 24. JVC API for Password The APIs below are related to passwords. These are equivalent to the features on the Password page of the WEB setting page. Refer to the instruction manual for details on the Password page.

  • Page 86: Jvc Api For Maintenance

    Example of Response system.password. admin(1)=unregistered&200 OK Interpretation Delete specified account. admin(0), operator(0) and user(0) can not be deleted. Allowed user admin 25. JVC API for Maintenance The APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the...

  • Page 87: Jvc Api For Led Setting

    Version upgrading is not possible using API. To do so, use the Version Upgrade feature on the Maintenance page of the WEB setting page. 26. JVC API for LED Setting The APIs below are related to LED. These are equivalent to the features on the LED page of the WEB setting page.

  • Page 88: Jvc Api For Getting Status

    "camera.status=save" API. Allowed users admin, operator 27. JVC API for Getting Status The APIs below are related to status acquisition. These are equivalent to the features on the Operation/Settings page of the WEB setting page. Refer to the instruction manual for details on the Operation/Settings page.

  • Page 89

    2142sec <----- No. of seconds after startup Dec 19 14:35:32 vn-h37 user.info evman: Motion Detect <----- Motion detect Dec 19 14:36:03 vn-h37 user.info evman: Alarm Detect (m1) <----- Alarm input 1ch (make) Dec 19 14:36:04 vn-h37 user.info evman: Alarm Detect (b2) <----- Alarm input 2ch (break)

  • Page 90: Jvc Api For Others

    Response examples system.software.programid=SPL0123&200 OK Interpretation Acquire the software ID. Allowed user admin 28. JVC API for Others These are APIs of features not found on the WEB setting page. Getting Alarm Input Status (VN-H57/157/257) Format /api/param?peripheral.input_pin.pin(Number).status Example of Response peripheral.input_pin.pin(1).status=make&200 OK Interpretation Acquire the current alarm input status.

  • Page 91

    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 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 the camera.

  • Page 92: Getting Audio From The Camera Via Http (vn-h57/157wp/257/257vp)

    Connection: close<CRLF> Content-type: audio/ulaw<CRLF> Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-H57 Network Camera<CRLF> x-vnh57_response: encode=ulaw&lowdelay=1&assured=1<CRLF><CRLF> 4) The camera 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 the camera are as follows.

  • Page 93

    Structure of 12 bytes header is as below. First 4 bytes is payload type for u-Law. 0x00000080 Volume of payload (512 for u-Law) Time stamp in 8kHz 5) When the client wants to stop current audio transmission, the client disconnects TCP80. The camera does not accept further API via current TCP that is used for audio transmission.

  • Page 94: Sending Audio To The Camera (vn-h57/157wp/257/257vp)

    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-H57 Network Camera<CRLF> x-vnh57_response: encode=ulaw&lowdelay=1&assured=1<CRLF><CRLF> 29.4. Restrictions Access restriction The camera 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, the camera disconnects the TCP connection after API is sent.

  • Page 95

    30.1. Procedures 1) The client establishes a TCP connection to port number 80. 2) The client sends out API. API has following structure. G E T s p a c e A P I C h a r a c t e r s s p a c e H T T P / 1 .

  • Page 96: Getting Sd Card Data From The Camera Via Rtsp/rtp

    4) The client continues to send 512 bytes of u-Law data with a 12-byte header. 0x00000080 Volume of payload (512 for u-Law) Time stamp in 8kHz u-Law data (512 bytes) 5) To end, disconnect TCP49298. 30.2. Restrictions Restrictions on Number of Clients Only 1 client is allowed to send audio data to the camera.

  • Page 97

    31.3. Example of message sequence C->S DESCRIBE rtsp://192.168.0.20/PSIA/Streaming/tracks 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 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 a=control:video a=rtpmap:96 H264/90000 a=fmtp:96...

  • Page 98: Exporting H.264 Data From Sd Card To The

    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/PSIA/Streaming/tracks RTSP/1.0 CSeq: 5 Connection: Keep-Alive Session: 401875008 S->C RTSP/1.0 200 OK CSeq: 5 Session: 401875008 Status: play...

  • Page 99

    200 OK,count=1&t_size=7731371<CRLF> <CRLF> 0<CRLF> <CRLF> 0<CRLF> Interpretation Acquire total number of files and file size. Specify start time and end time, then CHUNKED HTTP response will be returned. The value of count is total number of files. The value of t_size is file size. Allowed users admin, operator Exporting SD Card Data as a File Format...

  • Page 100: List Of Protocols And Port Numbers Used

    TCP 20, 21 TCP 25 SMTP (Mail by Alarm Action) TCP 80 WEB setting page, API for Getting status and changing settings, video/audio streaming by JVC protocol UDP 80 Search for the camera TCP 110 POP (Mail by Alarm Action)

  • Page 101

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

  • Page 102

    WindowsVista : Documents Windows7 : 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...

  • Page 103

    34.3. Method of ActiveX Control JPEG /H.264 Viewer Method Meaning Play() Start playback Stop() Stop playback Capture() Save still image of JPEG *JPEG only (Saved folder is specified by “Folder Name” of property) PTZ Control Client Method Meaning Initialize() Initialize PTZ Control Client *It must be called before using ptz control Destroy() Finalizing PTZ Control Client...

  • Page 104

    JPEG/H.264 Viewer <OBJECT ID="Viewer" WIDTH = 1920 HEIGHT= 1080 CLASSID="CLSID:C0795FC0-14E7-4A78-A928-88C3FBD2A1D0" CODEBASE="./IntegratedViewer.cab#version=1,0,1, 37" </OBJECT> PTZ Control Client <OBJECT ID="PTZCtrl" WIDTH = 1 HEIGHT= 1 CLASSID="CLSID:06731D1A-BD3C-49B7-8433-77C730D27F06 " CODEBASE="./IntegratedViewer.cab #version=1,0,0,0" </OBJECT> Audio Monitor <OBJECT ID="AudioMonitor" WIDTH =1 HEIGHT= 1 CLASSID="CLSID:EEF1E8CA-D887-4530-97F9-4C79ABCAE520" CODEBASE="./IntegratedViewer.cab #version=1,0,0,0" </OBJECT> Audio Sending Client <OBJECT ID="AudioSender"...

  • Page 105

    Viewer.Capture(); function InitViewer(ip, http_port) Viewer.OpPassword = "jvc"; Viewer.IP = ip.value; Viewer.HttpPort = http_port.value; Viewer.DispWidth = 640; Viewer.DispHeight = 360; Viewer.FolderName = "VN-H37"; Viewer.RcvMode = 0; // ************** Audio Monitor ************** function receive_click(rcv_btn, ip, http_port) if(rcv_btn.value == "Receive"){ InitMonitor(ip, http_port); AudioMonitor.Play();...

  • Page 106

    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(); PTZCtrl.ZoomCtrl(num); function InitPTZCtrl(){ PTZCtrl.OpPassword = "jvc";...

  • Page 107

    <!-- PTZ Control ActiveX --> <OBJECT ID="PTZCtrl" WIDTH = 1 HEIGHT= 1 CLASSID="CLSID:5506B06A-9FED-4dc0-99E1-9AEF2F2B0509"> </OBJECT> <FORM NAME="myForm"> <table> <tr> <td> VN-H37 IP Address <INPUT TYPE="TEXT" NAME="IP" VALUE="192.168.0.2"> HTTP Port <INPUT TYPE="TEXT" NAME="HTTP_PORT" VALUE="80"> </td> </tr> <tr> <td> Viewer <INPUT TYPE="BUTTON" NAME="PLAY_BTN" style="width:70px"...

  • Page 108

    - Reload of ActiveX control is required 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 network - Causes of Low Frame Rate During transmission via TCP, the camera sends out the following data by receiving the Ack of TCP.

Comments to this Manuals

Symbols: 0
Latest comments: