JVC 257VP, 137, 237VP, VN-H57, 157WP, VN-H37 API Format Structure, Parameter Description

Page 8

4) When the client wants to stop current JPEG transmission, the client disconnects TCP80.

The camera does not accept further API via current TCP that is used for JPEG transmission. To change parameter, disconnect current TCP to stop the JPEG transmission, connect new TCP, and send API with new parameter.

2.2.API Format Structure

GET	space	API	space	HTTP/1.1

Host:	space	IP Address of Camera	0x0D 0x0A 0x0D 0x0A

0x0D 0x0A

Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.

Example

GET /api/video?encode=jpeg(1)&framerate=5&server_push=on HTTP/1.1<CRLF>

Host: 192.168.0.2<CRLF><CRLF>

Parameter value is indicated using =. Do not insert space before and after =.

Example framerate=1

Parameters are segmented using &. Do not insert space before and after &.

Example encode=jpeg&framerate=5

There is no need to specify all parameters. Default values will be used for parameters that are not specified.

Parameter Description

encode For specifying compression format with channel number. For example, specify as encode=jpeg(1) to get JPEG encoded by channel 1. To know compression format of each channel, open Encoder setting page by IE described in INSTRUCTIONS manual, or issue "encode" API described in later chapter of this document. framerate For specifying the frame rate. For example, specify as framerate=5 to get at 5 fps. Specify as framerate=-5 to get at 1/5 fps, or in other words, 1 frame in 5 seconds. Selection range for JPEG is as follows. 30, 15, 10, 7.5, 5, 3, 2, 1, 0, -2, -3, -5, -10, -15, -20, -30, -60

When the parameter is specified as framerate=0, the camera sends 1 frame of JPEG data, and disconnect the TCP connection.

server_push For specifying streaming structure. For example, specify as server_push=on to get Server Push

8

