Convision API LiveView.pdf

1. General................................................................................................................................ 2 

2. Get Box Information............................................................................................................ 2 

/box.info................................................................................................................................................................2 

/box_system.info ..................................................................................................................................................2 

3. JPEG Images (snapshot).................................................................................................... 4 

Analog Camera ...................................................................................................................................................4 

LAN Camera .......................................................................................................................................................4 

4. Motion-JPEG-Streams (Video) ........................................................................................... 5 

Motion-JPEG Server Push Stream ......................................................................................................................5 

5. Convision ActiveX Control .................................................................................................. 6 

Integration inside a HTML page...........................................................................................................................6 

Convision Multiview ActiveX Control Configuration .............................................................................................8 

6. RAW Motion JPEG Data................................................................................................... 11 

/stream.live.........................................................................................................................................................11 

7. Authorization..................................................................................................................... 12 

8. Pan / Tilt / Zoom – Cameras ............................................................................................. 13 

/CamCapabilities?camera=X .............................................................................................................................13 

/CamPositionNames?camera=X........................................................................................................................13 

/TourState?state=Y&camera=X .........................................................................................................................13 

/TourData?op=Z&data=Y&camera=X................................................................................................................13 

URL Functions ...................................................................................................................................................14 

9. Outputs and Inputs ........................................................................................................... 19 

/output/dioswitch ................................................................................................................................................19 

10. Video Out........................................................................................................................ 19 

/config/videoout..................................................................................................................................................19 

11. URL- calls to force actions .............................................................................................. 20 

/config/urlevent...................................................................................................................................................20 

12. Set/Get Motion Detection Mask ...................................................................................... 20 

/motiondetection.mask .......................................................................................................................................20 

13. Examples ........................................................................................................................ 21 

Viewing application with HTML ..........................................................................................................................21 

Move and Zoom functions..................................................................................................................................23 

Pan/Tilt/Zoom cameras for the transmission of image sequence......................................................................24 

14. HTTP-Response Codes.................................................................................................. 25

1. General 

The Convision device includes a HTTP Server, which can be used to get information and video data from the 

device. In addition, the ActiveX Controls, that are contained in the device, provides functions and properties, 

which can be applied in Windows programs or in HTML-pages used by the Microsoft Internet Explorer. 

For every HTTP request the authentication currently configured in the Convision box is used. 

Convision provides digest authentication, basic authentication and deactivated authentication. 

Parameter names are given without quotation marks. The most data can be obtained with a HTTP GET request. 

/box.info 

2. Get Box Information 

This URL can be used to identify a Convision Box of the 2 nd Generation. 

If the Box is from the 2 nd Generation a HTTP GET request returns the string "ConvisionTriMedia". 

/box_system.info 

This URL can be used, since Firmware version 4.00, to get System Information from a Convision Box. 

The following information can be obtained from a HTTP GET request. 

Parameter Definition 

Device ID Device ID of the Box. Possible Values are: 

− Odysseus 

− Troja 

− V400+ 

− V600+ 

− V800 

− V1200 

− V1600 

− V4000 

− V4000 Hybrid 

SW Version Current integrated firmware for example 4.0.0. 

MAC address MAC address of the box for example 00:D0:F0:04:00:4E. 

Analog Camera Count Max. Analog camera count for the current device 

LAN Camera Count Max. LAN Camera count 

Analog camera names Analog Camera names separated by “;”. In every Convision box 16 fields 

are returned even V600. 

The data are contained in the reply HTTP Message in the above specified sequence. 

Each data is separated by a semicolon, for example: 

V600+;4.5.0 DEVELOPER- P;00:D0:F0:06:03:25;6;0;Cam1;Cam2;Cam3;Cam4;Cam5;Cam6;;;;;;;;;;; 

New data may be added in the future at the bottom of the list. Unknown new data should be ignored by the 

interpreter.

LanCamera.config?Camera=X 

X=0-3 

This URL can be used, since Firmware version 4.5.0, to get LAN Camera configuration information from a 

Convision Box. The following information can be obtained from a HTTP GET request. 


Name Name of the LAN Camera, should not contain “;” 

IpAddress IP address, if a IP address is used. 

Hostname Hostname, if a hostname is used. 

Port Communication port 

Username Username of the LAN camera 

Password Base64 encoded Password of the LAN Camera 

Type Type of LAN camera, for example “Axis210_ET_AL” 



LAN Camera 1;192.168.0.25;;80;root;MTExMQ==;Axis210_ET_AL; 

