JVC 137, 157WP, 237, 237VP, 257, 257VP, VN-H37, VN-H57 20. JVC API for Protocol

Setting MTU Value

Format /api/param?network.interface.mtu=data

Example /api/param?network.interface.mtu=1500

Example of Response

network.interface.mtu&202 Accepted(network.interface.status=restart)

Interpretation Change the MTU value. The range of set value is between 1280 to 1500. To validate the change,

use "network.interface.status=restart" API.

Allowed user admin

Getting Network Negotiation Setting

Format /api/param?network.interface.negotiation

Example of Response network.interface.negotiation=auto&200 OK

Interpretation Acquire the network Negotiation setting. Either auto, 100full, 100half, 10full or 10half will be

returned.

Allowed users admin, operator, user

Setting Network Negotiation

Format /api/param?network.interface.negotiation=data

Example /api/param?network.interface.negotiation=auto

Example of Response

network.interface.negotiation&202 Accepted(network.interface.status=restart)

Interpretation Change the network Negotiation setting. Specify auto, 100full, 100half, 10full or 10half. To

validate the change, use "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.

Getting Port Number of HTTP

Format /api/param?network.http.port

Example of Response network.http.port=80&200 OK

Interpretation Acquire port number of HTTP server in the camera.

Allowed users admin, operator

Contents

