Appendix, URL Commands for the Network Camera | Vivotek FD8154

VIVOTEK

Appendix

URL Commands for the Network Camera

1. Overview

For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface. The HTTP-based camera interface provides the functionality to request a single image, control camera functions (PTZ, output relay etc.), and get and set internal parameter values. The image and CGI-requests are handled by the built-in Web server.

2. Style Convention

In URL syntax and in descriptions of CGI parameters, text within angle brackets denotes content that is to be replaced with either a value or a string. When replacing the text string, the angle brackets should also be replaced. An example of this is the description of the name for the server, denoted with <servername> in the URL syntax description below, that is replaced with the string myserver in the URL syntax example further down in the page.

URL syntax is denoted with the word "Syntax:" written in bold face followed by a box with the referenced syntax as shown below. For example, name of the server is written as <servername> and is intended to be replaced with the name of the actual server. This can either be a name, e.g., "mywebcam" or "thecam. adomain.net" or the associated IP number for the server, e.g., 192.168.0.220.

Syntax:

http://<servername>/cgi-bin/viewer/video.jpg

Description of returned data is written with "Return:" in bold face followed by the returned data in a box. All data is returned in HTTP format, i.e., each line is separated with a Carriage Return and Line Feed (CRLF) printed as \r\n.

Return:

HTTP/1.0 <HTTP code> <HTTP text>\r\n

URL syntax examples are written with "Example:" in bold face followed by a short description and a light grey box with the example.

Example: request a single snapshot image

http://mywebserver/cgi-bin/viewer/video.jpg

122 - User's Manual

Image 122

Vivotek FD8154, 8154V user manual Appendix, URL Commands for the Network Camera

Contents

