INF: click.cgi API v5.6, (c) MOBOTIX AG, 2001-2014 INF: INF: Function Example Explanation INF: ----------------------------------------------------------------------------------------------------------------------- INF: INF: Set Coordinates /control/click.cgi?x=500&y=250&mode=1&target_zoom=1000 INF: Center valid pixel in current live image or INF: define a click rectangle. INF: mode: OR-ed keyboard state: INF: 0=no key (default), 1=shift, 2=ctrl, 4=alt, 8=meta. INF: target_zoom: the zoom on the clicked position. INF: INF: Define Click-Rectangle /control/click.cgi?rect=0,0,1279,959&ptz_window=1 INF: /control/click.cgi?rect=top Define a click rectangle on the INF: current PTZ window. Use predefined named INF: rectangles or coordinates. Coordinates are INF: virtual (as with video motion and exposure INF: windows), i.e. origin in the lower left INF: corner, 1279,959 for the upper right. INF: ptz_window: PTZ window for this operation. INF: Predefined names for rect: all, quarter, INF: center, spot, top, middle, bottom, right, INF: vertical, left. INF: INF: Define Click Corridor /control/click.cgi?corridor=800,440,800,520,360&ptz_window=1 INF: Define a click corridor on the current INF: PTZ window. Coordinates are virtual (as with INF: video motion and exposure windows), i.e. origin INF: in the lower left corner, 1279,959 for the INF: upper right. INF: ptz_window: PTZ window for this operation. INF: INF: Set Zoom /control/click.cgi?zoom=2000&snap Zoom values from 1000 to 8000 INF: (magnification in permille). INF: x, y: Optional parameters; the designated INF: pixel of the JPEG image will be used INF: as the fixed point in the scaling INF: operation (i.e. it will not move). INF: snap: Optional parameter to snap to the INF: zoom levels visible in the menu. INF: Supports parameters eye and ptz_window. INF: INF: Zoom In/Out /control/click.cgi?zoomrel=-100&snap Change zoom relative to the current value. INF: Valid changes are -10000 to 10000 (in INF: permille). INF: x, y: Optional parameters; the designated INF: pixel of the JPEG image will be used INF: as the fixed point in the scaling INF: operation (i.e. it will not move). INF: snap: Optional parameter to snap to the INF: zoom levels visible in the menu. INF: Supports parameters eye and ptz_window. INF: INF: Zoom to Rectangle /control/click.cgi?zoomrect&snap Zoom to the currently selected rectangular INF: area. INF: snap: Optional parameter to snap to the INF: zoom levels visible in the menu. INF: Supports parameters eye and ptz_window. INF: INF: Set Pan Position /control/click.cgi?pan_x=50&pan_y=25&zoom=1000 Set pan position relative to sensor in INF: values from -1000 to 1000, where -1000 is INF: at the bottom or left edge, respectively. INF: Supports parameters eye and ptz_window. INF: Additionally, the zoom can be changed. INF: INF: Set Pan Position /control/click.cgi?move&x=0&y=250 Set pan position as described above. INF: Supports parameters eye and ptz_window. INF: INF: Change Pan Position /control/click.cgi?moverel&x=10&y=-20 Change pan position by the given amount INF: (degrees or pan coordinates, as with move). INF: Supports parameters eye and ptz_window. INF: INF: Set Angular Pan Position /control/click.cgi?move&h=10&v=20 Set lens correction angular pan position in INF: degrees. INF: The interpretation and permissible range INF: varies with the lens type and mounting INF: orientation. INF: Supports parameters eye and ptz_window. INF: INF: Change Angular Pan Position /control/click.cgi?moverel&h=10&v=-20 Change angular pan position by the given INF: amount in degrees. INF: Supports parameters eye and ptz_window. INF: INF: Configure Auto-Rotate /control/click.cgi?moveauto&h=10&v=0&views= Continually change the pan position with INF: the given speed (degrees/second). Omitted INF: values will be set to zero. INF: Alternatively give a comma separated list INF: of views that will be loaded one after INF: the other. Not specifying any parameter INF: stops the Auto-Rotate function. INF: Supports parameters eye and ptz_window. INF: INF: Center Pan Position /control/click.cgi?center Center the point of view. INF: Supports parameters eye and ptz_window. INF: INF: Remove Keystone distortion /control/click.cgi?keystone&delta=10&target_win=1 INF: To remove the keystone distortion: INF: delta in percent [-100:100] INF: Window (-1 means current ptz window) INF: INF: Horizon Correction /control/click.cgi?horz_correction&delta=10&reset INF: Rotate the camera horizon to correct mounting INF: errors (delta [-100; 100]). If reset is set, INF: the angle will be reset to zero. INF: INF: Save View /control/click.cgi?setview=1&no_msg&ptz_window Save current zoom/pan settings to the given INF: view in the config file. The number must be INF: in the range 0 to 255, the default is 0. INF: Can be combined with the zoom command. INF: If parameter no_msg is provided, the 'save INF: view' message will be disabled. INF: Parameter ptz_window defines the window to be affected. INF: The ptz window selection will be updated INF: Note: The views 128 and up are reserved for INF: internal use. Overwriting them may INF: compromise your general camera view INF: setup! INF: View 0 is a special case: Using it INF: will save or load all of your INF: currently visible windows' views. INF: INF: Load View /control/click.cgi?loadview=3&no_msg&ptz_window Load zoom/pan settings from the given view INF: in the config file. The number must be in INF: the range 0 to 255, the default is 0. INF: If parameter no_msg is provided, the 'load INF: view' message will be disabled. INF: Parameter ptz_window defines the window to be affected. INF: The ptz window selection will be updated INF: Note: The views 128 and up are reserved for INF: internal use. Overwriting them may INF: compromise your general camera view INF: setup! INF: View 0 is a special case: Using it INF: will save or load all of your INF: currently visible windows' views. INF: INF: Auto Define Views /control/click.cgi?def_surround Use current position to automatically INF: define views according to camera mounting INF: type: INF: ceiling: sets north, east, south, west. INF: wall: sets top left, top right, bottom INF: left, bottom right. INF: INF: Syncronise Views /control/click.cgi?sync&mode=0 Store the PTZ parameters of the present display mode of one sensor INF: into the similar display mode of the other sensor. The mode can be 0 for INF: load-from or 1 for store to the other sensor. INF: INF: Delete All Views /control/click.cgi?delete_all_views Delete all views from configuration file. INF: INF: Delete All Surround Views /control/click.cgi?delete_surround_views Delete all surround (Panorama, Panorama/Focus, etc.) views from config file INF: INF: Select PTZ Window /control/click.cgi?ptz_window=0 Select the target window for any PTZ and INF: view load/save operations not controlled by INF: the mouse. 0 always denotes the top or top INF: left position, further numbers follow in INF: reading direction. INF: INF: Save Custom Exposure Field /control/click.cgi?add_exp_win&rect=spot Adds or replaces an user defined exposure field. INF: /control/click.cgi?replace_exp_win If the window is not specified using the INF: parameter "rect" (see above), INF: the current screen rectangle is used. INF: Sets the exposure area to custom. INF: INF: Save VM Window /control/click.cgi?add_vm_win&rect=right Adds or replaces an user defined INF: /control/click.cgi?replace_vm_win video motion window. If the window is not INF: specified using the parameter "rect" (see INF: above), the current screen rectangle is used. INF: INF: Flash VM Windows /control/click.cgi?vmflash= Flashes all motion windows used in the INF: specified event set. INF: INF: Save Analysis Window /control/click.cgi?add_analysis_win Adds or replaces an user defined analysis window INF: /control/click.cgi?replace_analysis_win using the current screen rectangle. INF: INF: Save Counting Corridor /control/click.cgi?add_counting_corridor Adds or replaces an user defined counting corridor INF: /control/click.cgi?replace_counting_corridor using the current screen corridor. INF: INF: OSC action "vertical" /control/click.cgi?osc_vertical&delta=&target_win=&reset INF: Performs the same action like the related OSC control. "delta" in +/- percent*100 INF: of the maximum control step. Parameter "target_win" selects the target INF: window (-1=both, 0, 1). This parameter is not supported by all cameras. INF: (-1 means both windows for D14D-180 cameras or active PTZ windows for usual cameras) INF: "reset" triggers reset to the default value. INF: INF: OSC action "horizontal" /control/click.cgi?osc_horizontal&delta=&target_win=&reset INF: Performs the same action like the related OSC control. "delta" in +/- percent*100 INF: of the maximum control step. Parameter. "target_win" selects the target window INF: (-1 means both windows for D14D-180 cameras or active PTZ windows for usual cameras) INF: This parameter is not supported by all cameras. "reset" triggers reset to the default value. INF: INF: OSC action "zoom" /control/click.cgi?osc_zoom&delta=&target_win=&reset INF: Performs the same action like the related OSC control. "delta" in +/- percent*100 of the INF: maximum control step. Parameter "target_win" selects the target window INF: (-1 means both windows for D14D-180 cameras or active PTZ windows for usual cameras) INF: This parameter is not supported by all cameras. "reset" triggers reset to the default value. INF: INF: OSC action "rotate" /control/click.cgi?osc_rotate&delta=&target_win=&reset INF: Performs the same action like the related OSC control. "delta" in +/- percent*100 of the INF: maximum control step. Parameter "target_win" selects the target window. INF: (-1 means both windows for D14D-180 cameras or active PTZ windows for usual cameras) INF: This parameter is not supported by all cameras. "reset" triggers reset to the default value. INF: INF: OSC action "center pan" /control/click.cgi?osc_center_pan&target_win= INF: Performs the same action like the related OSC control. Parameter "target_win" selects INF: the target window (-1 means both windows for D14D-180 cameras or active PTZ windows for usual INF: cameras). INF: INF: OSC action "window type" /control/click.cgi?osc_window_type&target_win=&type= INF: Performs the same action like the related OSC control. Parameter "target_win" selects the INF: target window. "type" can be c=panorama, s=usual lenscorrected and f=unchanged. INF: INF: OSC action "change sensor" /control/click.cgi?osc_change_sensor&target_win=&eye= INF: Performs the same action like the related OSC control. Parameter "target_win" selects the INF: target window. Parameter "eye" the source sensor. INF: INF: Query /control/click.cgi?query Retrieve current zoom/pan settings. INF: INF: Help /control/click.cgi?help Show this help page. INF: INF: List Parameters /control/click.cgi?list List all available parameters with ranges. INF: INF: INF: Note: The parameter eye (0=right, 1=left) is deprecated! Use the parameter ptz_window instead.