Appendix, Url commands of the network camera – Vivotek NETWORK CAMERA IZ7151 User Manual

Page 72

Advertising
background image

VIVOTEK - A Leading Provider of Multimedia Communication Solutions

7 - User's Manual

Appendix

URL Commands of the Network Camera

Overview

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

Style convention

In URL syntax and in descriptions of CGI parameters, a text within angle brackets denotes a
content that is to be replaced with either a value or a string� When replacing the text string also the
angle brackets shall 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, also below�

URL syntax' are written with the “Syntax:" word followed by a box with the referred syntax as seen
below. The name of the server is written as <servername>. This 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:" followed by the returned data in a light grey
box� All data returned as HTTP formatted, i�e�, starting with the string HTTP is line 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:" 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

General CGI URL syntax and parameters

CGI parameters are written in lower-case and as one word without any underscores or other
separators� When the CGI request includes internal Network Camera parameters, the internal
parameters must be written exactly as they are named in the Network Camera or video server� The
CGIs are organized in function related directories under the cgi-bin directory� The file extension of
the CGI is required�

Advertising