If a LAN camera is not configured an empty HTTP Stream is returned. 

New data may be added in the future at the bottom of the list. Unknown new data should be ignored by the 

interpreter.

3. JPEG Images (snapshot) 

Analog Camera 

For the transmission of an image from an analog camera the following URL can be used: 

/Camera.jpg?camera=X 

X = 1-16 

Example of the transmission of a JPEG image: 

http://IP-Address/Camera.jpg?camera=3 

The command URL can be entered as image source < img src ="…"> in the HTML page. 

To authenticate on the Convision server the parameters atc and passcoded can be used, as described for the 

MJPEG push stream. 

Examples of the transmission of a JPEG image in different sizes for integration 

inside a HTML page: 

 

 

 

LAN Camera 

For the transmission of an image from a LAN camera the following URL can be used: 

/LANCamera.jpg?camera=X 

X = 1-4 

Example: 

http://IP-Address/LANCamera.jpg?camera=2 

This URL can be integrated in a HTML page like the images of the analog cameras.

4. Motion-JPEG-Streams (Video) 

The File extension after the URL decide if only one image should be returned or a Motion JPEG Stream: 


Camera.jpg Only one JPEG 

Camera.push or A MJPEG Stream, functional only with Netscape Browser, Mozilla Firefox and IE 

.htm 

Macintosh version. 

Also the first URL (Camera.push) do not function, if the URL gets called directly in the 

browser, the URL must be integrated as an image in a HTML page. 

_activex.htm Start a Video Stream inside the Convision ActiveX Control, functional only with the 

Microsoft Internet Explorer. 

How to handle one JPEG is described in the chapter above. 

Motion-JPEG Server Push Stream 

Some browsers, like Mozilla Firefox, support push streams. For this browsers it is possible to handle video data 

like one JPEG. The following URL must be used: 

/Camera.push?camera=X 

Parameters Definition 

camera Number of the camera (1-16) 

fps Optional: To Limit the data send from the Convision box over Ethernet, this parameter 

can be used. It is not possible to increase the frames per second only to restrict them. 

If a fps value is set bandwidth saving is deactivated from this stream. 

atc Atc is the authorization string which is needed to get a stream from protected video 

servers. The string consists of a Base64 or Digest coded string (depending on the 

setting of the Convision server) of the following type: user:password. 

passcoded TRUE if atc is an encoded string otherwise false 

The command URL can be entered as image source < img src ="…"> in the HTML page. 

Example: 

 

The Convision ActiveX Control is described in the next chapter.

5. Convision ActiveX Control 

Integration inside a HTML page 

The browser Microsoft Internet Explorer does not support the server push stream but it is the only browser 

which offers the possibility to load an ActiveX Control. Convision offers different possibilities to display this 

ActiveX Control. The first two possibilities are easy to integrate but the third offers the most flexibilities and 

possibilities: 

/_activex.htm 

Inside this URL the JPEG File Size must be contained, can be one of the following values: 

halfsize 192x144 

fullsize 352x288 

hugesize 704x576 

The camera must be specified as parameter. 

Example: 

http://IP-Address/halfsize_activex.htm?camera=2 

/view/activex.htm 

This HTML File is used from the Convision Firmware to display the camera live stream in the Internet Explorer. 


picsize Size of the Image, possible values are: 

• 1 = Halfsize 

• 2 = Fullsize 

• 3 = Hugesize 

• 4 = Halfsize used for 12-fold view (704x432) 



Cameras Indicates which cameras should be shown. This is a bitfield, where every bit represents 

one camera, for example 7 (= 1 + 2 + 4) shows the cameras 1, 2 and 3. 

ViewCount Number of ViewWindows which are displayed in the View area. Should be according to 

the value of Cameras. 

Possible values are: 

1, 4, 6, 8, 9, 10, 12, 16 and 25. 

Example: 

http://IP-Address/view/activex.htm?picsize=2&Cameras=15&ViewCount=4

Create an ActiveX Control inside a HTML Page 

The Convision ActiveX Control can be created inside a HTML Page as an OBJECT. 

The OBJECT TAG contains the following parameters: 


classid This OBJECT must contain the right Class ID. The Class ID is a unique ID which 

defines which control should be used. 

codebase With the parameter codebase a URL can be defined where the browser should load 

the Control if it is not already installed. A version number must be entered if the control 

should be updated automatically to this version. 

width Width of the Images 

height Height of the Images 

