Overview; Style Convention - LevelOne FCS-1040 User Manual

Overview

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 in italic 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 written in bold face 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/video.jpg
Description of returned data is written with "Return:" in bold face followed by the
returned data in a 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:" in bold face followed by a short
description and a light grey box with the example.
- 74 -