AxisAPI legacy

Elphel 3x3 cameras have own implementation of Axis Video API version 2.xx.

The HTTP-based video interface provides the functionality for requesting single and multi-part images and for getting and setting internal parameter values. The image and CGI-requests are handled by the built-in Web server in the cameras.

Elphel Axis Video API extension proposes some additional possibility. For example, functionality for requesting RTP MJPEG, HTTP Ogg/Theora or RTP Ogg/Theora video streaming.

For more information see First_Acquaintance_With_Video_API.Ru (in Russian, but will be translate in future).

API GROUPS

General

Add, update, remove and list parameters and their values

Elphel cameras support some of Axis Video Parameters and the certain quantity of own AxisVideoParameters.

List parameters

Fully implemented.

List output format

Fully implemented.

Update parameters

Fully implemented.

Add parameters

Not implemented.

Remove parameters

Not implemented.

Add/Remove server responses

Not implemented.

Add, modify and delete users

Fully implemented.

Factory default

In development.

Hard factory default

In development.

Backup

In development.

Restore

In development.

Firmware upgrade

Not implement.

Restart server

Fully implemented.

Server report

Partially implemented.

System logs

Fully implemented.

System date and time

Get system date and time

Fully implemented.

Set system date and time

Fully implemented.

Image and Video

Image size

Fully implemented.

Video status

Not implemented. It has the sense only for video servers.

Bitmap

Not implemented. But it can be added in future if somebody has need in it.

JPEG/MJPG

JPEG image request

Fully implemented.

JPEG image (snapshot) CGI request

Partially implemented. Some parameters will be implemented in the future.

Syntax:

http://<servername>/axis-cgi/jpg/image.cgi[?<parameter>=<value>[&<parameter>=<value>...]]

Parameter	Description	Values	Implemented?
resolution	Specify the resolution of the returned image	Product-dependent	Yes
camera	Applies only to video servers with more than one video input. Selects the source camera.	-	No
compression	Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size.	0..100	Yes
colorlevel	Sets level of color or grey-scale. 0 = grey-scale, 100 = full color.	0..100	Yes
color	Enables/disables color. 0 = black and white, 1 = color.	0, 1	Yes
clock	Shows/hides the time stamp. 0 = hide, 1 = show.	0, 1	No
date	Shows/hides the date. 0 = hide, 1 = show.	0, 1	No
rotation	Rotates the image clockwise.	0, 180	Yes
text	Shows/hides the text. 0 = hide, 1 = show.	0, 1	No
textstring	The text shown in the image, the string must be URL encoded.	A string	No
textcolor	The color of the text shown in the image.	black, white	No
textbackgroundcolor	The color of the text background shown in the image.	black, white, transparent, semitransparent	No
textpos	The position of the string shown in the image.	top, bottom	No
overlayimage	Enable/disable overlay image.	0, 1	No
overlaypos	Set the position of the overlay image.	<xoffset>x<yoffset>	No
squarepixel	Enable/disable square pixel correction. Applies only to video servers.	0, 1	No

JPEG image response

Fully implemented.

JPEG buffer request

Not implemented.

MJPG video request

Fully implemented.

MJPG video CGI request

Partially implemented. Some parameters will be implemented in the future.

Syntax:

http://<servername>/axis-cgi/mjpg/video.cgi[?<parameter>=<value>[&<parameter>=<value>...]]

Parameter	Description	Values	Implemented?
resolution	Specify the resolution of the returned image	Product-dependent	Yes
camera	Applies only to video servers with more than one video input. Selects the source camera.	-	No
compression	Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size.	0..100	Yes
colorlevel	Sets level of color or grey-scale. 0 = grey-scale, 100 = full color.	0..100	Yes
color	Enables/disables color. 0 = black and white, 1 = color.	0, 1	Yes
clock	Shows/hides the time stamp. 0 = hide, 1 = show.	0, 1	No
date	Shows/hides the date. 0 = hide, 1 = show.	0, 1	No
rotation	Rotates the image clockwise.	0, 180	Yes
text	Shows/hides the text. 0 = hide, 1 = show.	0, 1	No
textstring	The text shown in the image, the string must be URL encoded.	A string	No
textcolor	The color of the text shown in the image.	black, white	No
textbackgroundcolor	The color of the text background shown in the image.	black, white, transparent, semitransparent	No
textpos	The position of the string shown in the image.	top, bottom	No
overlayimage	Enable/disable overlay image.	0, 1	No
overlaypos	Set the position of the overlay image.	<xoffset>x<yoffset>	No
squarepixel	Enable/disable square pixel correction. Applies only to video servers.	0, 1	No
duration	Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.	0, ...	Yes
nbrofframes	Specifies how many frames the server will generate and push. 0 = unlimited.	0, ...	Yes
fps	Using fps it is possible to specify the frame rate from the server. 0 = unlimited.	0, ...	Yes