border Indicate if a border should be shown around the images. 

To configure an ActiveX Control, different parameters can be defined, for example IP address, username and 

password. The parameters are described in the next chapters. 

The following example shows how to create a Convision ActiveX Control inside a HTML page. 

The streaming starts instantly without any scripting. Please make sure that you have the file 

"ConvisionVideo.cab" in your HTML folder or already installed locally on your computer. The ActiveX Control 

used in this example belongs to firmware 4.7.0: 

 

 

 

 

 

 

 

 

 

ActiveX is just supported by Microsoft Internet Explorer! 

Convision Multiview ActiveX Control Configuration 

The Convision Multiview ActiveX Control is a component for displaying video streams from different cameras of 

a Convision V4000/V800/V1600 and V400+/V600+/V200 series of video surveillance servers. Of course it can 

also be used to display only one camera from one device. In extern Applications the Convision Multiview can 

also display different cameras of different devices, as you can see in the Central Manager. 

The ActiveX Control can be integrated multiple times on a HTML page to show more than one video stream at a 

time. However, to display several cameras from one device, it is better to create only one ActiveX Control and 

set the appropriate number of cameras and view windows (see parameters below). This will reduce the amount 

of resources that is used in the device, because only one stream will be opened. This will increase the 

maximum number of cameras which can be viewed simultaneously. 

Properties: 

The following Parameters can be set to configure the ActiveX Control: 

Parameter Definition Type Default 

Url Indicate the URL which the ActiveX 

Control use to obtain Video Data, 

should be "/stream.live". 

This Parameter should only be used 

for analog cameras if a special URL 

unequal to the default “/stream.live”. 

STRING "/stream.live" 

AutoStart 

For LAN Cameras this parameter is 

not needed, because it is set to the 

appropriate value by the ActiveX 

Control. 

Automatically start the VideoStream. BOOL FALSE 

IpAddress IpAddress is the IP address or the 

name of the video server from which 

the video will be streamed. 

STRING "" 

Port Port of the Server from which the 

data should be obtained. 

LONG 80 

ProxyIpAddress The ProxyIpAddress is needed if the 

video server is only being reached 

via a proxy server. If there's no need 

of a proxy server you have to use the 

default value. 

STRING "" 

ProxyPort The ProxyPort is needed if the video 

server is only being reached via a 

proxy server. This parameter is only 

used if the ProxyIpAddress is being 

set to a proper value. 

LONG Equal to Port 

Atc Atc is an authorization string, which 

can be used to get a stream from 

protected video servers, instead of 

the parameters UserName and 

UserPassword. It consists of a 

BASE64 coded string of the following 

format: ‘user:password’. 

STRING "" 

Cameras Indicates which cameras should be 

shown. This is a bitfield, where every 

bit represents one camera, for 

example 7 (= 1 + 2 + 4) shows the 

cameras 1, 2and 3. 

LONG 1 

ShowTime Indicate if the time should be shown 

in the video stream. 

BOOL FALSE 

ShowCaption Indicate if the camera name should BOOL FALSE

e shown in the video stream. 

MotionDisplayThreshold If motion is being detected in the 

current frame and the resulting 

motion intensity is greater than the 

value specified by 

MotionDisplayThreshold, a red 

border will be displayed in the current 

frame. So the default value of 

0xFFFFFFFF suppresses the display 

of the border since motion values will 

never reach this value. 

MotionAreaEditMode If MotionAreaEditMode is TRUE the 

control will display an editable grid of 

active motion areas for the specified 

camera. Note: this grid is only 

available in a single display mode. 

See also the related methods 

ReadMotionArea and 

WriteMotionArea. 

ShowMotionValue The current motion value will be 

displayed if ShowMotionValue is 

TRUE in a bar like graph. 

The displayed value, however, is the 

result of the following function: 

LONG 0xFFFFFFFF 

BOOL FALSE 

BOOL FALSE 

UserName 

display_value = 

min(ld(motion_value), 16) 

Username for login on the Convision 

Server. 

STRING "" 

UserPassword Password for login on the Convision 

Server 

STRING "" 

ViewCount Number of ViewWindows which are 

displayed in the View area. Should 

be according to the value of 

Cameras. 

Possible values are: 

1, 4, 6, 8, 9, 10, 12, 16 and 25. 

LONG 1 

DeviceName The DeviceName is shown in 

addition to the camera name in the 

title area of the picture, but only if 

ShowCaption is set to TRUE. 

