JVC VN-H37, 257VP, 137, 237VP, VN-H57, 157WP To add JPEG, specify objectNumber instead of none

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 %.

space & / < > # % " { } \ ^ [ ] `

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=tcpto/10.0.0.100/20000/none/Message

To add JPEG, specify object(Number) instead of “none”.

Setting Example /api/param?application.event(1).action=tcpto/10.0.0.100/20000/object(1)/Message

Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.

space & / < > # % " { } \ ^ [ ] `

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=udpto/10.0.0.100/20000/Message

Specify scene file number when switch scene file is specified.

Setting Example /api/param?application.event(1).action=camera.image.scene(7).status/goto

Specify preset position number when preset position is specified.

Setting Example /api/param?application.event(1).action=camera.position(2).status/goto

[VN-H57/157WP/257/257VP Only] Specify audio file number when audio file playback is specified. The audio file

number can be from 01 to 05.

Setting Example /api/param?application.event(1).action=audioplay/audiofile02/ch01

[VN-H57/157WP/257/257VP Only] Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is specified. Segments are indicated by /. The time is 0 or from 100 to 5000. When the time is 0, alarm output does not come back to previous state.

Setting Example /api/param?application.event(1).action=pinout/m1/1500

Alarm action of event number 6 is periodic FTP. Other Event number can not be set to periodic FTP. Parameters of FTP can be set by another API, application.ftp.

Setting Example /api/param?application.event(6).action=ftpto/ftp01/object(6)

39

