JVC API for Others, Getting Firmware Revisions | JVC 137, 257VP, 237

Allowed users admin, operator, user

Getting Firmware Revisions

Format /api/param?system.software.revision

Example of Response system.software.revision=1.00&200 OK

Interpretation Acquire revisions of the firmware.

Allowed users admin, operator, user

Getting Software ID

Format /api/param?system.software.programid

Response Return software ID.

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. Specify 1 or 2 to Number. Either make or break will be

returned.

Allowed users admin, operator, user

Getting Mode of FTP Server

Format /api/param?application.ftp.mode

Example of Response application.ftp.mode=active&200 OK

Interpretation Acquire the mode of FTP server that is used by alarm action. Either active or passive is returned. 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.

passive mode: TCP connection for data is established from the camera to FTP server. Port number depends on FTP server.

Allowed users admin, operator, user

90

Image 90

JVC 137 JVC API for Others, Getting Firmware Revisions, Getting Software ID, Getting Alarm Input Status VN-H57/157/257

Contents

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