STRING "" 

CameraControlEnabled For dome-cameras with move- and 

zoom-capabilities this parameter 

enables the control tool. This tool is 

displayed in the picture as an overlay 

and can be used, to send move and 

zoom commands to the camera. 

BOOL FALSE 

TimeServer For LAN-cameras a TimeServer can 

be applied, to display the time values 

on the video window. 

STRING "" 

CameraTyp This parameter indicates the type of 

camera, currently possible values 

are: 

0 = Analog Camera 

2 = Axis 

3 = Mobotix 

LONG 0

Methods: 

The following methods listed here will return TRUE on success else FALSE. 

Method Definition 

StartStream StartStream starts the streaming from the video server. Can be used instead of 

AutoStart. 

Parameter: 

StreamMode : must be 0 for streaming 

TargetTime : ignored, should be 0 

Direction : ignored 

StopStream StopStream stops the current streaming from the video server. 

ReadMotionArea ReadMotionArea reads the current active motion area used for motion detection. This 

method should be called when the control is in "motion area edit mode". See also the 

property MotionAreaEditMode. 

Parameter: 

Index : Index of the ViewWindow, should be 0. 

WriteMotionArea WriteMotionArea writes the user defined motion area back to the server. This method 

should be called when the control is in "motion area edit mode", when the user 

activated a save button. See also the property MotionAreaEditMode. 

Parameter: 


ClearMotionArea ClearMotionArea clears the user defined motion area intern. It doesn't affect directly 

the current active motion area inside the server. This method should be called when 

the control is in "motion area edit mode". See also the property MotionAreaEditMode. 

Parameter: 


FillMotionArea FillMotionArea fills the whole user defined motion area intern. It doesn't affect directly 

the current active motion area inside the server. This method should be called when 

the control is in "motion area edit mode". See also the property MotionAreaEditMode. 

Parameter: 


OpenIniFile With this method a INI File from the central manager can be displayed. 

Parameter: 

INIFile: Full path of the INI File which should be opened is needed. 

SaveIniFile With this method the current view settings get saved in a INI File which can be used 

from the central manager. The full path of the INI File where the settings will be saved 

is needed. 

Parameter: 

INIFile: Full path of the INI File which should be saved is needed. 

To use this control in C/C++ two source files from Convision should be used. Please, ask the technical support 

for more information. 

Note: The MotionArea methods are designed to be used with only one ViewWindow per ActiveX Control, i.e. 

ViewCount should be set to 1, if the MotionArea functionality is used.

6. RAW Motion JPEG Data 

RAW Motion JPEG Data, only JPEG after JPEG without a Motion JPEG Header, can be obtained with the 

following URL: 

/stream.live 

This URL can only be opened with a HTTP GET stream request. This URL can not be displayed directly in any 

browser. It can only be used by programmers. 

For this URL the following parameters can be set: 

Parameters Definition 

cameras In difference to the parameter camera used above this parameter is a binary value. 

Possible Values for this parameter you can find below. 

fps Optional: To Limit the data send from the Convision box over Ethernet, this parameter 

can be used. It is not possible to increase the frames per second only to restrict them. 

If a fps value is set bandwidth saving is deactivated from this stream. 

Possible values for the parameter cameras: 

Dezimal Hex Definition 

1 0x1 Camera 1 





.. .. .. 

32768 0x800 Camera 16 

65551 0x1000F 4-fold View, obtain 4 cameras via the stream 

1048639 0x10003F 6-fold View, obtain 6 cameras via the stream 

524543 0x800FF 8-fold View, obtain 8 cameras via the stream 

266239 0x40FFF 12-fold View, obtain 12 cameras via the stream 

196607 0x2FFFF 16-fold View, obtain 16 cameras via the stream 

The lower 16 bits define the cameras to be streamed whereas the upper 16 bits define the display mode. 

Examples for a single display of camera 4: 

cameras = 0x00000008 

Example for a quad display of cameras 5, 6, 7 and 8: 

cameras = 0x000100F0 

Be carefully about this numbers, for example do not use the number 524543 to transmit images from the V600. 

Example: 

http://IP-Address/stream.live?cameras=65551

7. Authorization 

Authorization data can be sent inside the HTTP Header. The Convision System only accepts the currently 

configured authentication. Possible settings are digest authentication, basic authentication or deactivated (none) 

authentication. 

GET URL HTTP/1.1 

