ElphelWiki - User contributions [en]

Video API legacy

2006-12-01T17:45:19Z

Dvdkhlng: /* Multicast */

{{en|ru=First_Acquaintance_With_Video_API.Ru|cn=Video_API_Extensions.cn}}

Anyone who has even the slightest skill at writing HTML pages can use the Axis Video API. And with additional software installed, it is possible to create a powerful video observation system with the capabilities of recording video archives, journalizing, viewing of archives, etc. Note [[Change API]] an how to enable the Video API.

== Information about image dimensions ==
Some default parameters and some which are transferred when the image is obtained can change the image dimensions. For example parameters such as '''resolution, e_dcm_hor, e_dcm_vert, e_woi_width, e_woi_height, e_woi_left, e_woi_top'''. Sometimes a client application needs to know about the dimensions of the received image in advance (for example, for reserving a necessary area in a browser page or application window). You can obtain this information at the address:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?</nowiki>
It is possible to transfer with this script any of the parameters which are supported by image.cgi and video.cgi. For example:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?e_dcm_vert=2&e_dcm_hor=2&e_woi_width=1800</nowiki>
The server response is:

image width = 896
image height = 768

== Static images ==
To retrieve an image from the camera it is enough to type the following path in the browser's address field:

<nowiki>http://192.168.0.9/jpg/image.jpg </nowiki>

'''Note''' 192.168.0.9 - this is the default camera IP-address. If you have changed the camera IP-address, please, type your variant.

It is also possible to ask the camera to send the image with a certain set of parameters. The path which can be used for this:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?param1=xxx&param2=yyy&.....</nowiki>

See the list of accessible parameters below.

'''resolution'''=<string> Specify the resolution of the returned image, for example 800x600. Product-dependent. You can check what values are supported by your camera using the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Resolution</nowiki>''

'''compression'''=<int> Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size. It can take a value from 0 to 100. In many cases 30 is optimal.

'''colorlevel'''=<int> Sets level of color or grey-scale. It can have value from 0 to 100. 0 = grey-scale, 100 = full color.

'''color'''=<int> Enables/disables color. It can have value 0 or 1. 0 = black and white, 1 = color.

'''rotation'''=<int> Rotates the image clockwise. Product-dependent. You can check what values are supported by your camera at the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Rotation</nowiki>''

Apart from the standard parameters, enumerated above, there are some extensions, which make it possible to use the Elphel cameras more flexibly. You can read more detailed information about these extensions at [[Video API Extensions]].

Example of obtaining an image with the assigned set of parameters:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?resolution=1024x768&colorlrvel=45&compression=30</nowiki>

If some parameters are not assigned, the default value is used. You can see the default values at the address:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Image.I0.Appearance</nowiki>

You can change the default values. For this it is necessary to specify the parameter action=update. For example:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Appearance.Resolution=512x384&Image.I0.Appearance.Rotation=180&ColorEnabled=no&Image.I0.Appearance.Compression=50</nowiki>

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ColorLevel=60</nowiki>

==Video stream==

The cameras can be used to receive a continuous video stream. This stream can be transferred by two protocols - HTTP and RTP.

===HTTP===
====Jpeg====
The stream is a sequence of jpeg-files, separated by a special marking line. This transfer format is named Multipart Jpeg or MPJPG. For receiving a stream in this format you can use the following path:
<nowiki>http://192.168.0.9/mjpg/video.mjpg</nowiki>
As with static images, you can also assign parameters for the video stream. For this you can use the following path:
<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?param1=xxx&param2=yyy&.....</nowiki>
Apart from the parameters, enumerated above, such as '''resolution, compression, colorlevel, color, rotation''', you can also assign:

'''duration=<int>''' Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.

'''nbrofframes=<int>''' Specifies how many frames the server will generate and push. 0 = unlimited.

'''fps=<int>''' Using fps it is possible to specify the frame rate from the server. 0 = unlimited.

By default all these parameters are assigned to 0. You can change the default settings, for example, in this way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Stream.Duration=100&Image.I0.Stream.FPS=5&Image.I0.Stream.NbrOfFrames=1000</nowiki>

Apart from the standard parameters, enumerated above, there are extensions, which allow you to use the Elphel cameras more flexibly. More detailed information about these extensions can be found at [[Video API Extensions]].

On the page [[Video API And Client Applications]] you can find some information about players, which can play the MPJPG video stream.

====Theora====

===RTP===
====Video Parameters====
Note that due to obscure reasons, parameters set via

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor...=...
</pre>

will not take effect for RTP streams until the camera is restarted, although they will take effect immediately for videos streamed directly via HTTP.

You can access the list of parameters used for RTP streaming, by accessing the following URL:

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState
</pre>

====Jpeg====
Each jpeg-file is divided into many files with a size less than 1500 bytes which are transferred by RTP/UDP protocol through the network. In this case the data transmission is substantially accelerated, but the reliability of transfer falls, which can overload some networks and lead to the loss of a certain amount of video data.

On the page [[Video API And Client Applications]] you can find information about players, which can play the RTP/JPEG stream.

=====Multicast=====
To obtain a video stream using RTP/Multicast it is sufficient to set the special variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.MulticastAlways=yes</nowiki>
The video stream will be generated with the default settings of variables for Multicast address, destination port and TTL. These variables can be changed by the following way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.VideoAddress=224.21.23.44&Network.RTP.R0.VideoPort=22222&Network.RTP.R0.TTL=90</nowiki>

Please note that while <tt>Network.RTP.R0.MulticastAlways</tt> is enabled, the HTTP MJPEG interface will become very slow. So you might want to disable it if not used by your application.
======SDP======
This video stream can be received, recorded or played back by MPlayer, QuickTime, vic (from the mush package). For this it is necessary to obtain the SDP-file from camera:
<nowiki>http://192.168.0.9/mjpg/media.sdp</nowiki>
The saved file should be transferred to your preferred player. For example:
<nowiki>mplayer sdp://media.sdp</nowiki>

======RTSP======
The original Axis Video API specification does not support RTSP in Multicast mode. In the Elphel cameras this possibility has been added as a protocol extension.

=====Unicast=====
======RTSP======

====Theora====

== Obtaining information about system functioning ==
You can obtain information about the system at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/systemlog.cgi</nowiki>
or more detailed information at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/serverreport.cgi</nowiki>

== Date and Time ==
=== Retrieving the Date and Time ===
To see the time which is stored inside the camera you can use the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=get</nowiki>
=== Setting Date and Time ===
For setting the date and time you must use the following parameters:

{|
|-
|action ||-|| set ||
|-
|year ||-|| 1970 - 2031 || Current year.
|-
|month ||-|| 1 - 12 || Current month.
|-
|day ||-|| 1 - 31 || Current day.
|-
|hour ||-|| 0 - 23 || Current hour.
|-
|minute ||-|| 0 - 59 || Current minute.
|-
|second ||-|| 0 - 59 || Current second.
|-
|}

For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=set&year=2006&month=4&day=15&hour=14&minute=20&second=40</nowiki>