Image 8

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 API to Search Camera URIJpeg H.264Response Example System.id=VN-H37192.168.0.2/24&200 Okcrlf Using API that Requires Basic AuthenticationProcedure Getting Parameter Api/param?ParamA.ParamB.ParamCApi/param?ParamA.ParamB.ParamC&ParamA.ParamD.ParamE ParamA.ParamB.ParamC=Data&200 OKGetting Camera ID Setting ParameterJVC API for Camera Setting Camera ID Example of setting /api/param?camera.id=Camera01Getting Current Scene File Number As follows. /api/param?camera.id=Comment%20In%20JPEGGetting Current Scene File Name Getting Preset Data of Scene FileLoading/Saving/Initializing Scene File Setting Auto Exposure Reference of a Scene File Setting Color Level of a Scene FileGetting Auto Exposure Reference of a Scene File Getting Color Level of a Scene FileSetting Enhance of a Scene File Setting 3DDNR of a Scene FileGetting Enhance of a Scene File Getting 3DDNR of a Scene FileSetting White Balance of a Scene File Setting R-Gain of White Balance of a Scene FileGetting R-Gain of White Balance of a Scene File Getting B-Gain of White Balance of a Scene FileSetting B-Gain of White Balance of a Scene File Setting AGC of a Scene FileSetting Limit of Sense Up of a Scene File Getting AGC of a Scene FileSetting ALC priority of Scene File Setting Shutter Speed of a Scene FileGetting ALC priority of Scene File Getting Shutter Speed of a Scene FilePage Setting Back Light Compensation of a Scene File Setting Clvi of a Scene FileGetting Back Light Compensation of a Scene File Getting Clvi of a Scene FileSetting Compression Format Getting Resolution Frame SizeJVC API for Encode Getting Compression FormatSetting Rate Control Setting Resolution Frame SizeGetting Rate Control Setting Setting H.264 or MPEG-4 bitrate Getting Jpeg File Size SettingSetting Jpeg File Size Getting H.264 or MPEG-4 I-Frame Interval SettingSetting H.264 or MPEG-4 I-Frame Interval Getting Frame Rate SettingSetting Frame Rate Setting Monitor Out StatusGetting Audio Duplex Mode Setting Audio Duplex ModeSetting Mike Gain JVC API for Audio VN-H57/157WP/257/257VPJVC API for Alarm Getting Mike Power Supply settingSetting Mike Power Supply Getting On/Off of Alarm ActionGetting Alarm Action Format /api/param?application.eventNumber.actionApi/param?application.event1.action Example of Response 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 TypeGetting Alarm Trigger Setting Alarm TriggerFormat /api/param?application.eventNumber.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 Address Setting Setting Smtp Server AddressGetting Smtp Server Port Number Setting Setting Smtp Server Port NumberSetting Sender Mail Address Getting POP before Smtp SettingSetting POP before Smtp Getting POP Server Address SettingSetting POP Server Address Getting POP Server Port Number SettingSetting POP Server Port Number Getting POP Server User Name SettingSetting POP Server Password Getting FTP Server Address SettingSetting FTP Server Address Example of Response application.pop.user&200 OKGetting FTP Server Path Setting Setting FTP Server PathGetting FTP Server User Name Setting Setting FTP Server User NameSetting FTP Server Password Setting File Naming of Periodic FTPApi/param?application.ftp.password=%00 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 Setting SD Card to Use/Disable Setting SD Card Constant Recording On/OffGetting Status of SD Card formatting Formatting SD CardSetting Encoder No. for SD Card Recording Getting SD Card CapacityGetting SD Card Recording Status Getting Encoder No. for SD Card RecordingJVC API for Digital PTZ Getting Auto Return ModeSetting Auto Return Mode Getting Timeout of Auto Return Setting Timeout of Auto ReturnSetting Auto Return Status Getting Speed of Going to Preset PositionSetting Speed of Going to Preset Position Setting Direction of Pan OperationGetting Pan Position Moving to Specified Pan PositionSetting Speed of Pan Operation Getting Pan Operation StatusGetting Tilt Position Moving to Specified Tilt PositionSetting Direction of Tilt Operation Setting Speed of Tilt OperationGetting Tilt Operation Status Getting Zoom PositionSetting Direction of Zoom Operation Setting Speed of Zoom OperationZoom Operation Getting Zoom Operation StatusGetting Current Preset Position Getting Status of Specified Preset PositionRegister Current Position as Preset Position Initialize Preset PositionJVC API for Auto Patrol Getting Preset Postion Number of Auto Patrol Setting Preset Postion Number of Auto PatrolSetting Duarion of Auto Patrol Getting Duration of Auto PatrolSetting Speed of Auto Patrol Saving Preset Position Number/Duarion of Auto PatrolJVC API for Privacy Masking Getting Speed of Auto PatrolSetting Privacy Masking to On/Off Setting Privacy Masking ColorGetting 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 Setting Tampering Detect to On/Off Setting Tampering Detect SensitivityGetting Tampering Detect On/Off Status Getting Tampering Detect SensitivityEnabling Network Setting Changes Getting Dhcp SettingSetting Dhcp Allowed user adminSetting IP Address Setting Subnet MaskGetting Default Gateway Getting IP AddressSetting Default Gateway Setting Host NameSetting DNS Server Status to On/Off, or Validate Changes Getting Host NameSetting DNS Server IP Address Setting IPv6 statusGetting DNS Server IP Address Getting IPv6 statusSetting TOS Value of Stream Getting Global Address of IPv6Getting MAC Address Getting TOS Value of StreamSetting Unicast TTL Setting Multicast TTLGetting Unicast TTL Value Getting Multicast TTL ValueSetting MTU Value Getting Network Negotiation SettingSetting Network Negotiation JVC API for ProtocolSetting Port Number of Http Setting Status of AMX Discovery ProtocolSetting Status of Psia Protocol Getting Status of AMX Discovery ProtocolSetting Status of Onvif Protocol Setting Status of Multicast Streaming, or Save ChangesJVC API for Multicast Streaming Getting Status of Onvif ProtocolSetting Multicast Address Setting Multicast Port NumberGetting Multicast Address Getting Multicast Port NumberGetting Audio Multicast Address Setting Frame Rate of Jpeg MulticastGetting Status of Audio Multicast Streaming JVC API for Access Restrictions Setting Audio Multicast AddressSetting Audio Multicast Port Number Getting Deny/Allow Setting of Client RestrictionsSetting Client Restriction to Deny/Allow Getting IP Address Setting of Restricted ClientSetting IP Address of Restricted Client Format /api/param?network.accesscontrolstreamout.hostNumberSetting On/Off of Sntp Client, or Validate Changes Setting NTP Server AddressJVC API for Time Getting On/Off of Sntp ClientGetting Access Interval to NTP Server Setting Access Interval to NTP ServerGetting Access Interval Unit of NTP Setting Access Interval Unit of SntpSetting Time Getting TimezoneJVC API for Password Setting TimezoneSetting Password of admin Format /api/param?system.password.adminnum=data2JVC API for Maintenance Setting Password of operatorSetting Password of user Delete AcountJVC API for LED Setting Getting LED blinking mode Setting LED blinking modeJVC API for Getting Status Getting Sending StatusAlarm input 1ch make Getting LogGetting Model Name Format /api/param?system.logGetting Alarm Input Status VN-H57/157/257 Getting Mode of FTP ServerJVC API for Others Getting Firmware RevisionsSetting Mode of FTP Server Setting Control Port Number of FTP ServerSetting Port Number of Rtsp 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 Protocols and Port Numbers Used Customizing Built-in ViewerList of ActiveX 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