Accept: */* 

Accept-Language: de 

Accept-Encoding: gzip, deflate 

Connection: Keep-Alive 

Authorization: Digest .... 

The digest or basic authentication algorithm can be obtained from Convision.

8. Pan / Tilt / Zoom – Cameras 

You can attach different controllable cameras and dome cameras to the Convision IP video server. The 

cameras are controlled with the following URL parameters for the transmission of an image or an image 

sequence. The cameras have different minimum and maximum values or do not support all functions depending 

on design and manufacturing conditions. 

/CamCapabilities?camera=X 

X = 1-16 

The following information can be obtained from a HTTP GET request. 


Move capability OK or NO depending on the percent move capability (ppan, ptilt, ismap) off 

the camera. 

Zoom capability OK or NO depending on the percent zoom capability (pzoom) off the 

camera. 

Focus capability OK or NO depending on the percent focus capability (pfocus) off the 

camera. 

Menu capability OK or NO depending on the menu capability off the camera. 

Swing capability OK or NO depending on the swing capability off the camera. 



OK;OK;NO;OK;OK; 

New data may be added in the future add the bottom of the list. Unknown new data should be ignored by the 

interpreter. 

/CamPositionNames?camera=X 

X=1-16 

Returns the camera preset position names separated by semicolon. 

/TourState?state=Y&camera=X 

X=1-16 

Y=0,1,2 

Starts or stops the camera tour (state 0 = stop tour, 1 starts tour,2 pause tour). 

/TourData?op=Z&data=Y&camera=X 

X=1-16 

Get or set Tour Data. To get the current tour data of a camera set the parameter op to "GET" and the camera 

number, the other parameters are unused in this case. To set the tour data of a camera set the parameter op to 

"SET", the camera number and data to the new tour data. The tour data has the following format: (Position- 

1).SecondsToWait. Positions which are not used are not used in the tour. 

Example: 0.3;3.1; 

Position 1 for 3 seconds, Position 4 for 1 second

URL Functions 

The parameters can be utilized with the URL "/Camera.jpg" or "/pantilt". In the first case the camera is controlled 

and an image transmitted, in the other case only the camera is controlled, e.g. during the transmission of a 

image sequence, which is separately called with "fullsize.push". 

Parameter Definition Scope Remarks 

pan= moves the camera horizontal to the 

specified value in degrees in the indicated 

direction 

ppan= moves the camera horizontal to the 

proportional value, related to the zero 

position and the max. direction. For a 

Camera which only allows relative 

positions, like CC5400, one move step as 

high as the percent value is executed. > 0 

move right, < 0 move left. 

rpan= moves the camera horizontal relative to 

the current position around the specified 

value in degrees in the indicated direction 

tilt= moves the camera vertically to the 

specified value in degrees in the indicated 

direction 

ptilt= moves the camera vertically to the 


position and the max. direction. For a 

Camera which only allows relative 

positions, like CC5400, one move step as 

high as the percent value is executed. > 0 

move down, < 0 move up. 

rtilt= moves the camera vertically relative to the 

current position around the specified value 

in degrees in the 

indicated direction 

zoom= stops the indicated zoom shot factor, 

whereby the value 1 is for the fully 

complete zoom status 

pzoom= zoom shot of the camera to the 


position and that max. 

zoom shot. For a Camera which only 

allows relative positions, like CC5400, one 

zoom step as high as the percent value is 

executed. > 50% Zoom in, < 50% Zoom 

out. 51% Zoom in a little, 100% Zoom in to 

Maximum. 

- 180 ... +180 The max. area dependent in each 

case on the assigned camera 

-100...+100 Max. horizontal direction is equal to 

100% 





-100...+100 Max. vertical direction is equal to 

100% 



1 ... 999/ in/ out The max. area dependent in each 


0...+100 Max. zoom is equal to 100% 

zoomrel= reduces or increases the zoom factor wide, tele Changes the value amount, 

dependent on the assigned camera. 

zoomabs= 1 zoom completely out 1..X Value and behavior dependents on 

the assigned camera. 

rpzoom= Zoom relative to the given position. Value depends on camera. 

move= moves the camera in the indicated 

direction [uleft = up left, uright = up right, 

dleft = down left, dright = down right]. 

up / down / 

right / left / 

home/ uleft / 

uright / dleft / 

dright 

left= Continuous moving left. Start / stop 

right= Continuous moving right. Start / stop 

up= Continuous moving up. Moving with 

pspeed 

down= Continuous moving down. Moving with 

pspeed= Value of speed in percents for the 

commands move, left, right, up and 

The angle depends on the assigned 

camera 

pspeed 

0-100 Max. speed is equal to 100%

moveabs=, 

down. If not set the default speed is 

used. 

moves the camera horizontally and -180 ... +180 The max. area depends on assigned 

vertically to the specified values in degree. 

camera. 

focusrel= modifies the focus of a camera without far, near Changes the value amount, 

autofocus for a close-distant or remotedistant 

range 


pfocus= Execute one focus step as high as the 0...+100 Max. focus near is equal to 100%, 

percent value. > 50% Focus Near, < 50% 

Zoom Far. 51% Focus near a little, 100% 

Focus near maximum. 

0% is equal to 100% focus far. 

irisrel= adjusts the light beam into the iris open, close Changes the value amount, 


focusmode= Changes the operating mode of the focus auto, manual 

setpreset= stores camera position and shows it 1 … 

The command “center” resets the 

showpreset= again. With the additional Parameter 

name for setpreset a name for preset 1-18 

can be saved. 

6/home/center home position. 

menu= For the navigation through the camera menu/enter/left/ 

menu. The command “menu” opens 

the menu, “enter” selects a menu 

entry. 

up/right/down 

Ismap=?< This function is used when the user Picturesizeid 0 

xValueInPicture>, 

clicks inside a picture and the camera 

zooms to that position. 

= Picture Size 

0, 1 = 192x144, 

2 = 384x288, 3 

= 786 x 576, 4= 

320x240 ,5 = 

640x480. 

XValueInPictur 

e = Relative X 

Value in 

Picture, 

yValueInpicture 

= Relative Y 

Value in 

Picture. 

The movement commands pan and tilt, rpan and rtilt as well as ppan and ptilt should not be mixed in the URL, 

e.g. ppan together only with ptilt, but not with tilt or rtilt.

The following table shows the supported cameras from the Convision IP video servers with their function range 

and the possible values: 

Camera RS485 pan tilt zoom move home 

360Vision (16xZoom) yes -180 … 180 -90 … 0 0 .. 16000 yes*1 yes 





Canon VC-C4 - -100 … 100 -30 …30 0 … 1070 yes *1 yes 

Canon VC-C4R - -170 … 170 -90 … 10 0 … 1070 yes *1 yes 

Convision 5400 yes -180 ... 180 -90 ... 0 yes - 

Convision 5451IR yes - - - 

Convision 5451IR/AF yes - - - 

Dennard Type 2050 [>= V4.0 Build 1883] yes -180 … 180 -90 … 0 0 … 100 yes *1 yes 

Ernitec BDR510 - - - - yes - 

Ernitec BDR550 - - - - yes - 

Honeywell HSD-251P yes - - - yes - 

JVC TK-C675 (JCBP-S) yes -180 … 180 -90 ... 0 0 … 166 yes *1 yes 

JVC TK-C676 yes -180 … 180 -90 ... 0 0 ... 3000 yes*1 yes 

Merit Li-Lin Fast Dome PIH-7000 Series yes - - - yes - 

Panasonic WV-CS850B Series [regular 

control] 

yes -180 … 180 -90 ... -2 0 ... 100 yes - 

Panasonic WV-CS850B Series 

[advanced control] 

yes -180 … 180 -90 ... -2 0 ... 100 yes*1 yes 

Panasonic WV-CS950 Series regular 

control] 

yes -180 … 180 -90 ... -2 0 ... 100 yes 

Panasonic WV-CS950 Series [advanced yes -180 … 180 -90 ... -2 0 ... 100 yes*1 yes 

control] 

Pelco Spectra II und III [D-Protocol] yes - - - yes - 

Philips G3 AutoDome - - - - yes - 

Samsung SCC-641 [Vicon-Protocol] yes - - - yes - 

Santec VDC-300ID/VDC-400ID yes -180 … 180 -90 … 0 0 .. 16384 yes *1 yes 

Santec VDC-310ID [Fastrax II] yes -180 … 180 -90 ... 4 0 .. 16384 yes*1 yes 

Sanyo VCC-9300P/VCC-9400P yes -180 ... 180 -90 ... 5 0 … 7936 yes - 

Sanyo VCC-9600P/VCC-9800P yes -180 ... 180 -90 ... 5 0 … 7936 yes - 

Sanyo VCC-ZM300P yes 

Sanyo VCC-ZM400P yes 

Sensormatic SpeedDome Optima yes -180 … 180 -90 … 20 0 … 4096 yes *1 yes 

Sensormatic SpeedDome Ultra yes -180 … 180 -90 … 22 0 … 100 yes *1 yes 

Sony EVI-D30/D31 - -100 … 100 -25 …25 0 … 1023 yes *1 yes 

Sony EVI-D70P - -170 ... 170 -90 ... 30 0 .. 31232 yes*1 yes 

VCL Microsphere Orbiter yes -180 … 180 -90 … 0 0 … 1023 yes *1 yes 

VCL Microsphere OrbiterGold yes -180 … 180 -90 … 0 0 … 1023 yes *1 yes 

Vicon Surveyor 2000-16 yes -180 … 180 -90 … 0 0 … 128 yes *1 yes 

Vicon Surveyor 2000-22 yes -180 … 180 -90 … 0 0 … 176 yes *1 yes 

Vicon Surveyor VFT yes -180 … 180 -90 … 0 0 … 128 yes *1 yes 

Vicon Surveyor 99 yes - - yes - 

Videotec DTMRX1 yes - 

RS485 – always in half duplex mode

Possibilities of not listed cameras can be obtained from the manual of the camera. 

Camera ppan pzoom rpan zoomrel focusrel irisrel preset 

ptilt 

rtilt 

360Vision (16xZoom) yes yes yes - - - 





Canon VC-C4 yes yes yes - - - yes 

Canon VC-C4R yes yes yes - - - yes 

Convision 5400 yes yes wide, tele yes 

Convision 5451IR - yes wide, tele far, near yes 

Convision 5451IR/AF - yes wide, tele yes 

Dennard Type 2050 [>= V4.0 Build 1883] yes yes yes - - - yes 

Ernitec BDR510 - - - wide, tele far, near open, close - 

Ernitec BDR550 - - - wide, tele far, near open, close yes 

Honeywell HSD-251P - - - wide, tele far, near open, close yes 

JVC TK-C675 (JCBP-S) yes yes yes - - - yes 

JVC TK-C676 yes yes yes - - - yes 

Merit Li-Lin Dome PIH-7000 Series - - - wide, tele far, near open, close yes 

Panasonic WV-CS850B Series [regular 

control] 

- - - wide, tele far, near open, close yes 

Panasonic WV-CS850B Series 

[advanced control] 

yes yes yes yes 

Panasonic WV-CS950 Series [regular 

control] 

- - - wide, tele far, near open, close yes 

Panasonic WV-CS950 Series [advanced yes yes yes yes 

control] 

Pelco Spectra II und III [D-Protocol] - - - wide, tele far, near open, close yes 

Philips G3 AutoDome - - - wide, tele far, near open, close yes 

Samsung SCC-641 [Vicon-Protocol] - - - wide, tele far, near open, close yes 

Santec VDC-300ID/VDC-400ID yes yes yes - - - yes 

Santec VDC-310ID [Fastrax II] yes yes yes - - - yes 

Sanyo VCC-9300P/VCC-9400P yes yes wide, tele yes 

Sanyo VCC-9600P/VCC-9800P yes yes wide, tele yes 

Sanyo VCC-ZM300P - yes wide, tele open, close 

Sanyo VCC-ZM400P - yes wide, tele open, close 

Sensormatic SpeedDome Optima yes yes yes - - - yes 

Sensormatic SpeedDome Ultra yes yes yes - - - yes 

Sony EVI-D30/D31 yes yes yes - - - yes 

Sony EVI-D70P yes yes yes - - - yes 

VCL Microsphere Orbiter yes yes yes - - - yes 

VCL Microsphere OrbiterGold yes yes yes - - - yes 

Vicon Surveyor 2000-16 yes yes yes - - - yes 

Vicon Surveyor 2000-22 yes yes yes - - - yes 

Vicon Surveyor VFT yes yes yes - - - yes 

Vicon Surveyor 99 - - - wide, tele far, near open, close yes 

Videotec DTMRX1 - - - wide, tele far, near open, close 

*1 – Camera angle moves exactly "actual apex angle/10 " 

Possibilities of not listed cameras can be obtained from the manual of the camera.

Examples: 

This command adjusts camera 1 to Zoom=50% and then transmits an image: 

HTTP://IP-Address/Camera.jpg?camera=1&pzoom=50 

This command moves the camera from the " home" position, horizontal 30° to the right and 

turns 20° downward and then transmits an image: 

HTTP://IP-Address/Camera.jpg?camera=1&pan=30&tilt=-20

9. Outputs and Inputs 

/output/dioswitch 

With this URL the Outputs can be switched on and off and the current state of the inputs can be fetched. 

Parameter Definition Scope 

rl1, …, rl4 Switch the relay Output, rl1 switch Output 1, rl2 switch 

Output 2 and so on 

on, off 

getstate Get the state of a Input. 1-4, M and F 

Example: 

http://IP-Address/output/dioswitch?rl1=on 

http://IP-Address/output/dioswitch?rl1=off 

http://IP-Address/output/dioswitch?getstate=1 

10. Video Out 

/config/videoout 

Change the Video Output. 


type 1-16 show camera 1-6 as Video Out. 

17 show all cameras on Video Out 

18 show camera 1-4 on Video Out 




Example: 

http://IP-Address/config/videoout?type=1

11. URL- calls to force actions 

With the following URL you can force dedicated actions. 

/config/urlevent 


type Indicate if the actions should be started or stopped. 1 start actions, 0 stop 

actions. 

nr Number of the event. 

On the configuration page "Advanced/Events/Url call" you can define different actions which should be started 

or stoped if the specified urlevent number is called. 

Example: 

Start all actions defined for urlevent 2 

http://IP-Address/config/urlevent?type=1&nr=2 

Stop all actions defined for urlevent 2 

http://IP-Address/config/urlevent?type=1&nr=2 

Note: Some actions can only be started and not stopped, how for example Record start. 

12. Set/Get Motion Detection Mask 

/motiondetection.mask 

Get or set the motion detection mask of a camera. 


camera Camera number for which the motion detection mask should be selected. 

The motion detection mask is an array of bytes, where every byte represents a rectangle of the motion area. 

In Halfres Mode one rectangle is 8x8 pixel and in High res Mode one rectangle is 16x16 pixel. 

The value of each byte in the motion detection mask is 0 or 1, depending on the activation of the motion 

detection. 

The size of the motion area is: 

MOTION_AREA_WIDTH/8 * MOTION_AREA_HEIGHT/8 = (44 * 36 = 1584 bytes) 

If a HTTP GET Message is send the motion detection mask is returned. The first 4 bytes contains the length of 

the array, i.e. 1584. Then the bytes of the array are returned. 

In a HTTP POST Message, which is used to save the motion data, the length must not be send.

13. Examples 

Viewing application with HTML 

Multiview HTML page with 4 devices 

This example is using the Convision live demo and can be tested unchanged. 

 

Convision Live Demo 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Multiview HTML page one device 4 cameras 

This example is using the Convision live demo and can be tested unchanged. 

In the example above 4 different devices could be used. In this example only one device is used but the click behaviour of 

the OCX is integrated. 

 

 

 

Convision Live Demo 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Move and Zoom functions 

This example HTML page contains a table with two columns, on the left the controls, on the right the image. 

The Javascript function JS_ Move(x) is called through one click on the occupied fields of the control (map) 

Depending upon the transferred parameters the camera is moved or zoomed in a direction then an image is 

transmitted. 

 

 

cameracontrol-JPEG 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Pan/Tilt/Zoom cameras for the transmission of image sequence 

The example describes a HTML page which is part of a Frameset. On this page there is a double column table, 

again on the left is a table with the controls and on the right it contains the display of the image sequence. 

In the example the .gif image buttons, which utilize the control, are stored in a subdirectory (< img 

src="buttons/x.gif " >). They are here, up to the item "control.gif ", to which the map "position" refers directly, not 

described near, the creation is left up to your imagination. 

By clicking on the buttons the appropriate parameters and the PanTilt in the IP video server is utilized . 

All commands for camera control are sent to an empty Frame ( target="vcempty "). This Frame is in the 

same Frameset as the Frame which contain the image display and control but it has no contents. Thus 

the command is sent to the IP video server, however it causes no reloading of the frames with the image 

sequence and the stream can run continuously. 

 

 

Camera control Motion-JPEG 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

14. HTTP-Response Codes 

HTTP/1.0 200 OK 

Success 

HTTP/1.0 400 Bad Request 

The request had bad syntax or was impossible to get processed 

HTTP/1.0 401 Unauthorized 

Invalid Authorization 

HTTP/1.0 404 Not Found 

Invalid URL or no data 

HTTP/1.0 503 Service Unavailable 

Too many Clients (in the first version only one client can be connected)

Convision API LiveView.pdf

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?