== User administration ==
The Video API allows:
*registration and deleting of users
*changing user passwords
*adding users to special groups
=== Deleting a user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=remove&user=joe</nowiki>
=== Creating a new user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=joe&pwd=PASSWD&grp=axuser&sgrp=axview&comment=JOE</nowiki>
Creating a new user is slightly different for Elphel and Axis cameras. All created users which will have the access to camera through Video API MUST belong to the '''axoper''' group. Also these users must belong to one or more secondary groups:
{|
|-
|'''axview''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/view/
|-
|'''axoper''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/operator/
|-
|'''axadmin''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/admin/
|-
|}
At the same time it is necessary to pay special attention, because users who have Administrator rights must be entered into all three groups, users who have Operator rights must be entered into the axoper and axview groups, users who have Unprivileged user rights must be entered into the axview group only.
Creating of three users with different rights, for example:
*Administrator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axadmin:axoper:axview&comment=Administrator</nowiki>
*Operator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=operator&pwd=foo&grp=axuser&sgrp=axoper:axview&comment=Operator</nowiki>

*Unprivileged user:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axview&comment=Viewer</nowiki>

=== Password changing ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&pwd=pass</nowiki>

=== Changing the access rights for secondary group ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&sgrp=axview:axoper</nowiki>

== Rebooting the camera ==
For camera rebooting, you should use the following address:
<nowiki>http://192.168.0.9/var/axis-cgi/admin/restart.cgi</nowiki>

== Exposure control ==
The Elphel cameras support exposure control with the standard and advanced interface. You can read about Advanced Settings on the page [[Video_API_Extensions]]

=== Autoexposure ===
To enable autoexposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

==== Autoexposure parameters ====
It is possible to assign the area for autoexposure calculation. You can do this using the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ExposureWindow=full</nowiki>
The ExposureWindow can have the values '''full''', '''center''', '''lower''', '''upper''', '''right''' and '''left'''.

Also it possible set a maximum exposure time (number of micro seconds) :
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.MaxExposureTime=150000</nowiki>

=== Manual control of exposure ===
To enable manual control of exposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Also you can set the time an image is exposed (0.1 msec step):
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.Shutter=50</nowiki>

'''For example''' Shutter=50 means 5000 microseconds or 5 miliseconds.

== Troubleshooting ==
If your attempts to access images fail with <tt>500 Server Error</tt>, you may have to explicitely [[Change API|enable the Video API]].

Camera software

2006-12-01T17:39:54Z

Dvdkhlng:

{{Manual Header}}

== Introduction ==

All the camera software is provided under the terms of the GNU General Public License. All the source code is available inside the camera but you may want to visit [http://www.elphel.com Elphel web site] for the latest version.

== Software Architecture of Elphel 3x3 cameras ==
Software in the Elphel cameras started from [http://developer.axis.com/ Axis Developer Boards Software] and was amended for the camera specific functions. It was modified to work with newer hardware (models 303-313/323-333), support more features and now seems to be a good time to make a major redesign instead of applying incremental changes.

Some discussion has already started in Russian here - [[Nc3x3]]

Related to the architecture are the [[#Camera Interface| Camera Interface]] and the [[#Client Software| Client Software]]
=== Camera Interface ===
The camera can be accessed from client-software using the [[Video API]] (compatible with [[AxisAPI|Axis network cameras]]), or using the more ancient [[ccam.cgi]] interface. The user must [[Change API|select the interface]] that he wishes to use. If the [[ccam.cgi]] interface is [[Change API|selected]], an AJAX web-interface will allow simple access to the camera, by visiting the cameras IP-address (default: 192.168.0.9) with a web-browser.

=== Video Server ===
PC-based video server that will archive incoming Ogg Theora incoming streams from several cameras and transcode them on the fly to lower resolution (binary decimation, windowing) and frame rate (i.e. using only key frames) presenting multiple streams (real time and recorded) to the operator. The external interface of the server might be one of the industry standards and compatible with 3rd party legacy software.

=== See also ===
[[Roadmap#Software Architecture of Elphel 3x3 cameras]]

== Client Software ==
Folowed software are included in the [[Live CD]]

=== Common software for video ===
==== mplayer ====
This is a movie player. It can play files and streams with many different video and audio formats.

To watch an rtp stream from our cameras you may use the following command:
mplayer rtsp://camera-ip:7070/
Where '''camera-ip''' is the ip address of the camera.

To play a file recorded with mencoder or any other videofile you may use the following command:
mplayer path-to-file

Or you may use the KDE menu to run mplayer in dialog mode

You can use the keyboard to control playing
*'''space''' pause/continue
*'''Q''' quit

See the mplayer man page and [http://www.mplayerhq.hu/homepage/design7/info.html site] for more information.

==== mencoder ====
This program is included in the mplayer package.
It can transcode video and audio to and from many different formats.
For more about this see the man page. Type:
man mencoder
To record the rtp stream from our cameras it is better to use mencoder in copy mode (without reencoding):
mencoder rtsp://camera.ip:7070 -ovc copy -fps <fps> -o filename.avi
where:
*'''camera.ip''' - DNS name or IP address of the camera;
*'''<fps>''' - approximate value of the frame frequency (this parameter is mandatory);
*'''filename.avi''' - the name of an output file.
Close the terminal window or press Ctrl+C to finish recording.

The following program written in unix shell will split recording video into blocks with the specified number of frames:
while true ; do
f=`date -Iseconds`
mencoder rtsp://camera.ip:7070 -ovc copy -fps <fps> -frames 1000 -o $f.avi
done
You can enter these strings "as is" at the command prompt.

==== ElphelOgm ====
A receiver for the multicast RTP stream. It generates ogg/mjpeg stream on stdout.
You can use it with mplayer or another video player to watch the RTP stream from the camera:
ElphelOgm -a <multicast address> -p <multicast port> | mplayer -nocache -
Or to record stream to a file:
ElphelOgm -a <multicast address> -p <multicast port> -f <fps> > video.ogm
Other tested players: VLC(some performance).

See also [[Recorder| detailed description and roadmap]]

==== ogm2mov ====
This program is used to recode ogg/mjpeg file to QuickTime .mov format.
Usage:
ogm2mov -o <output file name> <input_file_name or "-" for stdin>
The program cannot write to a pipe, only to a file.

==== GenReS plugin for Firefox ====
This is a plugin for Mozilla/Firefox to allow embedding of external applications like mplayer in the browser window.

See also [[GenReS|description for javascript programmers]].

=== Special software ===
==== netcardconfig ====
netcardconfig is an improved version of knoppix network configurator.
It needs root privileges.
It has two modes: interactive and batch.

...

It is called from the startup script on our Live CD.
If you have installed netcardconfig-knoppix separately from our distro, it is possible you need to insert a call to the script in a system startup script.
Our version uses arping to check the IP address.

==== netcamconfig ====
Run "netcamconfig" as user "root" to apply additional network settings and some kernel parameters.

This script adds aliases for network cards with the most popular LAN ip adresses,
adds route records for multicast ip addresses
and changes kernel parameters to prevent long i/o operations blocking the hard drive,

It is called from the startup script on our Live CD after netcardconfig.
If you have installed elphel-pack separately from our distro, you possibly need to insert a call for the script in a system startup script.
==== camsearch ====
This shell script scans the LAN using broadcast ping and detects elphel cameras.
It creates the file "cameras.html" in the current directory with links to found cameras and information about
software versions.
It is called from the system startup script after network configuration and can be restarted using the "Find cameras again" link on the KDE desktop.

==== flashit ====
This program uses Axis low-level Ethernet packets [http://developer.axis.com/doc/old/software/tools/network_boot.html see "Theory"](some details do not apply to the camera) to communicate with a network bootloader hard-wired in the CPU internal ROM. This makes firmware upgrade a safe process - even if the process was interrupted and the camera was left in non-bootable state, it is always possible to start over again.

When the program is started without arguments (e.g. by just clicking the icon on the desktop) it offers a choice of images available on the DVD. You may also download flash image files (elphel3?3*-flash.tar.bz2) from the files section on [https://sourceforge.net/projects/elphel Elphel project page at SourceForge.net], save them and use as an argument to flashit (i.e. drag-and-drop the file icon over flashit).

To use the flashit utility, the camera should be started in firmware updgrade mode - the green button on the back panel should be held pressed down when the power is applied to the camera. You may do this in any sequence - if the program was started first, you will see the program output messages immediately after the camera is started in this special mode. The flashing process takes several minutes - both LEDs on the network connector stay on until it is over.

==== sdp-helper ====
This script is designed for calling from a browser. It accepts a temporary "sdp" file downloaded from camera and calls [[#mplayer|mplayer]] to view the stream or [[#mencoder|mencoder]] to record it.
On the CD it processes files with the mime type text/sdp. The script deletes the given temporary file.

----
''Free Software and Open Hardware. Elphel, Inc., 2005''

Video API legacy

2006-12-01T13:02:52Z

Dvdkhlng: typo

{{en|ru=First_Acquaintance_With_Video_API.Ru|cn=Video_API_Extensions.cn}}

Anyone who has even the slightest skill at writing HTML pages can use the Axis Video API. And with additional software installed, it is possible to create a powerful video observation system with the capabilities of recording video archives, journalizing, viewing of archives, etc. Note [[Change API]] an how to enable the Video API.

== Information about image dimensions ==
Some default parameters and some which are transferred when the image is obtained can change the image dimensions. For example parameters such as '''resolution, e_dcm_hor, e_dcm_vert, e_woi_width, e_woi_height, e_woi_left, e_woi_top'''. Sometimes a client application needs to know about the dimensions of the received image in advance (for example, for reserving a necessary area in a browser page or application window). You can obtain this information at the address:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?</nowiki>
It is possible to transfer with this script any of the parameters which are supported by image.cgi and video.cgi. For example:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?e_dcm_vert=2&e_dcm_hor=2&e_woi_width=1800</nowiki>
The server response is:

image width = 896
image height = 768

== Static images ==
To retrieve an image from the camera it is enough to type the following path in the browser's address field:

<nowiki>http://192.168.0.9/jpg/image.jpg </nowiki>

'''Note''' 192.168.0.9 - this is the default camera IP-address. If you have changed the camera IP-address, please, type your variant.

It is also possible to ask the camera to send the image with a certain set of parameters. The path which can be used for this:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?param1=xxx&param2=yyy&.....</nowiki>

See the list of accessible parameters below.

'''resolution'''=<string> Specify the resolution of the returned image, for example 800x600. Product-dependent. You can check what values are supported by your camera using the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Resolution</nowiki>''

'''compression'''=<int> Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size. It can take a value from 0 to 100. In many cases 30 is optimal.

'''colorlevel'''=<int> Sets level of color or grey-scale. It can have value from 0 to 100. 0 = grey-scale, 100 = full color.

'''color'''=<int> Enables/disables color. It can have value 0 or 1. 0 = black and white, 1 = color.

'''rotation'''=<int> Rotates the image clockwise. Product-dependent. You can check what values are supported by your camera at the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Rotation</nowiki>''

Apart from the standard parameters, enumerated above, there are some extensions, which make it possible to use the Elphel cameras more flexibly. You can read more detailed information about these extensions at [[Video API Extensions]].

Example of obtaining an image with the assigned set of parameters:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?resolution=1024x768&colorlrvel=45&compression=30</nowiki>

If some parameters are not assigned, the default value is used. You can see the default values at the address:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Image.I0.Appearance</nowiki>

You can change the default values. For this it is necessary to specify the parameter action=update. For example:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Appearance.Resolution=512x384&Image.I0.Appearance.Rotation=180&ColorEnabled=no&Image.I0.Appearance.Compression=50</nowiki>

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ColorLevel=60</nowiki>

==Video stream==

The cameras can be used to receive a continuous video stream. This stream can be transferred by two protocols - HTTP and RTP.

===HTTP===
====Jpeg====
The stream is a sequence of jpeg-files, separated by a special marking line. This transfer format is named Multipart Jpeg or MPJPG. For receiving a stream in this format you can use the following path:
<nowiki>http://192.168.0.9/mjpg/video.mjpg</nowiki>
As with static images, you can also assign parameters for the video stream. For this you can use the following path:
<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?param1=xxx&param2=yyy&.....</nowiki>
Apart from the parameters, enumerated above, such as '''resolution, compression, colorlevel, color, rotation''', you can also assign:

'''duration=<int>''' Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.

'''nbrofframes=<int>''' Specifies how many frames the server will generate and push. 0 = unlimited.

'''fps=<int>''' Using fps it is possible to specify the frame rate from the server. 0 = unlimited.

By default all these parameters are assigned to 0. You can change the default settings, for example, in this way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Stream.Duration=100&Image.I0.Stream.FPS=5&Image.I0.Stream.NbrOfFrames=1000</nowiki>

Apart from the standard parameters, enumerated above, there are extensions, which allow you to use the Elphel cameras more flexibly. More detailed information about these extensions can be found at [[Video API Extensions]].

On the page [[Video API And Client Applications]] you can find some information about players, which can play the MPJPG video stream.

====Theora====

===RTP===
====Video Parameters====
Note that due to obscure reasons, parameters set via

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor...=...
</pre>

will not take effect for RTP streams until the camera is restarted, although they will take effect immediately for videos streamed directly via HTTP.

You can access the list of parameters used for RTP streaming, by accessing the following URL:

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState
</pre>

====Jpeg====
Each jpeg-file is divided into many files with a size less than 1500 bytes which are transferred by RTP/UDP protocol through the network. In this case the data transmission is substantially accelerated, but the reliability of transfer falls, which can overload some networks and lead to the loss of a certain amount of video data.

On the page [[Video API And Client Applications]] you can find information about players, which can play the RTP/JPEG stream.

=====Multicast=====
To obtain a video stream using RTP/Multicast it is sufficient to set the special variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.MulticastAlways=yes</nowiki>
The video stream will be generated with the default settings of variables for Multicast address, destination port and TTL. These variables can be changed by the following way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.VideoAddress=224.21.23.44&Network.RTP.R0.VideoPort=22222&Network.RTP.R0.TTL=90</nowiki>
======SDP======
This video stream can be received, recorded or played back by MPlayer, QuickTime, vic (from the mush package). For this it is necessary to obtain the SDP-file from camera:
<nowiki>http://192.168.0.9/mjpg/media.sdp</nowiki>
The saved file should be transferred to your preferred player. For example:
<nowiki>mplayer sdp://media.sdp</nowiki>

======RTSP======
The original Axis Video API specification does not support RTSP in Multicast mode. In the Elphel cameras this possibility has been added as a protocol extension.

=====Unicast=====
======RTSP======

====Theora====

== Obtaining information about system functioning ==
You can obtain information about the system at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/systemlog.cgi</nowiki>
or more detailed information at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/serverreport.cgi</nowiki>

== Date and Time ==
=== Retrieving the Date and Time ===
To see the time which is stored inside the camera you can use the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=get</nowiki>
=== Setting Date and Time ===
For setting the date and time you must use the following parameters:

{|
|-
|action ||-|| set ||
|-
|year ||-|| 1970 - 2031 || Current year.
|-
|month ||-|| 1 - 12 || Current month.
|-
|day ||-|| 1 - 31 || Current day.
|-
|hour ||-|| 0 - 23 || Current hour.
|-
|minute ||-|| 0 - 59 || Current minute.
|-
|second ||-|| 0 - 59 || Current second.
|-
|}

For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=set&year=2006&month=4&day=15&hour=14&minute=20&second=40</nowiki>

== User administration ==
The Video API allows:
*registration and deleting of users
*changing user passwords
*adding users to special groups
=== Deleting a user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=remove&user=joe</nowiki>
=== Creating a new user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=joe&pwd=PASSWD&grp=axuser&sgrp=axview&comment=JOE</nowiki>
Creating a new user is slightly different for Elphel and Axis cameras. All created users which will have the access to camera through Video API MUST belong to the '''axoper''' group. Also these users must belong to one or more secondary groups:
{|
|-
|'''axview''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/view/
|-
|'''axoper''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/operator/
|-
|'''axadmin''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/admin/
|-
|}
At the same time it is necessary to pay special attention, because users who have Administrator rights must be entered into all three groups, users who have Operator rights must be entered into the axoper and axview groups, users who have Unprivileged user rights must be entered into the axview group only.
Creating of three users with different rights, for example:
*Administrator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axadmin:axoper:axview&comment=Administrator</nowiki>
*Operator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=operator&pwd=foo&grp=axuser&sgrp=axoper:axview&comment=Operator</nowiki>