Main IP Camera API GUIDE VN-H37/137/237/237VP VN-H57/157WP/257/257VP 2012.06.29. (V4.00) Updates Page Preface Content Page 1. Streaming Protocol 2. JVC Protocol: JPEG Streaming 2.1. Basic Procedures 2.2. API Format Structure Parameter Description 2.3. Response 2.4. Restrictions 2.5. JPEG File Format Sent Out by the camera 3. JVC Protocol: H.264 Streaming 3.1. Basic Procedures 3.2. API Format Structure Parameter Description 3.3. Response 3.4. Restrictions 3.5. H.264 Stream Format Send Out by the camera Item Size Example Note 18 type = VN-H137 50 camera = input01 timestamp = 70 4. JVC Protocol: MPEG-4 Streaming 4.1. Basic Procedures 4.2. API Format Structure encode=h264 Parameter Description 4.3. Response 4.4. Restrictions 4.5. MPEG-4 Stream Format Send Out by the camera Page 5. RTSP/RTP 5.1. URI 5.2. JPEG 5.3. H.264 6. API to Search Camera 7. Using API that Requires Basic Authentication 7.1. Procedure 7.2. Getting Parameter network.interface.status, network.dns.status, network.ntp.status, etc., can not be 7.3. Setting Parameter network.interface.status, network.dns.status, network.ntp.status, etc., can not be Getting Camera ID 8. JVC API for Camera Setting Camera ID Getting Current Scene File Number Getting Preset Data of Scene File Loading/Saving/Initializing Scene File Getting Current Scene File Name Getting Auto Exposure Reference of a Scene File Setting Auto Exposure Reference of a Scene File Getting Color Level of a Scene File Setting Color Level of a Scene File Getting Enhance of a Scene File Setting Enhance of a Scene File Getting 3DDNR of a Scene File Setting 3DDNR of a Scene File Getting White Balance of a Scene File Setting White Balance of a Scene File Getting R-Gain of White Balance of a Scene File Setting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene File Setting B-Gain of White Balance of a Scene File Getting AGC of a Scene File Setting AGC of a Scene File Getting Limit of Sense Up of a Scene File Setting Limit of Sense Up of a Scene File Getting ALC priority of Scene File Setting ALC priority of Scene File Getting Shutter Speed of a Scene File Setting Shutter Speed of a Scene File Getting Day and Night Setting of a Scene File (for VN-H37 and VN-H237VP) Setting Day and Night Setting of a Scene File (for VN-H37 and VN-H237VP) Getting Easy Day and Night Setting of a Scene File (for VN-H137 and VN-H237) Setting Easy Day and Night Setting of a Scene File (for VN-H137 and VN-H237) Getting Back Light Compensation of a Scene File Setting Back Light Compensation of a Scene File Getting CLVI of a Scene File Setting CLVI of a Scene File 9. JVC API for Encode Getting Compression Format Setting Compression Format Getting Resolution (Frame Size) Setting Resolution (Frame Size) Caution: All channels need to have same aspect ratio, 16:9 or 4:3. Getting Rate Control Setting Setting Rate Control Getting H.264 or MPEG-4 bitrate Setting H.264 or MPEG-4 bitrate Getting JPEG File Size Setting Setting JPEG File Size Getting H.264 or MPEG-4 I-Frame Interval Setting Setting H.264 or MPEG-4 I-Frame Interval Getting Frame Rate Setting Setting Frame Rate Getting Monitor Out Status Setting Monitor Out Status 10. JVC API for Audio (VN-H57/157WP/257/257VP) Getting Audio Duplex Mode Setting Audio Duplex Mode Getting Mike Gain Setting Mike Gain 11. JVC API for Alarm Getting On/Off of Alarm Action Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action Getting Alarm Action Page Setting Alarm Action Page Getting Alarm Filter Setting Setting Alarm Filter Getting Alarm Filter Time Setting Alarm Filter Time Getting Alarm Filter Type Setting Alarm Filter Type Getting Alarm Trigger Setting Alarm Trigger 12. JVC API for Alarm Environment Getting SMTP Server Address Setting Setting SMTP Server Address Getting SMTP Server Port Number Setting Setting SMTP Server Port Number Getting Sender Mail Address Setting Setting Sender Mail Address ! # $ % & ' * + - / = ? ^ _ ` { } | ~ Getting "POP before SMTP" Setting Setting "POP before SMTP" Getting POP Server Address Setting Setting POP Server Address Getting POP Server Port Number Setting Setting POP Server Port Number Getting POP Server User Name Setting Setting POP Server User Name Setting POP Server Password Getting FTP Server Address Setting Setting FTP Server Address Getting FTP Server Path Setting Setting FTP Server Path Getting FTP Server User Name Setting Setting FTP Server User Name Setting FTP Server Password Getting File Naming of Periodic FTP Setting File Naming of Periodic FTP Getting User Define Name of File Naming Setting User Define Name of File Naming Getting Parameters of Pre/Post Recording for FTP Setting Parameters of Pre/Post Recording for FTP 13. JVC API for SD Card Record Getting SD Card Status Setting SD Card to Use/Disable Getting Status of SD Card formatting Formatting SD Card Getting SD Card Constant Recording On/Off Status Setting SD Card Constant Recording On/Off Getting SD Card Capacity Getting SD Card Recording Status Getting Encoder No. for SD Card Recording Setting Encoder No. for SD Card Recording 14. JVC API for Digital PTZ (1) Settings for PTZ Control Getting Auto Return Mode Setting Auto Return Mode Getting Timeout of Auto Return Setting Timeout of Auto Return Getting Auto Return Status Setting Auto Return Status Getting Speed of Going to Preset Position Setting Speed of Going to Preset Position (2) PTZ Control Getting Pan Position Moving to Specified Pan Position Pan Operation Setting Direction of Pan Operation Setting Speed of Pan Operation Getting Pan Operation Status Getting Tilt Position Moving to Specified Tilt Position Tilt Operation Setting Direction of Tilt Operation Setting Speed of Tilt Operation Getting Tilt Operation Status Getting Zoom Position Moving to Specified Zoom Position Zoom Operation Setting Direction of Zoom Operation Setting Speed of Zoom Operation Getting Zoom Operation Status Moving Specified Position to Center (3) Preset Position Getting Current Preset Position Getting Status of Specified Preset Position Register Current Position as Preset Position Initialize Preset Position Moving to Preset Position 15. JVC API for Auto Patrol Start/Stop of Auto Patrol Getting Status of Auto Patrol Getting Preset Postion Number of Auto Patrol Setting Preset Postion Number of Auto Patrol Getting Duration of Auto Patrol Setting Duarion of Auto Patrol Getting Speed of Auto Patrol 16. JVC API for Privacy Masking Setting Privacy Masking to On/Off Getting Privacy Masking Color Setting Privacy Masking Color Getting Privacy Masking Area 17. JVC API for Motion Detect Getting Motion Detect On/Off Status Setting Motion Detect to On/Off Getting Motion Detect Sensitivity Setting Motion Detect Sensitivity 18. JVC API for Tampering Detect Getting Tampering Detect On/Off Status Setting Tampering Detect to On/Off Getting Tampering Detect Sensitivity Setting Tampering Detect Sensitivity Getting Tampering Detect time 19. JVC API for Network Basics Enabling Network Setting Changes Getting DHCP Setting Setting DHCP Getting IP Address Setting IP Address Getting Subnet Mask Setting Subnet Mask Getting Default Gateway Setting Default Gateway Getting Host Name Setting Host Name Getting DNS Server On/Off Status Setting DNS Server Status to On/Off, or Validate Changes Getting DNS Server IP Address Setting DNS Server IP Address Getting Link Local Address of IPv6 Getting IPv6 status Setting IPv6 status Getting Global Address of IPv6 Getting MAC Address Getting TOS Value of Stream Setting TOS Value of Stream Getting Unicast TTL Value Setting Unicast TTL Getting Multicast TTL Value Setting Multicast TTL Getting MTU Value 20. JVC API for Protocol Getting Port Number of HTTP Setting Port Number of HTTP Getting Status of AMX Discovery Protocol Setting Status of AMX Discovery Protocol Getting Status of PSIA Protocol Setting Status of PSIA Protocol 21. JVC API for Multicast Streaming Getting Status of Multicast Streaming Setting Status of Multicast Streaming, or Save Changes Getting Multicast Address Setting Multicast Address Getting Multicast Port Number Setting Multicast Port Number Getting Frame Rate of JPEG Multicast Setting Frame Rate of JPEG Multicast Getting Status of Audio Multicast Streaming Setting Status of Audio Multicast Streaming, or Save Changes Getting Audio Multicast Address Setting Audio Multicast Address 22. JVC API for Access Restrictions Getting Deny/Allow Setting of Client Restrictions Setting Client Restriction to Deny/Allow Getting IP Address Setting of Restricted Client Setting IP Address of Restricted Client 23. JVC API for Time Getting On/Off of SNTP Client Setting On/Off of SNTP Client, or Validate Changes Getting NTP Server Address Setting NTP Server Address Getting Access Interval to NTP Server Setting Access Interval to NTP Server Getting Access Interval Unit of NTP Setting Access Interval Unit of SNTP Getting Time Setting Time Getting Timezone Setting Timezone 24. JVC API for Password Setting Password of admin Setting Password of operator Setting Password of user Delete Acount 25. JVC API for Maintenance Restart the Camera Initialization Firmware Update 26. JVC API for LED Setting Getting LED mode Setting LED mode Getting LED blinking mode Setting LED blinking mode 27. JVC API for Getting Status Getting Sending Status Getting Log Dec 19 14:35:32 vn-h37 user.info evman: Motion Detect Dec 19 14:35:18 vn-h37 user.info evman: Motion Detect Dec 19 14:36:04 vn-h37 user.info evman: Alarm Detect (b2) Dec 19 14:36:03 vn-h37 user.info evman: Alarm Detect (m1) 28. JVC API for Others Getting Alarm Input Status (VN-H57/157/257) Getting Mode of FTP Server Setting Mode of FTP Server Getting Control Port Number of FTP Server Setting Control Port Number of FTP Server Getting Port Number of RTSP Server Setting Port Number of RTSP Server 29. Getting Audio from the Camera via HTTP (VN-H57/157WP/257/257VP) 29.1. Basic Procedures 29.2. API Format Structure Parameter Description 29.3. Response When API is successfully received 29.4. Restrictions Access restriction 30. Sending Audio to the Camera (VN-H57/157WP/257/257VP) 30.1. Procedures 30.2. Restrictions Restrictions on Number of Clients Timing of Data Sending 31. Getting SD Card data from the Camera via RTSP/RTP RTSP of the camera is RFC2326 compliant. 31.1. URI 31.2. Playback control 31.3. Example of message sequence 32. Exporting H.264 data from SD Card to the PC Getting Total Number of Files and File Size Exporting SD Card Data as a File 33. List of Protocols and Port Numbers Used 34. Customizing Built-in Viewer 34.1. List of ActiveX How to download ActiveX controls: 34.2. Properties of ActiveX JPEG /H.264 Viewer PTZ Control Client Audio Monitor/Audio Sending Client [VN-H57/VN-H157WP/VN-H257/VN-H257VP only] 34.3. Method of ActiveX Control JPEG /H.264 Viewer PTZ Control Client Audio Monitor/Audio Sending Client 34.5. HTML Sample Page Page 34.6 Notes 35. PSIA 36. FAQ