Go to documentation repository
The MONITOR object corresponds to the Monitor system object.
The MONITOR object sends events presented in the table. Procedure is started when the corresponding event occurs.
List of commands and parameters for the MONITOR object is presented in the following table:
| Event | Description | Comment |
| STARTED_AVI_EXPORT | Video export started | Among others, the event has the following parameters:
|
FINISHED_AVI_EXPORT | Video export finished | Among others, the event has the following parameters:
|
| AVI_EXPORT_RESULT | Video export result | The event has the same parameters as START_AVI_EXPORT with additional error_result<> having one of the following values: 0—export successful |
| PLAY_START | Start the archive fragment playback | - |
| PLAY_STOP | Stop the archive fragment playback | - |
| INTERFACE_MANIPULATION | Visualization change | param<0>—additional information displayed in the corresponding column of the Event Viewer, contains the identifier of the camera that was moved around the layout |
| LAYOUT_DEL | Deleting layout | param<0>—additional information displayed in the corresponding column of the Event Viewer, contains the name of the deleted layout |
| LAYOUT_ADD | Adding layout | param<0>—additional information displayed in the corresponding column of the Event Viewer, contains the name of the added layout |
| LAYOUT_ACTIVATE | Changing active layout | param<0>—additional information displayed in the corresponding column of the Event Viewer, contains the name of the activated layout |
| REPLACE_CAM | Changing the camera position | param<0>—additional information displayed in the corresponding column of the Event Viewer, in the following format: <Camera 1 name> → <Camera 2 name> |
| ACTIVATE_CAM | Camera activated | auto_switch<>—indicates whether slide show (auto paging, auto scrolling) was enabled at the time of camera activation. This parameter can be used to turn off slide show when activating a Video surveillance window |
| CAM_EXPAND | The Video Surveillance Window expanded to the entire Monitor | The event is generated if the following registry keys are set (see Registry keys reference guide):
Event parameters:
|
| CAM_COLLAPSE | The Video Surveillance Window collapsed back | The event is generated if the following registry keys are set (see Registry keys reference guide):
Event parameters:
|
List of commands and parameters for the MONITOR object is presented in the table:
Command—command description | Parameters | Description |
"REMOVE"—removes camera from monitor | cam<> | ID of camera in the settings tree which must be removed from monitor |
| show<> | Optional parameter. Possible values:
| |
"REMOVE_ALL"—removes all cameras from monitor | - | - |
"STOP_VIDEO"—stops video stream of camera | cam<> | ID of a camera in the settings tree, the video stream from which must be stopped |
"REPLACE"—removes all cameras from monitor and triggers the specified camera | slave_id<> | Name of a computer to which monitor belongs, it is possible to place owner in script |
cam<> | ID of a camera in the settings tree which must be displayed in the monitor | |
name<> | Name of a camera which will be displayed in the bottom-left corner | |
audio_type<> | - | |
audio_id<> | - | |
arch_id<> | - | |
control<> | 0—only archive viewing, 1—it is also possible to control (arm/disarm, record) | |
"ADD_SHOW"—adds cameras on the monitor Note. See also PLACE_CAM_IN_LAYOUT_CELL | cam<> | ID of a camera in the settings tree which must be displayed in the monitor |
name<> | Object name which will be displayed in the bottom-left corner | |
arch_id<> | - | |
control<> | 0—only archive viewing, 1—it is also possible to control (arm/disarm, record) | |
| gate_id<> | ID of the videogate through which you want to receive video. The corresponding camera must be added and configured in this videogate—see Selecting and configuring the cameras for the Videogate module | |
| slave_id<> | ID of a computer to which the command is applied | |
| stream_id<> | Stream numeric identifier, such as <4.1>, or stream type identifier, such as <stream_client_flag>, <stream_analytics_flag>, <stream_archive_flag>, <stream_alarm_flag> | |
"ACTIVATE_CAM"—activates camera | cam<> | ID of a camera in the settings tree which must be activated |
"ARCH_FRAME_TIME"—search for video archive by date and time | cam<> | - |
date<> | - | |
time<> | - | |
| mode<> | Can take the following values:
| |
"SETUP"—sets parameters of monitor | no_update<> | - |
overlay<> | Disable the mode of speed-up displaying | |
x<> | Coordinate of top-left corner (0–100) | |
y<> | Coordinate of top-left corner (0–100) | |
w<> | Size in horizontal direction (0–100) | |
h<> | Size in vertical direction (0–100) | |
max_cams<> | Maximum allowable number of cameras on the monitor | |
min_cams<> | Minimum allowable number of cameras on the monitor | |
compress<> | - | |
panel<> | Show control panel (0—disabled, 1—enabled) | |
panel_type<> | - | |
s<> | - | |
layout<> | - | |
gate<> | - | |
map_id<> | - | |
enable<> | - | |
topmost<> | 1—show screen always on top | |
type<> | Type of Monitor object | |
allow_move<> | Allows moving of window | |
arch_id<> | Archive ID | |
cycle<> | Delay when auto scrolling (1–20 sec) | |
flags<> | Flags | |
name<> | Name of object | |
overlay<> | Enable the mode of speed-up displaying. (0—no speeding-up, 1—“overlay mode” speeding-up, 2—“DirectDraw mode” speeding-up) | |
tel_prior<> | Telemetry priority | |
| gstream_version<> | If the value is not set, the function for stream auto select is disabled If the value is minBPS, then the stream for displaying is selected automatically as described in Configuring automatic selection of video stream for display | |
"ACTIVATE"—activates control panel of monitor | user_id<> | User ID |
panel_active<> | - | |
"DEACTIVATE"—deactivates control panel of monitor | - | - |
"EXPORT_FRAME"—exports frame in a JPG file | cam<> | - |
file | - | |
"KEY_PRESSED"—controls buttons of video surveillance monitor and video records archive | number<> | - |
| cam_id<> | The ID of the camera to the Video surveillance window of which the command must be applied. If the identifier is not specified, the command is applied to the active Video surveillance window (see Active Surveillance window) | |
key<> | Possible values: "ARCH_EDIT_DATE"—change date of search by archive; "ARCH_EDIT_TIME"—change time of search by archive; "ARCH_EDIT_ENTER"—enter changes of values in archive; "ARCH_EDIT_ESCAPE"—cancel editing of archive; "ARCH_EDIT_BACK"; "ARCH_EDIT_REPLACE"; "WINDOW_ZOOM_IN"—expand window of video surveillance; "WINDOW_ZOOM_OUT"—hide window of video surveillance; "ZOOM_IN"—image incoming; "ZOOM_OUT"—image removal; "CYCLE_REW"—scrolling video surveillance windows back; "CYCLE_FF"—scrolling video surveillance windows forward; "LEFT"—move the frame left in the Zoom mode; "RIGHT"—move the frame right in the Zoom mode; "UP"—move the frame up in the Zoom mode; "DOWN"—move the frame down in the Zoom mode; "MODE_VIDEO"—video surveillance mode; "MODE_ARCH"—mode of archive video records playback; "MODE_ARCH2"—mode of archive video records playback 2; "MASK_SHOW"—show mask; "MASK_HIDE"—remove mask; "ARM"—arm camera; "DISARM"—disarm camera; "REW"—rewind; "PLAY"—play; "PLAY_NONSTOP"—non-stop playback; "PLAY_FAST"—speed up video record playback; "FF"—fast forward; "RECORD"—record; "RECORD_MIC"—record from microphone; "STOP"—stop; "REC_STOP"—stop record; "PAUSE"—pause; "MIC_ON"—microphone On; "MIC_OFF"—microphone Off; "PRINT"—print the frame; "SELECT_LAYOUT"—control layout of video surveillance monitor; "START_CYCLE_FF"—enable automatic forward scrolling of video surveillance windows. Period of scrolling video images is specified when configuring the Monitor interface object (see Configuring the display mode of camera windows); "STOP_CYCLE"—stop slide show of Video surveillance windows; "EXPORT_DO"—open the AviExport tool for background export (see The AviExport utility); "PROTECT_DO"—open the dialog box to create a bookmark (see Create a bookmark); "PROTECT_VIEW"—show the bookmark list (see List of bookmarks) | |
"START_AVI_EXPORT"—starts video export Note. See the examples in Examples of scripts with Cameras and Video surveillance monitor | start<> | Start time |
finish<> | End time | |
avi_path<> | Path to created file | |
cam<> | Camera ID | |
"STOP_AVI_EXPORT"—stops video export | monitor<> | Number of monitor |
| "START_AVI_SCHEDULE"—starts bookmarks export | - | - |
| "STOP_AVI_SCHEDULE"—stops bookmarks export | - | - |
"CONTROL_TELEMETRY"—Telemetry control. See Mouse PTZ control | cam<> | ID of a camera on which you want to enable or disable the mouse PTZ control |
| on<> | 0—disable mouse PTZ control 1—enable mouse PTZ control | |
| "SET_REC_RESTART"—set recording restart when entering the archive | - | - |
| "RESET_REC_RESTART"—reset recording restart when entering the archive | - | - |
| "SET_ARCH_ENTER_PAUSE"—enable playback pause when entering the archive | - | - |
| "RESET_ARCH_ENTER_PAUSE"—disable playback pause when entering the archive. | - | - |
| "DISABLE_TELEMETRY"—disable telemetry control from Video surveillance monitor | - | - |
| "ENABLE_TELEMETRY"—enable telemetry control from Video surveillance monitor | - | - |
| "INCREASE_VIEW"—increase camera window size in the Video surveillance monitor | cam<> | Camera identifier |
| "DECREASE_VIEW"—decrease camera window size in the Video surveillance monitor | cam<> | Camera identifier |
| "SHOW_LAYOUT"—show layout with the specified ID | layout_id<> | Layout ID in database |
"GO_LIVE"—switch all cameras on the monitor to live video mode | - | - |
"GO_ARCH"—switch all cameras on the monitor to archive mode | arch_time<> | Optional parameter. Sets the time position in the archive in the DD-MM-YY HH:MM:SS format. By default, the archive is positioned on the last record |
| "SAVE_AS"—export selected archive fragment | - | - |
PLACE_CAM_IN_LAYOUT_CELL—add camera to the specific cell on the specific layout on the Monitor | cam<> | ID of a camera in the objects tree which must be displayed in the monitor. If the parameter value is incorrect, for example, 0 or -1, then the corresponding cell will be hidden |
| layout_name<> | ID or name of the layout to add camera on | |
| cell<> | The number of the cell on the layout to which the camera must be added. Cells are numbered from top to bottom left to right, starting from the top-left corner of the layout. Attention! Cells are numbered starting from 0. If some other camera has already been added to the specified cell, it will be replaced | |
| SET_TITLES—shows captions over a video image in any display mode. Such captions are not archived and are displayed until CLEAR_TITLES command is applied or Monitor is reset | cam<> | The ID of a camera to the Video surveillance window of which the command must be applied |
| titles<> | The caption text that must be displayed. Use '\r' to break the line | |
| title_id<> | Captioner ID | |
CLEAR_TITLES—disable the captions created with the help of the SET_TITLES command | cam<> | The ID of a camera to the Video surveillance window of which the command must be applied |
| title_id<> | Captioner ID |
Properties of the MONITOR object are displayed in the table.
Properties of the MONITOR object | Description of properties |
ID<> | Object ID |
PARENT_ID<> | Parent object ID |
Overview
Content Tools