*Unprivileged user:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axview&comment=Viewer</nowiki>

=== Password changing ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&pwd=pass</nowiki>

=== Changing the access rights for secondary group ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&sgrp=axview:axoper</nowiki>

== Rebooting the camera ==
For camera rebooting, you should use the following address:
<nowiki>http://192.168.0.9/var/axis-cgi/admin/restart.cgi</nowiki>

== Exposure control ==
The Elphel cameras support exposure control with the standard and advanced interface. You can read about Advanced Settings on the page [[Video_API_Extensions]]

=== Autoexposure ===
To enable autoexposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

==== Autoexposure parameters ====
It is possible to assign the area for autoexposure calculation. You can do this using the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ExposureWindow=full</nowiki>
The ExposureWindow can have the values '''full''', '''center''', '''lower''', '''upper''', '''right''' and '''left'''.

Also it possible set a maximum exposure time (number of micro seconds) :
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.MaxExposureTime=150000</nowiki>

=== Manual control of exposure ===
To enable manual control of exposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Also you can set the time an image is exposed (0.1 msec step):
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.Shutter=50</nowiki>

'''For example''' Shutter=50 means 5000 microseconds or 5 miliseconds.

== Troubleshooting ==
If your attempts to access images fail with <tt>500 Server Error</tt>, you may have to explicitely [[Change API|enable the Video API]].

