HTTP API. Vacron VIH 1.3M IPCam

Transcription

1 HTTP API Vacron VIH 1.3M IPCam 1

2 Content Video Stream and Syntax... 3 Network... 5 Video... 6 Camera... 7 Audio... 7 Date Time... 8 Account... 9 Restart... 9 PTZ Motion Detection Revision Record Date Revision Session Number Change Description Version Add event notification over HTTP including motion detection and wire input alarm. For VIH v3.2.1 or later Feb PTZ preset name 2. Device Information For VIT v or later. 2

3 Video Stream and Syntax HTTP authentication method Digest or Basic. Video Stream: HTTP mainstream Response: HTTP multipart video frames Example: HTTP substream Example: RTSP mainstream rtsp://<ipcam>/video0.sdp Example: rtsp:// /video0.sdp RTSP substream rtsp://<ipcam>/video1.sdp Example: rtsp:// /video1.sdp Get snapshot: Syntax: Response: JPEG Example: Set Parameter Syntax: Response: OK parameter Example: OK wantype Get Parameter value Syntax: Response: OK parameter=value Example: OK wantype=1 3

4 Set multi-parameters in a single request Syntax: Response: OK prmt1 OK prmt2 OK prmt3 Example: OK wantype OK netip OK netmask OK gateway Get multi-parameters value in a single request Syntax: Response: OK prmt1=value1 OK prmt2=value2 OK prmt3=value3 Example: OK VideoResolution1=720P OK framerate1=24 OK bitrate1=3000 Event notification over HTTP including motion detection and wire input alarm. Syntax: Response: IPCam keeps sending continous HTTP multipart contents every 2 seconds. Name Value Description md 0: off Event motion detection is triggered or not. 1: on input1 0: off Event input 1 is triggered or not. 1: on input2 0: off 1: on Event input 2 is triggered or not. Example: Get device information. Syntax: 4

5 Network WAN Type wantype 1: Static IP 2: DHCP Hostname dhcphostname MTU (DHCP) mtu2 IP Address netip Subnet Mask netmask Default gateway IP gateway MTU (Static IP) mtu1 Primary DNS dnsip Server Secondary DNS Server dnsip2 5

6 Video Camera title Upto 11 characters Stream 1 Resolution VideoResolution1 SXGA: 1280x P: 1280x720 VGA: 640x480 SIF: 352x240 Framerate framerate Bit Rate bitrate1 Unit: Kbps Stream2 Resolution VideoResolution2 SXGA: 1280x P: 1280x720 VGA: 640x480 SIF: 352x240 Framerate framerate Bit Rate bitrate2 Unit: Kbps Date datestampenable1 0: Disable 1: Enable Mirror mirctrl 0: OFF 1: HORIZONTAL 2: VERTICAL 3: BOTH Example: Set Stream1 with following parameters: le1=1 6

7 Camera Brightness brightness Contrast contrast Saturation saturation Sharpness sharpness Flicker Control flickerctrl 0: 60Hz 1: 50Hz ColorMode colormode 0: Day 1: Auto Audio Enable Audio audioenable 0: Disable 1: Enable Audio Mode audiomode 0: Only Mic (IPCam to PC/NVR) Input Gain audioinvolume 0-60 Encoding audioencoding 0: G.711 1: PCM 7

8 Date Time Synchroize with Time Servers ntpenable 0: Disable 1: Enable SNTP Server sntpip FQDN or IP of NTP Server Time Zone timezone 0: +0-60: -1 60: : : : : : : : : : : : : : : : : : : : : : : newdate newtime yyyy/mm/dd Example: 2212/07/04 hh:mm:ss Example: 13:10:30 Set Date/Time with assigned value to IPCam 8

9 Account Admin Username adminid Upto 30 characters Password adminpwd Upto 16 characters Operator operatorid Upto 30 characters username Password operatorpwd Upto 16 characters Viewer Username viewerid Upto 30 characters Password viewerpwd Upto 16 characters HTTP Port httpport Sync With NVR SyncWithNvr 0: Disable 1: Enable If this option is set to be 0 that the IP Camera will not accept other HTTP API command anymore until you enable this option from web GUI. Restart GUI Item SDK Parameter Remark Restart ipcamrestartcmd Restart IPCam Please send this command later than 10 seconds after you send the last setting command. 9

10 PTZ Protocol ptzprotocol 0: OFF Device ID ptzaddr 0-3 1: PelcoP 2: PelcoD Baud Rate ptzbaud 0: : : : : PTZ Speed ptzspeed 0-23 Example: ptzpreset=# presetname=xxx ipncptz=14 ptzpreset=# ipncptz=17 ptzpreset=# ipncptz=15 # >= 1 (Location #) Xxx give preset a name 10 Assign PTZ preset location # >= 1 (Location #) Locate to a preset location. # >= 1 (Location #) Clear a PTZ preset location ptzpresets Without value List all preset location ipncptz 16 Clear all preset location ipncptz 0: STOP Move PTZ 1: LEFT 2: RIGHT 3: UP 4: DOWN 5: IRISDEC 6: IRISINC 7: ZOOMDEC 8: ZOOMINC 9: FOCUSDEC 10: FOCUSINC 21: LEFT UP 22: LEFT DOWN 23: RIGHT UP 24: RIGHT DOWN Preset location #1 - Locate to location #1 -

11 Clear preset location #1 - List all preset location OK ptzpresets= 1,xxxx 2,yyyy 3,zzzz 11

12 Motion Detection Motion Detection motionenable 0: Disable (Sensitivity Mode Radio Button) motioncenable 1: Enable Sensitivity motionsensitivity 0: Low Customized Threshold 0: Drop Down Menu 1: Customized Threshold 1: Medium 2: High motioncvalue (Detecting Block) motionblock It described in 3-digit Hex. The first digit is for first row of detecting area, and so on. 0: 1: 2: 3: 4: 5: 6: 7: 8: 9: A: B: C: D: E: F: Example: Detecting Block 0 6 Value: 06E E 12