JVC 257VP, 137, 237VP, VN-H57, 157WP, VN-H37 instruction

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)

Page 1

Image 1

JVC specifications VN-H37/137/237/237VP VN-H57/157WP/257/257VP

Contents

VN-H37/137/237/237VP VN-H57/157WP/257/257VP Updates Page Preface JVC API for Alarm FAQ Streaming Protocol Basic ProceduresJVC Protocol Jpeg Streaming Parameter Description API Format Structure Restrictions Response FFD9 Jpeg File Format Sent Out by the camera JVC Protocol H.264 Streaming H.264 Stream Format Send Out by the camera When API is successfully received Example of H.264 Stream JVC Protocol MPEG-4 Streaming MPEG-4 Stream Format Send Out by the camera Example of MPEG-4 Stream URI API to Search CameraJpeg H.264 Procedure Using API that Requires Basic AuthenticationResponse Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Api/param?ParamA.ParamB.ParamC Getting ParameterApi/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE ParamA.ParamB.ParamC=Data&200 OK JVC API for Camera Setting ParameterGetting Camera ID Example of setting /api/param?camera.id=Camera01 Setting Camera IDGetting Current Scene File Number As follows. /api/param?camera.id=Comment%20In%20JPEG Loading/Saving/Initializing Scene File Getting Preset Data of Scene FileGetting Current Scene File Name Setting Color Level of a Scene File Setting Auto Exposure Reference of a Scene FileGetting Auto Exposure Reference of a Scene File Getting Color Level of a Scene File Setting 3DDNR of a Scene File Setting Enhance of a Scene FileGetting Enhance of a Scene File Getting 3DDNR of a Scene File Setting R-Gain of White Balance of a Scene File Setting White Balance of a Scene FileGetting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene File Setting AGC of a Scene File Setting B-Gain of White Balance of a Scene FileSetting Limit of Sense Up of a Scene File Getting AGC of a Scene File Setting Shutter Speed of a Scene File Setting ALC priority of Scene FileGetting ALC priority of Scene File Getting Shutter Speed of a Scene FilePage Setting Clvi of a Scene File Setting Back Light Compensation of a Scene FileGetting Back Light Compensation of a Scene File Getting Clvi of a Scene File Getting Resolution Frame Size Setting Compression FormatJVC API for Encode Getting Compression Format Getting Rate Control Setting Setting Resolution Frame SizeSetting Rate Control Getting Jpeg File Size Setting Setting H.264 or MPEG-4 bitrateSetting Jpeg File Size Getting H.264 or MPEG-4 I-Frame Interval Setting Getting Frame Rate Setting Setting H.264 or MPEG-4 I-Frame IntervalSetting Frame Rate Setting Monitor Out Status Setting Audio Duplex Mode Getting Audio Duplex ModeSetting Mike Gain JVC API for Audio VN-H57/157WP/257/257VP Getting Mike Power Supply setting JVC API for AlarmSetting Mike Power Supply Getting On/Off of Alarm Action Format /api/param?application.eventNumber.action Getting Alarm ActionApi/param?application.event1.action Example of Response Example of Response application.event1.action=&200 OK Returned. Segments are indicated by Setting Example Setting Alarm ActionFormat /api/param?application.eventNumber.action=Data To add JPEG, specify objectNumber instead of none Setting Alarm Filter Getting Alarm Filter Setting Setting Alarm Filter Time Getting Alarm Filter Time Setting Alarm Filter Type Getting Alarm Filter Type Setting Alarm Trigger Getting Alarm TriggerFormat /api/param?application.eventNumber.trigger Format /api/param?application.eventNumber.trigger=data Setting Example /api/param?application.event1.trigger=v1 JVC API for Alarm EnvironmentSetting Example /api/param?application.event6.trigger=i1500 Setting Smtp Server Address Getting Smtp Server Address SettingGetting Smtp Server Port Number Setting Setting Smtp Server Port Number Getting POP before Smtp Setting Setting Sender Mail AddressSetting POP before Smtp Getting POP Server Address Setting Getting POP Server Port Number Setting Setting POP Server AddressSetting POP Server Port Number Getting POP Server User Name Setting Getting FTP Server Address Setting Setting POP Server PasswordSetting FTP Server Address Example of Response application.pop.user&200 OK Setting FTP Server Path Getting FTP Server Path SettingGetting FTP Server User Name Setting Setting FTP Server User Name Setting File Naming of Periodic FTP Setting FTP Server PasswordApi/param?application.ftp.password=%00 Getting File Naming of Periodic FTP Getting User Define Name of File Naming Setting User Define Name of File NamingGetting Parameters of Pre/Post Recording for FTP JVC API for SD Card Record Setting Parameters of Pre/Post Recording for FTPGetting SD Card Status Setting SD Card Constant Recording On/Off Setting SD Card to Use/DisableGetting Status of SD Card formatting Formatting SD Card Getting SD Card Capacity Setting Encoder No. for SD Card RecordingGetting SD Card Recording Status Getting Encoder No. for SD Card Recording Setting Auto Return Mode Getting Auto Return ModeJVC API for Digital PTZ Setting Timeout of Auto Return Getting Timeout of Auto ReturnSetting Auto Return Status Getting Speed of Going to Preset Position Setting Direction of Pan Operation Setting Speed of Going to Preset PositionGetting Pan Position Moving to Specified Pan Position Getting Pan Operation Status Setting Speed of Pan OperationGetting Tilt Position Moving to Specified Tilt Position Setting Speed of Tilt Operation Setting Direction of Tilt OperationGetting Tilt Operation Status Getting Zoom Position Setting Speed of Zoom Operation Setting Direction of Zoom OperationZoom Operation Getting Zoom Operation Status Getting Status of Specified Preset Position Getting Current Preset PositionRegister Current Position as Preset Position Initialize Preset Position JVC API for Auto Patrol Setting Preset Postion Number of Auto Patrol Getting Preset Postion Number of Auto PatrolSetting Duarion of Auto Patrol Getting Duration of Auto Patrol Saving Preset Position Number/Duarion of Auto Patrol Setting Speed of Auto PatrolJVC API for Privacy Masking Getting Speed of Auto Patrol Setting Privacy Masking Color Setting Privacy Masking to On/OffGetting Privacy Masking Color Getting Privacy Masking Area Setting Motion Detect Sensitivity Setting Motion Detect to On/OffGetting Motion Detect Sensitivity JVC API for Tampering Detect Setting Motion Detect MaskGetting Motion Detect Mask Setting Tampering Detect Sensitivity Setting Tampering Detect to On/OffGetting Tampering Detect On/Off Status Getting Tampering Detect Sensitivity Getting Dhcp Setting Enabling Network Setting ChangesSetting Dhcp Allowed user admin Setting Subnet Mask Setting IP AddressGetting Default Gateway Getting IP Address Setting Host Name Setting Default GatewaySetting DNS Server Status to On/Off, or Validate Changes Getting Host Name Setting IPv6 status Setting DNS Server IP AddressGetting DNS Server IP Address Getting IPv6 status Getting Global Address of IPv6 Setting TOS Value of StreamGetting MAC Address Getting TOS Value of Stream Setting Multicast TTL Setting Unicast TTLGetting Unicast TTL Value Getting Multicast TTL Value Getting Network Negotiation Setting Setting MTU ValueSetting Network Negotiation JVC API for Protocol Setting Status of AMX Discovery Protocol Setting Port Number of HttpSetting Status of Psia Protocol Getting Status of AMX Discovery Protocol Setting Status of Multicast Streaming, or Save Changes Setting Status of Onvif ProtocolJVC API for Multicast Streaming Getting Status of Onvif Protocol Setting Multicast Port Number Setting Multicast AddressGetting Multicast Address Getting Multicast Port Number Getting Status of Audio Multicast Streaming Setting Frame Rate of Jpeg MulticastGetting Audio Multicast Address Setting Audio Multicast Address JVC API for Access RestrictionsSetting Audio Multicast Port Number Getting Deny/Allow Setting of Client Restrictions Getting IP Address Setting of Restricted Client Setting Client Restriction to Deny/AllowSetting IP Address of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumber Setting NTP Server Address Setting On/Off of Sntp Client, or Validate ChangesJVC API for Time Getting On/Off of Sntp Client Setting Access Interval to NTP Server Getting Access Interval to NTP ServerGetting Access Interval Unit of NTP Setting Access Interval Unit of Sntp Getting Timezone Setting Time Setting Timezone JVC API for PasswordSetting Password of admin Format /api/param?system.password.adminnum=data2 Setting Password of operator JVC API for MaintenanceSetting Password of user Delete Acount JVC API for LED Setting Setting LED blinking mode Getting LED blinking modeJVC API for Getting Status Getting Sending Status Getting Log Alarm input 1ch makeGetting Model Name Format /api/param?system.log Getting Mode of FTP Server Getting Alarm Input Status VN-H57/157/257JVC API for Others Getting Firmware Revisions Setting Control Port Number of FTP Server Setting Mode of FTP ServerSetting Port Number of Rtsp Server Getting Control Port Number of FTP Server Example /api/param?network.rtsp.port=554 Camera Sending Audio to the Camera VN-H57/157WP/257/257VP Response When API is successfully received Camera Procedures Playback control Getting SD Card data from the Camera via RTSP/RTP Example of message sequence Getting Total Number of Files and File Size Exporting H.264 data from SD Card to the PC1fCRLF Exporting SD Card Data as a File Customizing Built-in Viewer List of Protocols and Port Numbers UsedList of ActiveX Protocol / Port Number Use Properties of ActiveX How to download ActiveX controls 102 Method of ActiveX Control How to use ActiveX Control by HtmlDirection Number of n Sample code Html Sample 105 106 107 Psia FAQ