Difference between revisions of "AxisAPI legacy"
From ElphelWiki
Line 7: | Line 7: | ||
== API GROUPS == | == API GROUPS == | ||
+ | |||
+ | === [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general General] === | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_add_update_remove_list Add, update, remove and list parameters and their values] ==== | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_list List parameters] ===== | ||
+ | :Fully implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_list_output List output format] ===== | ||
+ | :Fully implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_update Update parameters] ===== | ||
+ | :Fully implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_add Add parameters] ===== | ||
+ | :Not implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_remove Remove parameters] ===== | ||
+ | :Not implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_add_remove_responses Add/Remove server responses] ===== | ||
+ | :Not implemented. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_users Add, modify and delete users] ==== | ||
+ | :Fully implemented. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_factory_default Factory default] ==== | ||
+ | :In development. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_hard_factory_default Hard factory default] ==== | ||
+ | :In development. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_backup Backup] ==== | ||
+ | :In development. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_restore Restore] ==== | ||
+ | :In development. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_firmware_upgrade Firmware upgrade] ==== | ||
+ | :Not implement. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_restart_server Restart server] ==== | ||
+ | :Fully implemented. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_server_report Server report] ==== | ||
+ | :Partially implemented. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_system_logs System logs] ==== | ||
+ | :Fully implemented. | ||
+ | |||
+ | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_time_date System date and time] ==== | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_get_time_date Get system date and time] ===== | ||
+ | :Fully implemented. | ||
+ | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_general_set_time_date Set system date and time] ===== | ||
+ | :Fully implemented. | ||
+ | |||
=== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video Image and Video] === | === [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video Image and Video] === | ||
Line 12: | Line 62: | ||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_imagesize Image size] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_imagesize Image size] ==== | ||
:Fully implemented. | :Fully implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_videostatus Video status] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_videostatus Video status] ==== | ||
:Not implemented. It has the sense only for video servers. | :Not implemented. It has the sense only for video servers. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_bitmap Bitmap] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_bitmap Bitmap] ==== | ||
:Not implemented. But it can be added in future if somebody has need in it. | :Not implemented. But it can be added in future if somebody has need in it. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_mjpg JPEG/MJPG] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_mjpg JPEG/MJPG] ==== | ||
Line 71: | Line 118: | ||
===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_response JPEG image response] ===== | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_response JPEG image response] ===== | ||
:Fully implemented. | :Fully implemented. | ||
− | |||
===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_buffer JPEG buffer request] ===== | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_jpeg_buffer JPEG buffer request] ===== | ||
:Not implemented. | :Not implemented. | ||
− | |||
===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mjpg_video MJPG video request] ===== | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mjpg_video MJPG video request] ===== | ||
:Fully implemented. | :Fully implemented. | ||
− | |||
===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mjpg_video_cgi MJPG video CGI request] ===== | ===== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mjpg_video_cgi MJPG video CGI request] ===== | ||
:Partially implemented. Some parameters will be implemented in the future. | :Partially implemented. Some parameters will be implemented in the future. | ||
Line 134: | Line 178: | ||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_overlay Image overlay] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_overlay Image overlay] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mpeg4 MPEG-4] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_image_video_mpeg4 MPEG-4] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_ptz PTZ] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_ptz PTZ] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_motion Motion Detection] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_motion Motion Detection] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_io I/O] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_io I/O] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_serial_port Serial port] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_serial_port Serial port] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_ip_filter IP filter] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_ip_filter IP filter] ==== | ||
:In development. | :In development. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_audio Audio] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_audio Audio] ==== | ||
:Not implemented. | :Not implemented. | ||
− | |||
==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_292 AXIS 292 Network Video Decoder] ==== | ==== [http://axis.com/techsup/cam_servers/dev/cam_http_api_2.htm#api_blocks_292 AXIS 292 Network Video Decoder] ==== | ||
:Not implemented. | :Not implemented. |
Revision as of 07:00, 8 October 2005
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.
Contents
- 1 API GROUPS
- 1.1 General
- 1.2 Image and Video
API GROUPS
General
Add, update, remove and list parameters and their values
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 |
MJPG video response
- Fully implemented.
Image overlay
- Not implemented.
MPEG-4
- Not implemented.
PTZ
- Not implemented.
Motion Detection
- Not implemented.
I/O
- Not implemented.
Serial port
- Not implemented.
IP filter
- In development.
Audio
- Not implemented.
AXIS 292 Network Video Decoder
- Not implemented.