3MP SNV Day & Night 20M IR IP66 FD8154V IK10 FD8154V 3DNR Table of Contents Appendix Overview Revision History Read Before Use Package ContentsSymbols and Statements in this Document Hardware Installtion FD8154 Physical Description Hardware Reset Installation Removing Dome Cover Vivotek Set up the Network Camera through Power over Ethernet PoE Network Deployment Hardware Installtion FD8154V Hardware Installation Wall Mount Ceiling Mount Pan Tilt Rotate Internet connection via a router Software Installation Network Camera To adjust the viewing angle -- 3-axis mechanism design Ready to Use Completion Accessing the Network Camera Using Web Browsers Vivotek Tips Using Rtsp Players Using 3GPP-compatible Mobile Devices Using Vivotek Recording Software Main Configuration Area Resize Buttons Vivotek Go to Video Control Buttons Client Settings MP4 Saving Options Joystick Settings Buttons Configuration Configuration System General settings System System time General settings System Homepage layout Theme Options Vivotek System log Log server settingsSystem Logs Internet Access log System Parameters General settings Reboot System MaintenanceGeneral settings Upgrade firmware General settings Restore Import/Export files Vivotek Tips Media Image Day/Night Settings Image settings Exposure 2014/1/13 IncludeExclude Check Enable this profile Privacy mask Stream settings Media Video MediaNOTE Video X2.1 Vivotek Vivotek Vivotek Audio Settings Media Audio Network General settings Network Type PPPoE Point-to-point over Ethernet Error Router does not support UPnP port forwarding Vivotek Enable IPv6 Http//20010c08250000020202d1fffe0465f4 Port Network Streaming protocols Http streaming Rtsp Streaming VLC Vivotek Network Ddns Express link Manual setup Ddns Dynamic domain name service CustomSafe100 Network QoS Quality of Service Requirements for QoS QoS/DSCP the DiffServ model Snmp Configuration Network Snmp Simple Network Management Protocol Privilege Management Root PasswordSecurity User accounts Account Management Create and Install Certificate Method Security Https Hypertext Transfer Protocol over SSL Https Create certificate request and install Vivotek Vivotek Vivotek Vivotek Security Access List Filter Administrator IP address IP address range 192.168.2.x will be bolcked Maximum length of password is 200 symbols Security Ieee Vivotek PTZ PTZ settings X1.8 X3.3 X1.8 Vivotek Event Event settings Event Trigger Action Add server Vivotek Vivotek Format is Yyyymmdd Format is HH 24r Add media Trigger Activation Video20101213100341 Vivotek Customized Script Follow the steps below to enable motion detection Applications Motion detection Percentage = 30% Vivotek Applications Digital input Applications Tampering detection Applications Vadp Vivotek Application Development Platform Yes No Recording Recording settings Recording Settings Continuous recording NAS server Vivotek 20130210 20130211 20130212 SD card control Local storage SD card managementSD card staus Local storage Content management Searching and Viewing the Records Search Results Click to switch pages URL Commands for the Network Camera Appendix General CGI URL Syntax and Parameters Security Level Get Server Parameter Values Method GET/POST Vivotek Return GroupnameValue to assigned Assign value to the parameter groupname Vivotek Available parameters on the server System Group system Vivotek None Vivotek System.info Status Group status Group dii0~ndi-1 Digital input behavior defineSecurity Group security Network Group network Subgroup of network ieee8021x TLS Subgroup of network ipv6 Subgroup of network qoscosSubgroup of network qosdscp Port Subgroup of network ftpSubgroup of network http Subgroup of network https Subgroup of network rtsp Subgroup of networkrtsps0~n-1multicast, n is stream count Subgroup of network pppoe IP FilterSubgroup of network rtp Group ipfilter IPv6 address list Rbgain indicates using rgain GbainVideo input Group videoin Rbgain indicates using Rgain and gbain Exposurelevel ~12 Exposure level Svc is only supported with Stream Vivotek Alternative video input profiles per channel Group videoinprofilei0~m-1 IR cut control Group ircutcontrol Image setting per channel Group imagec0~n-1for n channel products Schedule mode Audio input per channel Time Shift settingsMotion detection settings Group audioinc0~n-1for n channel products Name Value Default Security Description Tampering detection settings Ddns UPnP port forwarding Express linkUPnP presentation Group upnppresentation Group syslog System logSnmp Group snmp Layout configuration Group layout Group privacymaskc0~n-1for n channel product Privacy maskCapability Group capability Nvideoout Positive Number of video out Integer Interface Vivotek Vivotek Mjpeg Vivotek Audiooutcodec AudiolineoutAudioincodec Transmissionmode DVR Vivotek Name Parameter Value Default Security Description WebAPI Information for a channel Vivotek Resolution in this video mode WebAPI Information for a modeResolution options in this video WxH Get/set Effectivepixel WxH Visible area of full scene Group eventcustomtaskfilei0~2 Event settingCustomized event script Group eventi0~2 Vivotek Path to store media Actioncfmedia NULL, 0~4 Server setting for event action Group serveri0~4 Media setting for event action Group mediai0~4 mediafreespace is used internally Recording Group recordingi0~1 Vivotek Https Group https Storage management setting Group eptzc0~n-1for n channel product EPTZ settingRegion of interest Exposure window setting per channel Group exposurewinc0~n-1for n channel products Name Value Default Security Description Default Seamless recording settingVivotek Application Development Platform setting Group seamlessrecording String40 Group vadpmodulei0~n-1 Useful Functions8.1 Query Status of the Digital Input Di0=state\r\n Di1=state\r\n Di2=state\r\n Di3=state\r\n Capture Single Snapshot Stream number Account Management Method Post Syntax Upgrade FirmwareSystem Logs EPTZ Camera Control Vivotek EPTZ Preset Locations EPTZ Recall IP Filtering IP Filtering for Onvif Event/Control Http Tunnel Channel Method GET Get SDP of StreamsOpen the Network Stream Command search Storage managements Parameter Value Description Command update Return Message Vivotek Ex. Local storage status in javascript format Command queryStatusEx. Local storage status in XML format Http//servername/cgi-bin/admin/downloadMedias.cgi?FilePath FilePath is in queryststus return message Virtual input Return Open Timeshift Stream timeshiftenable=1 Timeshiftcnsmallow=1 Open Anystream Solution CapabilityvideoinresolutionVideo resolution in pixels Codectype Mjpeg, mpeg4, h264 Set codec type for Anystream Input Input setting = worst quality, 5 = best QualityMjpegqvalue 10~200 Manual video quality level ~97 This must be present if Mjpegquant is equal to 0 H264quant is equal to 0 H264qvalue ~51 Manual video quality levelThis must be present if Currentlanguage ~20 Export FilesUpload Files Method Post Start time Etime Media on demandStime Play file file Play recordings for length seconds which start fromPlay recordings for length seconds which ends at End of document Technical Specifications Technical Specifications FD8154V-F2 Technology License Notice AMR-NB Standard Electromagnetic Compatibility EMC Liability