Video API legacy

2006-12-01T13:00:58Z

Dvdkhlng: Added note about changes by param.cgi being delayed for RTP streams

{{en|ru=First_Acquaintance_With_Video_API.Ru|cn=Video_API_Extensions.cn}}

Anyone who has even the slightest skill at writing HTML pages can use the Axis Video API. And with additional software installed, it is possible to create a powerful video observation system with the capabilities of recording video archives, journalizing, viewing of archives, etc. Note [[Change API]] an how to enable the Video API.

== Information about image dimensions ==
Some default parameters and some which are transferred when the image is obtained can change the image dimensions. For example parameters such as '''resolution, e_dcm_hor, e_dcm_vert, e_woi_width, e_woi_height, e_woi_left, e_woi_top'''. Sometimes a client application needs to know about the dimensions of the received image in advance (for example, for reserving a necessary area in a browser page or application window). You can obtain this information at the address:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?</nowiki>
It is possible to transfer with this script any of the parameters which are supported by image.cgi and video.cgi. For example:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?e_dcm_vert=2&e_dcm_hor=2&e_woi_width=1800</nowiki>
The server response is:

image width = 896
image height = 768

== Static images ==
To retrieve an image from the camera it is enough to type the following path in the browser's address field:

<nowiki>http://192.168.0.9/jpg/image.jpg </nowiki>

'''Note''' 192.168.0.9 - this is the default camera IP-address. If you have changed the camera IP-address, please, type your variant.

It is also possible to ask the camera to send the image with a certain set of parameters. The path which can be used for this:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?param1=xxx&param2=yyy&.....</nowiki>

See the list of accessible parameters below.

'''resolution'''=<string> Specify the resolution of the returned image, for example 800x600. Product-dependent. You can check what values are supported by your camera using the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Resolution</nowiki>''

'''compression'''=<int> Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size. It can take a value from 0 to 100. In many cases 30 is optimal.

'''colorlevel'''=<int> Sets level of color or grey-scale. It can have value from 0 to 100. 0 = grey-scale, 100 = full color.

'''color'''=<int> Enables/disables color. It can have value 0 or 1. 0 = black and white, 1 = color.

'''rotation'''=<int> Rotates the image clockwise. Product-dependent. You can check what values are supported by your camera at the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Rotation</nowiki>''

Apart from the standard parameters, enumerated above, there are some extensions, which make it possible to use the Elphel cameras more flexibly. You can read more detailed information about these extensions at [[Video API Extensions]].

Example of obtaining an image with the assigned set of parameters:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?resolution=1024x768&colorlrvel=45&compression=30</nowiki>

If some parameters are not assigned, the default value is used. You can see the default values at the address:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Image.I0.Appearance</nowiki>

You can change the default values. For this it is necessary to specify the parameter action=update. For example:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Appearance.Resolution=512x384&Image.I0.Appearance.Rotation=180&ColorEnabled=no&Image.I0.Appearance.Compression=50</nowiki>

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ColorLevel=60</nowiki>

==Video stream==

The cameras can be used to receive a continuous video stream. This stream can be transferred by two protocols - HTTP and RTP.

===HTTP===
====Jpeg====
The stream is a sequence of jpeg-files, separated by a special marking line. This transfer format is named Multipart Jpeg or MPJPG. For receiving a stream in this format you can use the following path:
<nowiki>http://192.168.0.9/mjpg/video.mjpg</nowiki>
As with static images, you can also assign parameters for the video stream. For this you can use the following path:
<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?param1=xxx&param2=yyy&.....</nowiki>
Apart from the parameters, enumerated above, such as '''resolution, compression, colorlevel, color, rotation''', you can also assign:

'''duration=<int>''' Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.

'''nbrofframes=<int>''' Specifies how many frames the server will generate and push. 0 = unlimited.

'''fps=<int>''' Using fps it is possible to specify the frame rate from the server. 0 = unlimited.

By default all these parameters are assigned to 0. You can change the default settings, for example, in this way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Stream.Duration=100&Image.I0.Stream.FPS=5&Image.I0.Stream.NbrOfFrames=1000</nowiki>

Apart from the standard parameters, enumerated above, there are extensions, which allow you to use the Elphel cameras more flexibly. More detailed information about these extensions can be found at [[Video API Extensions]].

On the page [[Video API And Client Applications]] you can find some information about players, which can play the MPJPG video stream.

====Theora====

===RTP===
====Video Parameters====
Note that due to obscure reasons, parameters set via

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor...=...
</pre>

will not take effect for RTP streams until the camera is restarted, although they will take effect immediately for videos are streamed directly via HTTP.

You can access the list of parameters used for RTP streaming, by accessing the following URL:

<pre>
http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState
</pre>

====Jpeg====
Each jpeg-file is divided into many files with a size less than 1500 bytes which are transferred by RTP/UDP protocol through the network. In this case the data transmission is substantially accelerated, but the reliability of transfer falls, which can overload some networks and lead to the loss of a certain amount of video data.

On the page [[Video API And Client Applications]] you can find information about players, which can play the RTP/JPEG stream.

