JVC 157WP, 257VP, 237 Setting Alarm Action, Format /api/param?application.eventNumber.action=Data

Page 38

Alarm action of event number 10 is “SD Card alarm recording”. When “SD Card alarm recording” is enabled, rec, SD Card number, and the attached object number will be returned. Segments are indicated by /. The SD Card number is fixed as sd01 at all times. The object number is fixed as object(10). Parameters of SD Card recording can be gotten by other APIs, application.object.

Example of Response application.event(10).action=rec/sd01/object(10)&200 OK

Allowed users admin, operator

Setting Alarm Action

Format /api/param?application.event(Number).action=Data

Example When setting action of Alarm No. 1

/api/param?application.event(1).action=mailto/somebody@somecompany.com/none/Message Example of Response

application.event(1).action&202 Accepted(application.event(1).status=restart)

Interpretation Set the alarm action of the specified alarm number. 5 alarm actions, 1 periodic FTP assigned to No.6, 1 pre/post FTP assigned to No.7 are available, 1 SD Card constant recording assigned to No.8 and 1 SD Card alarm recording assigned to No.10 so alarm action number can be 1 to 8 and 10. Note that alarm numbers are different from the alarm input pin numbers. A separate API (/api/param?application.event(Number).status=off) is used to set the alarm action to off.

The action will be activated by setting the alarm trigger. The API for setting the alarm trigger is /api/param?application.event(Number).trigger.

The changes to settings of alarm action become valid by /api/param?application.event(Number).status=restart.

Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify object(Number). If none is specified instead of object(Number), JPEG is not attached to the mail. Number of the 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=mailto/somebody@somecompany.com/object(1)/Message%20O

N

The character string "Alarm from VN-H37" will be stored in the title field of the mail.

38