Image 39

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 Parameter Description API Format StructureRestrictions ResponseFFD9 Jpeg File Format Sent Out by the cameraJVC Protocol H.264 Streaming H.264 Stream Format Send Out by the camera When API is successfully receivedExample of H.264 Stream JVC Protocol MPEG-4 Streaming MPEG-4 Stream Format Send Out by the camera Example of MPEG-4 Stream H.264 API to Search CameraURI JpegUsing API that Requires Basic Authentication ProcedureResponse Example System.id=VN-H37192.168.0.2/24&200 Okcrlf ParamA.ParamB.ParamC=Data&200 OK Getting ParameterApi/param?ParamA.ParamB.ParamC Api/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamESetting Parameter JVC API for CameraGetting Camera ID As follows. /api/param?camera.id=Comment%20In%20JPEG Setting Camera IDExample of setting /api/param?camera.id=Camera01 Getting Current Scene File NumberGetting Preset Data of Scene File Loading/Saving/Initializing Scene FileGetting Current Scene File Name Getting Color Level of a Scene File Setting Auto Exposure Reference of a Scene FileSetting Color Level of a Scene File Getting Auto Exposure Reference of a Scene FileGetting 3DDNR of a Scene File Setting Enhance of a Scene FileSetting 3DDNR of a Scene File Getting Enhance of a Scene FileGetting B-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 R-Gain of White Balance of a Scene FileGetting AGC of a Scene File Setting B-Gain of White Balance of a Scene FileSetting AGC of a Scene File Setting Limit of Sense Up of a Scene FileGetting Shutter Speed of a Scene File Setting ALC priority of Scene FileSetting Shutter Speed of a Scene File Getting ALC priority of Scene FilePage Getting Clvi of a Scene File Setting Back Light Compensation of a Scene FileSetting Clvi of a Scene File Getting Back Light Compensation of a Scene FileGetting Compression Format Setting Compression FormatGetting Resolution Frame Size JVC API for EncodeSetting Resolution Frame Size Getting Rate Control SettingSetting Rate Control Getting H.264 or MPEG-4 I-Frame Interval Setting Setting H.264 or MPEG-4 bitrateGetting Jpeg File Size Setting Setting Jpeg File SizeSetting Monitor Out Status Setting H.264 or MPEG-4 I-Frame IntervalGetting Frame Rate Setting Setting Frame RateJVC API for Audio VN-H57/157WP/257/257VP Getting Audio Duplex ModeSetting Audio Duplex Mode Setting Mike GainGetting On/Off of Alarm Action JVC API for AlarmGetting Mike Power Supply setting Setting Mike Power SupplyExample of Response application.event1.action=&200 OK Getting Alarm ActionFormat /api/param?application.eventNumber.action Api/param?application.event1.action Example of ResponseReturned. Segments are indicated by Setting Alarm Action Setting ExampleFormat /api/param?application.eventNumber.action=Data To add JPEG, specify objectNumber instead of none Setting Alarm Filter Getting Alarm Filter SettingSetting Alarm Filter Time Getting Alarm Filter TimeSetting Alarm Filter Type Getting Alarm Filter TypeFormat /api/param?application.eventNumber.trigger=data Getting Alarm TriggerSetting Alarm Trigger Format /api/param?application.eventNumber.triggerJVC API for Alarm Environment Setting Example /api/param?application.event1.trigger=v1Setting Example /api/param?application.event6.trigger=i1500 Setting Smtp Server Port Number Getting Smtp Server Address SettingSetting Smtp Server Address Getting Smtp Server Port Number SettingGetting POP Server Address Setting Setting Sender Mail AddressGetting POP before Smtp Setting Setting POP before SmtpGetting POP Server User Name Setting Setting POP Server AddressGetting POP Server Port Number Setting Setting POP Server Port NumberExample of Response application.pop.user&200 OK Setting POP Server PasswordGetting FTP Server Address Setting Setting FTP Server AddressSetting FTP Server User Name Getting FTP Server Path SettingSetting FTP Server Path Getting FTP Server User Name SettingGetting File Naming of Periodic FTP Setting FTP Server PasswordSetting File Naming of Periodic FTP Api/param?application.ftp.password=%00Setting 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 Formatting SD Card Setting SD Card to Use/DisableSetting SD Card Constant Recording On/Off Getting Status of SD Card formattingGetting Encoder No. for SD Card Recording Setting Encoder No. for SD Card RecordingGetting SD Card Capacity Getting SD Card Recording StatusGetting Auto Return Mode Setting Auto Return ModeJVC API for Digital PTZ Getting Speed of Going to Preset Position Getting Timeout of Auto ReturnSetting Timeout of Auto Return Setting Auto Return StatusMoving to Specified Pan Position Setting Speed of Going to Preset PositionSetting Direction of Pan Operation Getting Pan PositionMoving to Specified Tilt Position Setting Speed of Pan OperationGetting Pan Operation Status Getting Tilt PositionGetting Zoom Position Setting Direction of Tilt OperationSetting Speed of Tilt Operation Getting Tilt Operation StatusGetting Zoom Operation Status Setting Direction of Zoom OperationSetting Speed of Zoom Operation Zoom OperationInitialize Preset Position Getting Current Preset PositionGetting Status of Specified Preset Position Register Current Position as Preset PositionJVC API for Auto Patrol Getting Duration of Auto Patrol Getting Preset Postion Number of Auto PatrolSetting Preset Postion Number of Auto Patrol Setting Duarion of Auto PatrolGetting Speed of Auto Patrol Setting Speed of Auto PatrolSaving Preset Position Number/Duarion of Auto Patrol JVC API for Privacy MaskingGetting Privacy Masking Area Setting Privacy Masking to On/OffSetting Privacy Masking Color Getting Privacy Masking ColorSetting 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 Sensitivity Setting Tampering Detect to On/OffSetting Tampering Detect Sensitivity Getting Tampering Detect On/Off StatusAllowed user admin Enabling Network Setting ChangesGetting Dhcp Setting Setting DhcpGetting IP Address Setting IP AddressSetting Subnet Mask Getting Default GatewayGetting Host Name Setting Default GatewaySetting Host Name Setting DNS Server Status to On/Off, or Validate ChangesGetting IPv6 status Setting DNS Server IP AddressSetting IPv6 status Getting DNS Server IP AddressGetting TOS Value of Stream Setting TOS Value of StreamGetting Global Address of IPv6 Getting MAC AddressGetting Multicast TTL Value Setting Unicast TTLSetting Multicast TTL Getting Unicast TTL ValueJVC API for Protocol Setting MTU ValueGetting Network Negotiation Setting Setting Network NegotiationGetting Status of AMX Discovery Protocol Setting Port Number of HttpSetting Status of AMX Discovery Protocol Setting Status of Psia ProtocolGetting Status of Onvif Protocol Setting Status of Onvif ProtocolSetting Status of Multicast Streaming, or Save Changes JVC API for Multicast StreamingGetting Multicast Port Number Setting Multicast AddressSetting Multicast Port Number Getting Multicast AddressSetting Frame Rate of Jpeg Multicast Getting Status of Audio Multicast StreamingGetting Audio Multicast Address Getting Deny/Allow Setting of Client Restrictions JVC API for Access RestrictionsSetting Audio Multicast Address Setting Audio Multicast Port NumberFormat /api/param?network.accesscontrolstreamout.hostNumber Setting Client Restriction to Deny/AllowGetting IP Address Setting of Restricted Client Setting IP Address of Restricted ClientGetting On/Off of Sntp Client Setting On/Off of Sntp Client, or Validate ChangesSetting NTP Server Address JVC API for TimeSetting Access Interval Unit of Sntp Getting Access Interval to NTP ServerSetting Access Interval to NTP Server Getting Access Interval Unit of NTPGetting Timezone Setting TimeFormat /api/param?system.password.adminnum=data2 JVC API for PasswordSetting Timezone Setting Password of adminDelete Acount JVC API for MaintenanceSetting Password of operator Setting Password of userJVC API for LED Setting Getting Sending Status Getting LED blinking modeSetting LED blinking mode JVC API for Getting StatusFormat /api/param?system.log Alarm input 1ch makeGetting Log Getting Model NameGetting Firmware Revisions Getting Alarm Input Status VN-H57/157/257Getting Mode of FTP Server JVC API for OthersGetting Control Port Number of FTP Server Setting Mode of FTP ServerSetting Control Port Number of FTP Server Setting Port Number of Rtsp ServerExample /api/param?network.rtsp.port=554 Camera Sending Audio to the Camera VN-H57/157WP/257/257VP Response When API is successfully receivedCamera ProceduresPlayback control Getting SD Card data from the Camera via RTSP/RTPExample 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 Protocol / Port Number Use List of Protocols and Port Numbers UsedCustomizing Built-in Viewer List of ActiveXProperties of ActiveX How to download ActiveX controls102 How to use ActiveX Control by Html Method of ActiveX ControlDirection Number of n Sample code Html Sample105 106 107 Psia FAQ