=====Multicast=====
To obtain a video stream using RTP/Multicast it is sufficient to set the special variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.MulticastAlways=yes</nowiki>
The video stream will be generated with the default settings of variables for Multicast address, destination port and TTL. These variables can be changed by the following way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.VideoAddress=224.21.23.44&Network.RTP.R0.VideoPort=22222&Network.RTP.R0.TTL=90</nowiki>
======SDP======
This video stream can be received, recorded or played back by MPlayer, QuickTime, vic (from the mush package). For this it is necessary to obtain the SDP-file from camera:
<nowiki>http://192.168.0.9/mjpg/media.sdp</nowiki>
The saved file should be transferred to your preferred player. For example:
<nowiki>mplayer sdp://media.sdp</nowiki>

======RTSP======
The original Axis Video API specification does not support RTSP in Multicast mode. In the Elphel cameras this possibility has been added as a protocol extension.

=====Unicast=====
======RTSP======

====Theora====

== Obtaining information about system functioning ==
You can obtain information about the system at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/systemlog.cgi</nowiki>
or more detailed information at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/serverreport.cgi</nowiki>

== Date and Time ==
=== Retrieving the Date and Time ===
To see the time which is stored inside the camera you can use the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=get</nowiki>
=== Setting Date and Time ===
For setting the date and time you must use the following parameters:

{|
|-
|action ||-|| set ||
|-
|year ||-|| 1970 - 2031 || Current year.
|-
|month ||-|| 1 - 12 || Current month.
|-
|day ||-|| 1 - 31 || Current day.
|-
|hour ||-|| 0 - 23 || Current hour.
|-
|minute ||-|| 0 - 59 || Current minute.
|-
|second ||-|| 0 - 59 || Current second.
|-
|}

For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=set&year=2006&month=4&day=15&hour=14&minute=20&second=40</nowiki>

