Appendix, URL Commands for the Network Camera | Vivotek FD8169

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

User's Manual - 119

Image 119

Vivotek FD8169 user manual Appendix, URL Commands for the Network Camera

Contents

Rev Table of Contents Revision History Overview Read Before Use Package ContentsSymbols and Statements in this Document Hardware Installation Pan 348º Rotate 345º Tilt 70º Vivotek Hardware Reset General Connection PoE Network Deployment Internet connection via a router Vivotek Network Camera Software Installation Ready to Use Using Web Browsers Accessing the Network Camera Vivotek Tips Using Rtsp Players Using 3GPP-compatible Mobile Devices Using Vivotek Recording Software Main Resize Buttons Configuration Area Vivotek Vivotek Video Title Title and Time Client Settings MP4 Saving Options Joystick settings Buttons Configuration Tips Configuration System System General settings System time System Homepage layout General settings Theme Options Vivotek System log Log server settingsSystem Logs Internet System Parameters Access log General settings Reboot System MaintenanceGeneral settings Upgrade firmware Import/Export files General settings Restore Vivotek Tips Media Image Day/Night Settings Vivotek Exclude Vivotek Image settings Vivotek Exposure Weighted region Ignored region Select Enable this profile Privacy mask Media Video Stream settings Parameters of the multiple streams MediaNOTE Video Vivotek Vivotek Vivotek Network Type Network General settings PPPoE Point-to-point over Ethernet Error Router does not support UPnP port forwarding Vivotek Enable IPv6 Http//20010c08250000020202d1fffe0465f4 Port Http streaming Network Streaming protocols Rtsp Streaming VLC Vivotek Express link Network Ddns Ddns Dynamic domain name service Manual setup CustomSafe100 Requirements for QoS Network QoS Quality of Service QoS/DSCP the DiffServ model Network Snmp Simple Network Management Protocol Snmp Configuration Account Management Root PasswordSecurity User accounts Privilege Management Security Https Hypertext Transfer Protocol over SSL Create and Install Certificate Method Https Create certificate request and install Vivotek Vivotek Vivotek Vivotek Security Access List Filter IP address range 192.168.2.x will be bolcked Administrator IP address Security Ieee Vivotek X1.8 PTZ PTZ settings X3.3 X1.8 Vivotek Event Event Event settings Trigger Action Add server Vivotek Vivotek Format is Yyyymmdd Click to open the directory Format is HH 24r Add media Trigger Activation Video20101213100341 Vivotek Customized Script Applications Motion detection Check Enable this profile Vivotek Applications Tampering detection Check Enable camera tampering detection Recording Settings Recording Recording settings Continuous recording NAS server Vivotek 20140210 20140211 20140212 SD card control Local storage SD card managementSD card staus Searching and Viewing the Records Local storage Content management Search Results Click to switch pages Appendix URL Commands for the Network Camera General CGI URL Syntax and Parameters Security Level Method GET/POST Get Server Parameter Values Vivotek Return GroupnameValue to assigned Assign value to the parameter groupname Vivotek Available parameters on the server Group system System Vivotek None Vivotek System.info Group security StatusSecurity Group status Group network Network TLS Subgroup of network ieee8021x Subgroup of network ipv6 Subgroup of network qoscosSubgroup of network qosdscp Subgroup of network https Subgroup of network ftpSubgroup of network http Port Subgroup of network rtp Subgroup of network rtspSubgroup of networkrtsps0~n-1multicast, n is stream count IPv6 address list IP FilterSubgroup of network pppoe Group ipfilter Group videoin Rbgain indicates using rgain GbainRbgain indicates using Rgain and gbain Video input Bit 1 = Built-in or external Svc is only supported with Stream Maxexposure ~32000 Maximum exposure time S0~m-1forcei Force I frame Group videoinprofilei0~m-1 Alternative video input profiles per channel Group ircutcontrol Image setting per channelSir Boolean Enable/disable Smart IR IR cut control Vivotek Settings Time Shift settingsMotion detection settings According to mode Name Value Default Security Description Ddns Tampering detection settings Group upnppresentation Express linkUPnP port forwarding Groupexpresslink Group snmp System logSnmp Group syslog Group layout Layout configuration Group capability Privacy maskCapability Group privacymaskc0~n-1for n channel product Nvideoout Positive Number of video out Integer Interface Vivotek Vivotek Mjpeg Vivotek Transmissionmode AudiolineoutAudioincodec Audiooutcodec DVR Detection Number of stream that Tracking window Manual in hybrid modeMaximum number Tracking WebAPI Information for a channel Parameter Value Default Security Description Vivotek Get/set Effectivepixel WxH Visible area of full scene WebAPI Information for a mode Group eventcustomtaskfilei0~2 Customized event script Group eventi0~2 Event setting Path to store media Group serveri0~4 Server setting for event action Group mediai0~4 mediafreespace is used internally Media setting for event action Group recordingi0~1 Recording Vivotek Group https Https Storage management setting Group eptzc0~n-1for n channel product EPTZ settingRegion of interest Group exposurewinc0~n-1for n channel products Exposure window setting per channel Name Value Default Security Description Method=value&username=name&userpass=value&privilege=value Capture Single SnapshotAccount Management Stream number Privilege=value…&return=return System Logs Example Upgrade FirmwareEPTZ Camera Control Method Post Syntax Parameter Value Description EPTZ Recall EPTZ Preset Locations IP Filtering IP Filtering for Onvif Event/Control Http Tunnel Channel Method GET Get SDP of StreamsOpen the Network Stream Storage managements Command search Locked file would not be removed from UI or cyclic Indicate if the file is locked or notFile is not locked File is locked Return Message Vivotek Ex. Local storage status in javascript format Command queryStatusEx. Local storage status in XML format FilePath is in queryststus return message Http//servername/cgi-bin/admin/downloadMedias.cgi?FilePath Return Virtual input Timeshiftcnsmallow=1 Open Timeshift Stream timeshiftenable=1 Currentlanguage ~20 Export Files End of document Upload FilesMethod Post Technical Specifications Technical Specifications AMR-NB Standard Technology License Notice Liability Electromagnetic Compatibility EMC