lnanshw lP wv : default  

gsbNF  CGI parameters of image.jpg

CGI Parameters of image.jpg

 

To retrieve live images of the camera directly from the integrated web server, you can use one of the following two HTTP commands:

Note: This feature is not available for Basic cameras.

Parameter of image.jpg

Parameters Description
help Returns a list of all possible parameters and values.
Command: http://10.x.x.x/cgi-bin/image.jpg?help

current Returns the same image as /record/current.jpg. All other parameters are ignored.
Command: http://10.x.x.x/cgi-bin/image.jpg?current

config Returns an image according to the currently saved image settings. Additional parameters are considered.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&quality=40

camera

Selects the lens display mode.

The following values are possible:

right Retrieves the image from the right lens.
left Retrieves the image from the left lens.
both Retrieves a dual image from the right and the left lenses.
Note: This is only possible with dual lens models.
RiL Creates a picture-in-picture image. Right in Left image
A small image (160x120 mm) from the right lens is displayed in the bottom right corner of the image from the left lens.
Note: This is only possible with dual lens models.
LiR Creates a picture-in-picture image. Left in Right image
A small image (160x120 mm) from the left lens is displayed in the bottom right corner of the image from the right lens.
Note: This is only possible with dual lens models.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&camera=right

size

Controls the image resolution.

The following values are possible:

  • 640x480
  • 320x240
  • 160x120

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&size=320x240

quality

Controls the image quality.

Values: 0..100

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&quality=70

error

Script return value when an error occurs.

The following values are possible:

empty No data is returned.
picture The error image No frame available is returned.
content Returns the HTTP header content-type.

Example:
http://10.x.x.x/cgi-bin/image.jpg?error=picture

automatic

Controls the automatic contrast of the image.

The following values are possible:

off The automatic contrast option is deactivated.
auto The automatic contrast option is activated.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&automatic=auto

brightness

Controls the brightness of the image.

The following values are possible: -10 .. 0 .. 10
The recommended factory default setting is 0.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&brightness=0

backlight

Controls the backlight correction in the image.

The following values are possible: -10 .. 0 .. 10
The recommended factory default setting is 4.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&backlight=4

color

Controls the color saturation in the image.

The following values are possible: -10 .. 0 .. 10
The factory default setting is 5, -10 returns a black&white image.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&color=5

blue

Controls the blue channel of the image.

The following values are possible: -10 .. 0 .. 10
The recommended factory default setting is 0.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&blue=0

red

Controls the red channel of the image.

The following values are possible: -10 .. 0 .. 10
The recommended factory default setting is 0.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&red=0

sharpen

Controls the image sharpness.

The following values are possible: -2 .. 10
The recommended factory default setting is 4.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&sharpen=4

textdisplay

Controls the text display in the image.

The following values are possible:

disable Text display is disabled.
enable

Text display is activated. In connection with the print parameter (see below), you can display text in the image.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config
    &textdisplay=enable
    &print=sampletext

datetime Displays only date and time in the image, according to the format selected in the Text & Display Settings dialog.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config
    &textdisplay=datetime

print

Displays a user-defined text or a message in the image.

As value, an HTTP-compatible text is expected. For example, spaces are replaced by the characters %20 while %0A represents a line break.

Example:
http://10.x.x.x/cgi-bin/image.jpg?config
    &textdisplay=enable
    &print=This%20is%20a%0Asample%20text

date

Displays a specific date and time format. The format selected in the Text & Display Settings is ignored.

The following values are possible:

0 Not used
1 Date & time
2 Time
3 Time & milliseconds
4 Date
5 Date long
6 Time & milliseconds
7 Time Zone

Example:
http://10.x.x.x/cgi-bin/image.jpg?config&date=1

textbgtrans

Controls the transparency of the text background.

The following values are possible: 0..100

Example:
http://10.x.x.x/cgi-bin/image.jpg?config
    &textbgtrans=50

textbgcolor

Controls the background color of the text.

The value needs to be specified in hexadecimal format.

  • 0x000000 → black
  • 0xffffff → white
  • 0xff0000 → red
  • 0x00ff00 → green
  • 0x0000ff → blue

Example:
http://10.x.x.x/cgi-bin/image.jpg?config
    &textdisplay=enable
    &textbgtrans=50&textbgcolor=0x00000f

Except for the help and current parameters, you can combine any number of parameters in any order.


©2003 MOBOTIX AG, hCc · http://www.mobotix.com/ · d[: info@mobotix.com