== User administration ==
The Video API allows:
*registration and deleting of users
*changing user passwords
*adding users to special groups
=== Deleting a user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=remove&user=joe</nowiki>
=== Creating a new user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=joe&pwd=PASSWD&grp=axuser&sgrp=axview&comment=JOE</nowiki>
Creating a new user is slightly different for Elphel and Axis cameras. All created users which will have the access to camera through Video API MUST belong to the '''axoper''' group. Also these users must belong to one or more secondary groups:
{|
|-
|'''axview''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/view/
|-
|'''axoper''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/operator/
|-
|'''axadmin''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/admin/
|-
|}
At the same time it is necessary to pay special attention, because users who have Administrator rights must be entered into all three groups, users who have Operator rights must be entered into the axoper and axview groups, users who have Unprivileged user rights must be entered into the axview group only.
Creating of three users with different rights, for example:
*Administrator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axadmin:axoper:axview&comment=Administrator</nowiki>
*Operator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=operator&pwd=foo&grp=axuser&sgrp=axoper:axview&comment=Operator</nowiki>

*Unprivileged user:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axview&comment=Viewer</nowiki>

=== Password changing ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&pwd=pass</nowiki>

=== Changing the access rights for secondary group ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&sgrp=axview:axoper</nowiki>

== Rebooting the camera ==
For camera rebooting, you should use the following address:
<nowiki>http://192.168.0.9/var/axis-cgi/admin/restart.cgi</nowiki>

== Exposure control ==
The Elphel cameras support exposure control with the standard and advanced interface. You can read about Advanced Settings on the page [[Video_API_Extensions]]

=== Autoexposure ===
To enable autoexposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

==== Autoexposure parameters ====
It is possible to assign the area for autoexposure calculation. You can do this using the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ExposureWindow=full</nowiki>
The ExposureWindow can have the values '''full''', '''center''', '''lower''', '''upper''', '''right''' and '''left'''.

Also it possible set a maximum exposure time (number of micro seconds) :
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.MaxExposureTime=150000</nowiki>

=== Manual control of exposure ===
To enable manual control of exposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Also you can set the time an image is exposed (0.1 msec step):
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.Shutter=50</nowiki>

'''For example''' Shutter=50 means 5000 microseconds or 5 miliseconds.

== Troubleshooting ==
If your attempts to access images fail with <tt>500 Server Error</tt>, you may have to explicitely [[Change API|enable the Video API]].

Video API Extensions legacy

2006-12-01T11:13:36Z

Dvdkhlng:

{{en|ru=Video_API_Extensions.Ru|cn=Video_API_Extensions.cn}}

The current implementation of the [[Video API]] has a number of features which are absent from the [[AxisAPI|standard Axis Video API]].

== Enabling extensions ==
By default the Video API extensions are blocked. To unblock them it is necessary to set a corresponding variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ElphelExtensions.Enabled=yes</nowiki>

== Obtaining static and dynamic images ==
The standard interface for obtaining static and dynamic images in JPEG and MJPG formats has a few additional parameters.

{| border="0" cellpadding="2"
|-
|e_dcm_hor ||-|| horizontal decimation (resolution/image size reduction)
|-
|e_dcm_vert ||-|| vertical decimation (resolution/image size reduction)
|-
|e_bin_hor ||-|| horizontal binning (sensitivity for lower resolution)
|-
|e_bin_vert ||-|| vertical binning (sensitivity for lower resolution)
|-
|e_woi_width ||-|| sensor active window width (before decimation)
|-
|e_woi_height ||-|| sensor active window height (before decimation)
|-
|e_woi_left ||-|| sensor active window left margin (before decimation)
|-
|e_woi_top ||-|| sensor active window top margin (before decimation)
|-
|e_virt_width ||-|| virtual frame width
|-
|e_virt_height ||-|| virtual frame height
|-
|e_fliph ||-|| flip (mirror) image horizontally (uses in-sensor capabilities)
|-
|e_flipv ||-|| flip (mirror) image vertically (uses in-sensor capabilities)
|-
|e_exp_time ||-|| exposure time (0.1 msec step)
|-
|e_gamma ||-|| gamma correction value (%)
|-
|e_pixel_low ||-|| black level
|-
|e_pixel_high ||-|| white level
|-
|e_saturation_blue ||-|| color Saturation (%), Blue
|-
|e_saturation_red ||-|| color Saturation (%), Red
|-
|e_gain_r ||-|| analog gain RED (or mono)
|-
|e_gain_g ||-|| analog gain GREEN (or green in "red" line)
|-
|e_gain_b ||-|| analog gain BLUE
|-
|e_gain_gb ||-|| analog gain GREEN in "blue" line)
|-
|e_spec_kac_gga ||-|| Kodak KAC1310 analog gain Y (all colors)
|-
|e_spec_kac_ggb ||-|| Kodak KAC1310 analog gain ? (all colors)
|-
|e_spec_kac_ggm ||-|| Kodak KAC1310 mode
|
|}

=== Examples ===
Example of obtaining a static image - use the following parameters:
<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?e_dcm_hor=2&e_dcm_vert=2&e_woi_width=1000&e_woi_height=900&e_woi_left=600</nowiki>

Example of obtaining a dynamic image (MPJPG) - use the following parameters:

<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?e_dcm_hor=2&e_dcm_vert=2&e_woi_width=1000&e_woi_height=900&e_woi_left=600</nowiki>

You can play this videostream, for example, by using MPlayer (for a more detailed description see [[Using Mplayer With Video API]]):

<nowiki>$mplayer -demuxer lavf "http://192.168.0.9/axis-cgi/mjpg/video.cgi?e_dcm_hor=2&e_dcm_vert=2&e_woi_width=1000&e_woi_height=900&e_woi_left=600&bogus.mjpg"</nowiki>

If any of the parameters are not specified, the default values are used. You can find these values at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.Sensor</nowiki>
'''Note''': All API extensions have the prefix "E_".

You can change the default value in the standard way for the Axis Video API. For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.E_DcmHor=1</nowiki>

== Obtaining information about the system status and default values ==
To obtain information about the system status variable you must use the following path:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState</nowiki>

In an addition to the standard "'''rfc'''" format there is also the possibility to use XML format. You must use the '''responseformat''' parameter for this. For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState&responseformat=xml</nowiki>
'''Note'''. If the responseformat is not specified or specified incorrectly, the default value of '''"rfc" will be used.'''

== Video streaming: RTP/MJPG and RTP/Theora ==
The Elphel cameras can transfer the video stream by RTP protocol.
=== RTP/MJPG ===
=== RTP/Theora ===

== Exposure control ==
The Elphel cameras support the standard and advanced exposure control interface. For the standard settings see [[Video_API]]

To enable autoexposure it is necessary to use the following command:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

Enabling the manual control of exposure:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Obtaining the exposure state:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=ImageSource.I0.E_CurrentState.E_Exposure</nowiki>

Window settings:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.E_Exposure.WinWidth=30&ImageSource.I0.Sensor.E_Exposure.WinHeight=45&ImageSource.I0.Sensor.E_Exposure.WinLeft=10&ImageSource.I0.Sensor.E_Exposure.WinTop=20</nowiki>

Exposure max.values:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.MaxExposureTime=3000&ImageSource.I0.Sensor.E_Exposure.OverMax=30</nowiki>

Video API legacy

2006-12-01T09:02:40Z

Dvdkhlng:

{{en|ru=First_Acquaintance_With_Video_API.Ru|cn=Video_API_Extensions.cn}}

Anyone who has even the slightest skill at writing HTML pages can use the Axis Video API. And with additional software installed, it is possible to create a powerful video observation system with the capabilities of recording video archives, journalizing, viewing of archives, etc. Note [[Change API]] an how to enable the Video API.

== Information about image dimensions ==
Some default parameters and some which are transferred when the image is obtained can change the image dimensions. For example parameters such as '''resolution, e_dcm_hor, e_dcm_vert, e_woi_width, e_woi_height, e_woi_left, e_woi_top'''. Sometimes a client application needs to know about the dimensions of the received image in advance (for example, for reserving a necessary area in a browser page or application window). You can obtain this information at the address:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?</nowiki>
It is possible to transfer with this script any of the parameters which are supported by image.cgi and video.cgi. For example:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?e_dcm_vert=2&e_dcm_hor=2&e_woi_width=1800</nowiki>
The server response is:

image width = 896
image height = 768

== Static images ==
To retrieve an image from the camera it is enough to type the following path in the browser's address field:

<nowiki>http://192.168.0.9/jpg/image.jpg </nowiki>

'''Note''' 192.168.0.9 - this is the default camera IP-address. If you have changed the camera IP-address, please, type your variant.

It is also possible to ask the camera to send the image with a certain set of parameters. The path which can be used for this:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?param1=xxx&param2=yyy&.....</nowiki>

See the list of accessible parameters below.

'''resolution'''=<string> Specify the resolution of the returned image, for example 800x600. Product-dependent. You can check what values are supported by your camera using the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Resolution</nowiki>''

'''compression'''=<int> Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size. It can take a value from 0 to 100. In many cases 30 is optimal.

'''colorlevel'''=<int> Sets level of color or grey-scale. It can have value from 0 to 100. 0 = grey-scale, 100 = full color.

'''color'''=<int> Enables/disables color. It can have value 0 or 1. 0 = black and white, 1 = color.

'''rotation'''=<int> Rotates the image clockwise. Product-dependent. You can check what values are supported by your camera at the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Rotation</nowiki>''

Apart from the standard parameters, enumerated above, there are some extensions, which make it possible to use the Elphel cameras more flexibly. You can read more detailed information about these extensions at [[Video API Extensions]].

Example of obtaining an image with the assigned set of parameters:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?resolution=1024x768&colorlrvel=45&compression=30</nowiki>

If some parameters are not assigned, the default value is used. You can see the default values at the address:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Image.I0.Appearance</nowiki>

You can change the default values. For this it is necessary to specify the parameter action=update. For example:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Appearance.Resolution=512x384&Image.I0.Appearance.Rotation=180&ColorEnabled=no&Image.I0.Appearance.Compression=50</nowiki>

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ColorLevel=60</nowiki>

==Video stream==

The cameras can be used to receive a continuous video stream. This stream can be transferred by two protocols - HTTP and RTP.

===HTTP===
====Jpeg====
The stream is a sequence of jpeg-files, separated by a special marking line. This transfer format is named Multipart Jpeg or MPJPG. For receiving a stream in this format you can use the following path:
<nowiki>http://192.168.0.9/mjpg/video.mjpg</nowiki>
As with static images, you can also assign parameters for the video stream. For this you can use the following path:
<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?param1=xxx&param2=yyy&.....</nowiki>
Apart from the parameters, enumerated above, such as '''resolution, compression, colorlevel, color, rotation''', you can also assign:

'''duration=<int>''' Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.

'''nbrofframes=<int>''' Specifies how many frames the server will generate and push. 0 = unlimited.

'''fps=<int>''' Using fps it is possible to specify the frame rate from the server. 0 = unlimited.

By default all these parameters are assigned to 0. You can change the default settings, for example, in this way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Stream.Duration=100&Image.I0.Stream.FPS=5&Image.I0.Stream.NbrOfFrames=1000</nowiki>

Apart from the standard parameters, enumerated above, there are extensions, which allow you to use the Elphel cameras more flexibly. More detailed information about these extensions can be found at [[Video API Extensions]].

On the page [[Video API And Client Applications]] you can find some information about players, which can play the MPJPG video stream.

====Theora====

===RTP===
====Jpeg====
Each jpeg-file is divided into many files with a size less than 1500 bytes which are transferred by RTP/UDP protocol through the network. In this case the data transmission is substantially accelerated, but the reliability of transfer falls, which can overload some networks and lead to the loss of a certain amount of video data.

On the page [[Video API And Client Applications]] you can find information about players, which can play the RTP/JPEG stream.

=====Multicast=====
To obtain a video stream using RTP/Multicast it is sufficient to set the special variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.MulticastAlways=yes</nowiki>
The video stream will be generated with the default settings of variables for Multicast address, destination port and TTL. These variables can be changed by the following way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.VideoAddress=224.21.23.44&Network.RTP.R0.VideoPort=22222&Network.RTP.R0.TTL=90</nowiki>
======SDP======
This video stream can be received, recorded or played back by MPlayer, QuickTime, vic (from the mush package). For this it is necessary to obtain the SDP-file from camera:
<nowiki>http://192.168.0.9/mjpg/media.sdp</nowiki>
The saved file should be transferred to your preferred player. For example:
<nowiki>mplayer sdp://media.sdp</nowiki>

======RTSP======
The original Axis Video API specification does not support RTSP in Multicast mode. In the Elphel cameras this possibility has been added as a protocol extension.

=====Unicast=====
======RTSP======

====Theora====

== Obtaining information about system functioning ==
You can obtain information about the system at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/systemlog.cgi</nowiki>
or more detailed information at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/serverreport.cgi</nowiki>

== Date and Time ==
=== Retrieving the Date and Time ===
To see the time which is stored inside the camera you can use the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=get</nowiki>
=== Setting Date and Time ===
For setting the date and time you must use the following parameters:

{|
|-
|action ||-|| set ||
|-
|year ||-|| 1970 - 2031 || Current year.
|-
|month ||-|| 1 - 12 || Current month.
|-
|day ||-|| 1 - 31 || Current day.
|-
|hour ||-|| 0 - 23 || Current hour.
|-
|minute ||-|| 0 - 59 || Current minute.
|-
|second ||-|| 0 - 59 || Current second.
|-
|}

For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=set&year=2006&month=4&day=15&hour=14&minute=20&second=40</nowiki>

== User administration ==
The Video API allows:
*registration and deleting of users
*changing user passwords
*adding users to special groups
=== Deleting a user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=remove&user=joe</nowiki>
=== Creating a new user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=joe&pwd=PASSWD&grp=axuser&sgrp=axview&comment=JOE</nowiki>
Creating a new user is slightly different for Elphel and Axis cameras. All created users which will have the access to camera through Video API MUST belong to the '''axoper''' group. Also these users must belong to one or more secondary groups:
{|
|-
|'''axview''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/view/
|-
|'''axoper''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/operator/
|-
|'''axadmin''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/admin/
|-
|}
At the same time it is necessary to pay special attention, because users who have Administrator rights must be entered into all three groups, users who have Operator rights must be entered into the axoper and axview groups, users who have Unprivileged user rights must be entered into the axview group only.
Creating of three users with different rights, for example:
*Administrator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axadmin:axoper:axview&comment=Administrator</nowiki>
*Operator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=operator&pwd=foo&grp=axuser&sgrp=axoper:axview&comment=Operator</nowiki>