Page 37 Page 39
Image 38
Page 37 Page 39
Contents VN-H37/137/237/237VP VN-H57/157WP/257/257VP Updates Page Preface JVC API for Alarm FAQ JVC Protocol Jpeg Streaming Basic ProceduresStreaming Protocol API Format Structure Parameter DescriptionResponse RestrictionsJpeg File Format Sent Out by the camera FFD9JVC Protocol H.264 Streaming When API is successfully received H.264 Stream Format Send Out by the cameraExample 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.264Response Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Using API that Requires Basic AuthenticationProcedure Api/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE Getting ParameterApi/param?ParamA.ParamB.ParamC ParamA.ParamB.ParamC=Data&200 OKGetting Camera ID Setting ParameterJVC API for Camera Getting Current Scene File Number Setting Camera IDExample of setting /api/param?camera.id=Camera01 As follows. /api/param?camera.id=Comment%20In%20JPEGGetting Current Scene File Name Getting Preset Data of Scene FileLoading/Saving/Initializing Scene File 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 FileGetting Enhance of a Scene File Setting Enhance of a Scene FileSetting 3DDNR of a Scene File Getting 3DDNR of a Scene FileGetting 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 FileSetting 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 FileGetting 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 FileJVC API for Encode Setting Compression FormatGetting Resolution Frame Size Getting Compression FormatSetting Rate Control Setting Resolution Frame SizeGetting Rate Control Setting Setting Jpeg File Size Setting H.264 or MPEG-4 bitrateGetting Jpeg File Size Setting Getting H.264 or MPEG-4 I-Frame Interval SettingSetting Frame Rate Setting H.264 or MPEG-4 I-Frame IntervalGetting Frame Rate Setting Setting Monitor Out StatusSetting Mike Gain Getting Audio Duplex ModeSetting Audio Duplex Mode JVC API for Audio VN-H57/157WP/257/257VPSetting Mike Power Supply JVC API for AlarmGetting Mike Power Supply setting Getting On/Off of Alarm ActionApi/param?application.event1.action Example of Response Getting Alarm ActionFormat /api/param?application.eventNumber.action Example of Response application.event1.action=&200 OKReturned. Segments are indicated by Format /api/param?application.eventNumber.action=Data Setting Alarm ActionSetting Example To add JPEG, specify objectNumber instead of none Getting Alarm Filter Setting Setting Alarm FilterGetting Alarm Filter Time Setting Alarm Filter TimeGetting Alarm Filter Type Setting Alarm Filter TypeFormat /api/param?application.eventNumber.trigger Getting Alarm TriggerSetting Alarm Trigger Format /api/param?application.eventNumber.trigger=dataSetting Example /api/param?application.event6.trigger=i1500 JVC API for Alarm EnvironmentSetting Example /api/param?application.event1.trigger=v1 Getting Smtp Server Port Number Setting Getting Smtp Server Address SettingSetting Smtp Server Address Setting Smtp Server Port NumberSetting POP before Smtp Setting Sender Mail AddressGetting POP before Smtp Setting Getting POP Server Address SettingSetting POP Server Port Number Setting POP Server AddressGetting POP Server Port Number Setting Getting POP Server User Name SettingSetting FTP Server Address Setting POP Server PasswordGetting FTP Server Address Setting Example of Response application.pop.user&200 OKGetting FTP Server User Name Setting Getting FTP Server Path SettingSetting FTP Server Path Setting FTP Server User NameApi/param?application.ftp.password=%00 Setting FTP Server PasswordSetting File Naming of Periodic FTP Getting File Naming of Periodic FTPGetting Parameters of Pre/Post Recording for FTP Setting User Define Name of File NamingGetting User Define Name of File Naming Getting SD Card Status Setting Parameters of Pre/Post Recording for FTPJVC API for SD Card Record Getting Status of SD Card formatting Setting SD Card to Use/DisableSetting SD Card Constant Recording On/Off Formatting SD CardGetting SD Card Recording Status Setting Encoder No. for SD Card RecordingGetting SD Card Capacity Getting Encoder No. for SD Card RecordingJVC API for Digital PTZ Getting Auto Return ModeSetting Auto Return Mode Setting Auto Return Status Getting Timeout of Auto ReturnSetting Timeout of Auto Return Getting Speed of Going to Preset PositionGetting Pan Position Setting Speed of Going to Preset PositionSetting Direction of Pan Operation Moving to Specified Pan PositionGetting Tilt Position Setting Speed of Pan OperationGetting Pan Operation Status Moving to Specified Tilt PositionGetting Tilt Operation Status Setting Direction of Tilt OperationSetting Speed of Tilt Operation Getting Zoom PositionZoom Operation Setting Direction of Zoom OperationSetting Speed of Zoom Operation Getting Zoom Operation StatusRegister Current Position as Preset Position Getting Current Preset PositionGetting Status of Specified Preset Position Initialize Preset PositionJVC 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 PatrolJVC API for Privacy Masking Setting Speed of Auto PatrolSaving Preset Position Number/Duarion of Auto Patrol Getting Speed of Auto PatrolGetting Privacy Masking Color Setting Privacy Masking to On/OffSetting Privacy Masking Color Getting Privacy Masking AreaGetting Motion Detect Sensitivity Setting Motion Detect to On/OffSetting Motion Detect Sensitivity Getting Motion Detect Mask Setting Motion Detect MaskJVC API for Tampering Detect Getting Tampering Detect On/Off Status Setting Tampering Detect to On/OffSetting Tampering Detect Sensitivity Getting Tampering Detect SensitivitySetting Dhcp Enabling Network Setting ChangesGetting Dhcp Setting Allowed user adminGetting Default Gateway Setting IP AddressSetting Subnet Mask Getting IP AddressSetting DNS Server Status to On/Off, or Validate Changes Setting Default GatewaySetting Host Name Getting Host NameGetting DNS Server IP Address Setting DNS Server IP AddressSetting IPv6 status Getting IPv6 statusGetting MAC Address Setting TOS Value of StreamGetting Global Address of IPv6 Getting TOS Value of StreamGetting Unicast TTL Value Setting Unicast TTLSetting Multicast TTL Getting Multicast TTL ValueSetting Network Negotiation Setting MTU ValueGetting Network Negotiation Setting JVC API for ProtocolSetting Status of Psia Protocol Setting Port Number of HttpSetting Status of AMX Discovery Protocol Getting Status of AMX Discovery ProtocolJVC API for Multicast Streaming Setting Status of Onvif ProtocolSetting Status of Multicast Streaming, or Save Changes Getting Status of Onvif ProtocolGetting Multicast Address Setting Multicast AddressSetting Multicast Port Number Getting Multicast Port NumberGetting Audio Multicast Address Setting Frame Rate of Jpeg MulticastGetting Status of Audio Multicast Streaming Setting Audio Multicast Port Number JVC API for Access RestrictionsSetting Audio Multicast Address Getting Deny/Allow Setting of Client RestrictionsSetting IP Address of Restricted Client Setting Client Restriction to Deny/AllowGetting IP Address Setting of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumberJVC API for Time Setting On/Off of Sntp Client, or Validate ChangesSetting NTP Server Address Getting On/Off of Sntp ClientGetting Access Interval Unit of NTP Getting Access Interval to NTP ServerSetting Access Interval to NTP Server Setting Access Interval Unit of SntpSetting Time Getting TimezoneSetting Password of admin JVC API for PasswordSetting Timezone Format /api/param?system.password.adminnum=data2Setting Password of user JVC API for MaintenanceSetting Password of operator Delete AcountJVC API for LED Setting JVC API for Getting Status Getting LED blinking modeSetting LED blinking mode Getting Sending StatusGetting Model Name Alarm input 1ch makeGetting Log Format /api/param?system.logJVC API for Others Getting Alarm Input Status VN-H57/157/257Getting Mode of FTP Server Getting Firmware RevisionsSetting Port Number of Rtsp Server Setting Mode of FTP ServerSetting Control Port Number of FTP Server Getting Control Port Number of FTP ServerExample /api/param?network.rtsp.port=554 Camera Response When API is successfully received Sending Audio to the Camera VN-H57/157WP/257/257VPProcedures CameraGetting SD Card data from the Camera via RTSP/RTP Playback controlExample of message sequence 1fCRLF Exporting H.264 data from SD Card to the PCGetting Total Number of Files and File Size Exporting SD Card Data as a File List of ActiveX List of Protocols and Port Numbers UsedCustomizing Built-in Viewer Protocol / Port Number UseHow to download ActiveX controls Properties of ActiveX102 Direction Number of n How to use ActiveX Control by HtmlMethod of ActiveX Control Html Sample Sample code105 106 107 FAQ Psia
Top Page Image Contents