*Unprivileged user:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axview&comment=Viewer</nowiki>

=== Password changing ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&pwd=pass</nowiki>

=== Changing the access rights for secondary group ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&sgrp=axview:axoper</nowiki>

== Rebooting the camera ==
For camera rebooting, you should use the following address:
<nowiki>http://192.168.0.9/var/axis-cgi/admin/restart.cgi</nowiki>

== Exposure control ==
The Elphel cameras support exposure control with the standard and advanced interface. You can read about Advanced Settings on the page [[Video_API_Extensions]]

=== Autoexposure ===
To enable autoexposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

==== Autoexposure parameters ====
It is possible to assign the area for autoexposure calculation. You can do this using the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ExposureWindow=full</nowiki>
The ExposureWindow can have the values '''full''', '''center''', '''lower''', '''upper''', '''right''' and '''left'''.

Also it possible set a maximum exposure time (number of micro seconds) :
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.MaxExposureTime=150000</nowiki>

=== Manual control of exposure ===
To enable manual control of exposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Also you can set the time an image is exposed (0.1 msec step):
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.Shutter=50</nowiki>

'''For example''' Shutter=50 means 5000 microseconds or 5 miliseconds.

== Troubleshooting ==
If your attempts to access images fail with <tt>500 Server Error</tt>, you may have to explicitely [[Change API|enable the Video API]].

Video API legacy

2006-12-01T09:01:38Z

Dvdkhlng:

{{en|ru=First_Acquaintance_With_Video_API.Ru|cn=Video_API_Extensions.cn}}

Anyone who has even the slightest skill at writing HTML pages can use the Axis Video API. And with additional software installed, it is possible to create a powerful video observation system with the capabilities of recording video archives, journalizing, viewing of archives, etc. Note [[Change API]] an how to enable the Video API.

== Information about image dimensions ==
Some default parameters and some which are transferred when the image is obtained can change the image dimensions. For example parameters such as '''resolution, e_dcm_hor, e_dcm_vert, e_woi_width, e_woi_height, e_woi_left, e_woi_top'''. Sometimes a client application needs to know about the dimensions of the received image in advance (for example, for reserving a necessary area in a browser page or application window). You can obtain this information at the address:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?</nowiki>
It is possible to transfer with this script any of the parameters which are supported by image.cgi and video.cgi. For example:
<nowiki>http://192.168.0.9/var/axis-cgi/view/imagesize.cgi?e_dcm_vert=2&e_dcm_hor=2&e_woi_width=1800</nowiki>
The server response is:

image width = 896
image height = 768

== Static images ==
To retrieve an image from the camera it is enough to type the following path in the browser's address field:

<nowiki>http://192.168.0.9/jpg/image.jpg </nowiki>

'''Note''' 192.168.0.9 - this is the default camera IP-address. If you have changed the camera IP-address, please, type your variant.

It is also possible to ask the camera to send the image with a certain set of parameters. The path which can be used for this:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?param1=xxx&param2=yyy&.....</nowiki>

See the list of accessible parameters below.

'''resolution'''=<string> Specify the resolution of the returned image, for example 800x600. Product-dependent. You can check what values are supported by your camera using the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Resolution</nowiki>''

'''compression'''=<int> Adjusts the compression level of the image. Higher values correspond to higher compression, i.e. lower quality and smaller image size. It can take a value from 0 to 100. In many cases 30 is optimal.

'''colorlevel'''=<int> Sets level of color or grey-scale. It can have value from 0 to 100. 0 = grey-scale, 100 = full color.

'''color'''=<int> Enables/disables color. It can have value 0 or 1. 0 = black and white, 1 = color.

'''rotation'''=<int> Rotates the image clockwise. Product-dependent. You can check what values are supported by your camera at the address: ''<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Properties.Image.Rotation</nowiki>''

Apart from the standard parameters, enumerated above, there are some extensions, which make it possible to use the Elphel cameras more flexibly. You can read more detailed information about these extensions at [[Video API Extensions]].

Example of obtaining an image with the assigned set of parameters:

<nowiki>http://192.168.0.9/axis-cgi/jpg/image.cgi?resolution=1024x768&colorlrvel=45&compression=30</nowiki>

If some parameters are not assigned, the default value is used. You can see the default values at the address:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=list&group=Image.I0.Appearance</nowiki>

You can change the default values. For this it is necessary to specify the parameter action=update. For example:

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Appearance.Resolution=512x384&Image.I0.Appearance.Rotation=180&ColorEnabled=no&Image.I0.Appearance.Compression=50</nowiki>

<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ColorLevel=60</nowiki>

==Video stream==

The cameras can be used to receive a continuous video stream. This stream can be transferred by two protocols - HTTP and RTP.

===HTTP===
====Jpeg====
The stream is a sequence of jpeg-files, separated by a special marking line. This transfer format is named Multipart Jpeg or MPJPG. For receiving a stream in this format you can use the following path:
<nowiki>http://192.168.0.9/mjpg/video.mjpg</nowiki>
As with static images, you can also assign parameters for the video stream. For this you can use the following path:
<nowiki>http://192.168.0.9/axis-cgi/mjpg/video.cgi?param1=xxx&param2=yyy&.....</nowiki>
Apart from the parameters, enumerated above, such as '''resolution, compression, colorlevel, color, rotation''', you can also assign:

'''duration=<int>''' Specifies for how many seconds the video will be generated and pushed to the client. 0 = unlimited.

'''nbrofframes=<int>''' Specifies how many frames the server will generate and push. 0 = unlimited.

'''fps=<int>''' Using fps it is possible to specify the frame rate from the server. 0 = unlimited.

By default all these parameters are assigned to 0. You can change the default settings, for example, in this way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Image.I0.Stream.Duration=100&Image.I0.Stream.FPS=5&Image.I0.Stream.NbrOfFrames=1000</nowiki>

Apart from the standard parameters, enumerated above, there are extensions, which allow you to use the Elphel cameras more flexibly. More detailed information about these extensions can be found at [[Video API Extensions]].

On the page [[Video API And Client Applications]] you can find some information about players, which can play the MPJPG video stream.

====Theora====

===RTP===
====Jpeg====
Each jpeg-file is divided into many files with a size less than 1500 bytes which are transferred by RTP/UDP protocol through the network. In this case the data transmission is substantially accelerated, but the reliability of transfer falls, which can overload some networks and lead to the loss of a certain amount of video data.

On the page [[Video API And Client Applications]] you can find information about players, which can play the RTP/JPEG stream.

=====Multicast=====
To obtain a video stream using RTP/Multicast it is sufficient to set the special variable:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.MulticastAlways=yes</nowiki>
The video stream will be generated with the default settings of variables for Multicast address, destination port and TTL. These variables can be changed by the following way:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&Network.RTP.R0.VideoAddress=224.21.23.44&Network.RTP.R0.VideoPort=22222&Network.RTP.R0.TTL=90</nowiki>
======SDP======
This video stream can be received, recorded or played back by MPlayer, QuickTime, vic (from the mush package). For this it is necessary to obtain the SDP-file from camera:
<nowiki>http://192.168.0.9/mjpg/media.sdp</nowiki>
The saved file should be transferred to your preferred player. For example:
<nowiki>mplayer sdp://media.sdp</nowiki>

======RTSP======
The original Axis Video API specification does not support RTSP in Multicast mode. In the Elphel cameras this possibility has been added as a protocol extension.

=====Unicast=====
======RTSP======

====Theora====

== Obtaining information about system functioning ==
You can obtain information about the system at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/systemlog.cgi</nowiki>
or more detailed information at the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/serverreport.cgi</nowiki>

== Date and Time ==
=== Retrieving the Date and Time ===
To see the time which is stored inside the camera you can use the address:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=get</nowiki>
=== Setting Date and Time ===
For setting the date and time you must use the following parameters:

{|
|-
|action ||-|| set ||
|-
|year ||-|| 1970 - 2031 || Current year.
|-
|month ||-|| 1 - 12 || Current month.
|-
|day ||-|| 1 - 31 || Current day.
|-
|hour ||-|| 0 - 23 || Current hour.
|-
|minute ||-|| 0 - 59 || Current minute.
|-
|second ||-|| 0 - 59 || Current second.
|-
|}

For example:
<nowiki>http://192.168.0.9/axis-cgi/admin/date.cgi?action=set&year=2006&month=4&day=15&hour=14&minute=20&second=40</nowiki>

== User administration ==
The Video API allows:
*registration and deleting of users
*changing user passwords
*adding users to special groups
=== Deleting a user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=remove&user=joe</nowiki>
=== Creating a new user ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=joe&pwd=PASSWD&grp=axuser&sgrp=axview&comment=JOE</nowiki>
Creating a new user is slightly different for Elphel and Axis cameras. All created users which will have the access to camera through Video API MUST belong to the '''axoper''' group. Also these users must belong to one or more secondary groups:
{|
|-
|'''axview''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/view/
|-
|'''axoper''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/operator/
|-
|'''axadmin''' ||-|| access is permitted to scripts which are placed in directory /axis-cgi/admin/
|-
|}
At the same time it is necessary to pay special attention, because users who have Administrator rights must be entered into all three groups, users who have Operator rights must be entered into the axoper and axview groups, users who have Unprivileged user rights must be entered into the axview group only.
Creating of three users with different rights, for example:
*Administrator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axadmin:axoper:axview&comment=Administrator</nowiki>
*Operator:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=operator&pwd=foo&grp=axuser&sgrp=axoper:axview&comment=Operator</nowiki>

*Unprivileged user:
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=add&user=administrator&pwd=foo&grp=axuser&sgrp=axview&comment=Viewer</nowiki>

=== Password changing ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&pwd=pass</nowiki>

=== Changing the access rights for secondary group ===
<nowiki>http://192.168.0.9/axis-cgi/admin/pwdgrp.cgi?action=update&user=joe&sgrp=axview:axoper</nowiki>

== Rebooting the camera ==
For camera rebooting, you should use the following address:
<nowiki>http://192.168.0.9/var/axis-cgi/admin/restart.cgi</nowiki>

== Exposure control ==
The Elphel cameras support exposure control with the standard and advanced interface. You can read about Advanced Settings on the page [[Video_API_Extensions]]

=== Autoexposure ===
To enable autoexposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=auto</nowiki>

==== Autoexposure parameters ====
It is possible to assign the area for autoexposure calculation. You can do this using the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.ExposureWindow=full</nowiki>
The ExposureWindow can have the values '''full''', '''center''', '''lower''', '''upper''', '''right''' and '''left'''.

Also it possible set a maximum exposure time (number of micro seconds) :
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.MaxExposureTime=150000</nowiki>

=== Manual control of exposure ===
To enable manual control of exposure you can use the following command:
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&ImageSource.I0.Sensor.Exposure=manual</nowiki>

Also you can set the time an image is exposed (0.1 msec step):
<nowiki>http://192.168.0.9/axis-cgi/admin/param.cgi?action=update&root.ImageSource.I0.Sensor.Shutter=50</nowiki>

'''For example''' Shutter=50 means 5000 microseconds or 5 miliseconds.

=== Troubleshooting ===
If your attempts to access images fails with <tt>500 Server Error</tt>, you may have to explicitely [[Change API|enable the Video API]].

Change API legacy

2006-12-01T08:57:59Z

Dvdkhlng:

Elphel cameras have two different APIs. The old [[ccam.cgi]] API and the [[Video API]] which is a superset of the [[AxisAPI]]. By default (after flashing), Elphel cameras (at least the 333 model) work in the [[ccam.cgi]] API mode, which means that all attempts to acces the images using the [[Video API]] will come back with a <tt>500 Server Error</tt>.

To check wich API is currently active for your camera, use the "chapi.cgi" CGI script:

<pre>
http://192.168.0.9/cgi-bin/admin/chapi.cgi?action=status
</pre>

This will return and XML document such as:

<pre>
<camera>
<api>0</api>
</camera>
</pre>

meaning:

* <tt><api>0</api></tt> - [[ccam.api]]
* <tt><api>1</api></tt> - [[Video API]]

To change the API, use the <tt>action=setup&api=X</tt> parameters, e.g.:

<pre>
http://192.168.0.9/cgi-bin/admin/chapi.cgi?action=setup&api=1
</pre>

which will change the API even over reboots and return the changed configuration:

<pre>
<camera>
<api>1</api>
</camera>
</pre>

== References ==

* [[ccam.cgi]] Attempt to describe the somewhat incomprehendible older API
* [[Video API]] Description of the the new Axis-compatible API
* [[AxisAPI]] Description of the Axis-camera API which is partially supported by the [[Video API]].

Change API legacy

2006-12-01T08:51:30Z

Dvdkhlng:

Elphel cameras have two different APIs. The old [[ccam.cgi]] API and the [[Video API]] which is a superset of the [[AxisAPI]]. By default (after flashing), Elphel cameras (at least the 333 model) work in the [[ccam.cgi]] API mode, which means that all attempts to acces the images using the [[Video API]] will come back with a 500 Server Error.

To check wich API is currently active for your camera, use the "chapi.cgi" CGI script:

<pre>
http://192.168.0.9/cgi-bin/admin/chapi.cgi?action=status
</pre>

This will return and XML document such as:

<pre>
<camera>
<api>0</api>
</camera>
</pre>

0 - cigcam.api

1 - Video API

To change the API, use the action=setup&api=X parameters, e.g.:

<pre>
http://192.168.0.9/cgi-bin/admin/chapi.cgi?action=setup&api=1
</pre>

which will change the API even over reboots and return the changed configuration:

<pre>
<camera>
<api>1</api>
</camera>
</pre>