Versions Compared

Old Version 3

changes.mady.by.user Yulia Morozova

Saved on

compared with

New Version Current

changes.mady.by.user Gleb Matskevich

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The MONITOR object sends events presented in the table.   Procedure is started when the corresponding event appears.

Format of event procedure for the Monitor object:

...

occurs.

List of commands and parameters for the MONITOR object is presented in the following table:

EventDescriptionComment
STARTED_AVI_EXPORTVideo export started

Among others, the event has the following parameters:

SLAVE
  • slave_id<>
–
  • —operator who started the export
.
param1<> –
  • param1<>—number of camera on which the export is performed, date and time of export period beginning. The parameter value is like "<RecNo.> Camera <id> (dd-mm-yy hh:mm:ss)", for example param1<01 Camera 1 (05-10-17 10:23:21)>
.
time<> –
  • time<>—time when export started
.

FINISHED_AVI_EXPORT

Video export finished

Among others, the event has the following parameters:

SLAVE
  • slave_id<>
–
  • —operator who started the export
.
param1<> –
  • param1<>—number of camera on which the export is performed, date and time of export period ending. The parameter value is like "<RecNo.> Camera <id> (dd-mm-yy hh:mm:ss)", for example param1<01 Camera 1 (05-10-17 10:23:21)>
.
time<> –
  • time<>—time when export ended
.
  • param<0>
–
  • —additional information displayed in the corresponding column of the Event Viewer, in the following format: "ComputerName;ExportPeriod;UserName;UserID", for example, param0<LOCALHOST;04-06-18 16:50:55_04-06-18 16:55:55;Smith;1>
AVI_EXPORT_RESULTVideo export resultThe event has the same parameters as START_AVI_EXPORT with additional error_result<> having one of the following values:

0

-

—export successful
1

-

—unknown
2

-

—busy
3

-

—not ready
4

-

—invalid interval
5

-

—file error

PLAY_START
-
Start the archive fragment playback-
PLAY_STOP
-
Stop the archive fragment playback-
INTERFACE_MANIPULATIONVisualization changeparam<0>
– additional
—additional information displayed in the corresponding column of the Event Viewer, contains the identifier of the camera that was moved around the layout
.

LAYOUT_DELDeleting layoutparam<0>
– additional
—additional information displayed in the corresponding column of the Event Viewer, contains the name of the deleted layout
.
LAYOUT_ADDAdding layoutparam<0>
–
—additional information displayed in the corresponding column of the Event Viewer, contains the name of the added layout
.

LAYOUT_ACTIVATEChanging active layoutparam<0>
– additional
—additional information displayed in the corresponding column of the Event Viewer, contains the name of the activated layout
.

REPLACE_CAMChanging 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_CAMCamera 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_EXPANDThe Video Surveillance Window expanded to the entire Monitor

The event is generated if the following registry keys are set (

see

see Registry keys reference guide):

  • MaximizeCameraOnDblClk=1
  • MinimizeCameraOnDblClk=1

Event parameters:

  • param0<>
–
  • —camera ID
.
  • user_id<>
–
  • —the ID of the user who performed the action
CAM_COLLAPSEThe Video Surveillance Window collapsed back

The event is generated if the following registry keys are set (

see

see Registry keys reference guide):

  • MaximizeCameraOnDblClk=1
  • MinimizeCameraOnDblClk=1

Event parameters:

  • param0<>
–
  • —camera ID
.
  • user_id<>
–
  • —the ID of the user who performed the action

Operator format to describe actions with the monitor is:

Code Block
DoReact("MONITOR","_id_","_command_"[,"_parameters_"]);

List of commands and parameters for the 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

is to be 

must be removed from monitor

.

show<>

Optional parameter. Possible values:

0 –
  • 0—do not update the layout in the Monitor after removing the camera. There may be empty space not occupied by Video surveillance windows
.
1 –
  • 1—update the layout in the Monitor after removing the camera to minimize empty space
.

"REMOVE_ALL"

–

—removes all cameras from monitor

.

-

-

"STOP_VIDEO"

–

—stops video

flow

stream of camera

.

cam<>

ID of a camera in the settings tree, the video

flow

stream from which

is to

must be stopped

.

"REPLACE"

–

—removes all cameras from monitor and triggers the specified camera

.

SLAVE

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

is to

must be displayed in the monitor

.

name<>

Name of a camera which

is to

will be displayed in

the 

the bottom-left corner

.

audio_type<>

-

audio_id<>

-

arch_id<>

-

control<>

0—only archive viewing,

1

–

—it is also possible to control (

arming

arm/

disarming

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

is to

must be displayed in the monitor

.

name<>

Object name which

is to

will be displayed in the bottom-left corner

.

arch_id<>

-

control<>

0—only archive viewing,

1

–

—it is also possible to control (

arming

arm/

disarming

disarm, record)

.

gate_id<>ID of the
video gate
videogate through which you want to receive video
through
.The corresponding camera must be added and configured in this
video gate - see
videogate—see Selecting and configuring the cameras for the Videogate module
SLAVE
slave_id<>ID of
the
a computer to which the command is applied
.

"ACTIVATE_CAM" – activates camera.

cam<>

ID of camera in the settings tree which is to be activated.

"ARCH_FRAME_TIME" – search of
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:

  • 0
– Video Gate
  • —videogate, if it is set (if not set, then the archive of the
Video Server
  • video server is searched)
  • 1
– Video Server
  • —video server
  • 2
– Backup
  • —backup archive
  • 10 + Object ID External storage in the Monitor object settings panel (normally 11)
–
  • —external storage
.

"SETUP"

–

—sets parameters of monitor

.

no_update<>

-

overlay<>

Disable the mode of speed-up displaying

.

x<>

Coordinate of top-left corner (

0 – 100

0–100)

.

y<>

Coordinate of top-left corner (

0 – 100

0–100)

.

w<>

Size in horizontal direction (

0 – 100

0–100)

.

h<>

Size in vertical direction (

0 – 100

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

while

when auto scrolling (

1 – 20

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

an auto select

automatic selection of video stream for

displaying

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
identifier
ID of the camera to the Video surveillance window of which the command
is to
must be applied. If the identifier is not specified, the command is applied to the active Video surveillance window (
see
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

back of

video surveillance windows back;

"CYCLE_FF"

–

—scrolling

straight of

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

wind

;

"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 function of slide show

—enable automatic forward scrolling of video surveillance windows

frontwards

. Period of

switching

scrolling video images is specified

while

when configuring the Monitor interface object (

see the Administrator’s Guide, 

see Configuring the display mode

for

of camera

boxes section

windows)

.

;

"STOP_CYCLE"

–

—stop

of

slide show of Video surveillance windows

.

;

"EXPORT_DO"

–

—open the

AxiExport

AviExport tool for

backgroung

background export (

see

see The AviExport utility)

.

;

"PROTECT_DO"

–

—open the dialog box to create a bookmark (

see

see Create a bookmark)

.

;

"PROTECT_VIEW"

–

—show the bookmark list (

see

see List of bookmarks)

.

"START_AVI_EXPORT"

– starts

—starts video export

Note. See the

example as follows.

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"
– start
—starts bookmarks export--
"STOP_AVI_SCHEDULE"
– stop
—stops bookmarks export--

"CONTROL_TELEMETRY"

 –

—Telemetry control.

See
See Mouse PTZ control
section in Operator's Guide.
cam<>ID of
camera where
a camera on which you want to enable or disable the mouse PTZ control
is to be enabled or disabled.
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 monitorcam<>Camera identifier
.
"DECREASE_VIEW"
–
—decrease camera window size in the Video surveillance monitorcam<>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

format

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 –

CELL—add camera to the specific cell on the specific layout on the Monitor





cam<>ID of a camera in the
object
objects tree which
is to
must be displayed in the monitor.
 If
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

should

must be added. Cells are numbered from top to bottom left to right, starting from the top-left corner of the layout.

Important

Attention! Cells are numbered starting from 0.

If some other camera has already been added to the specified cell, it will be replaced

.

Properties of the MONITOR object are shown in the table.

...

Properties of the MONITOR object

...

Description of properties

...

ID<>

...

Object ID.

...

PARENT_ID<>

...

Parent object ID.

Examples of using events and reactions of the Monitor object:

Play record from video camera 1 on the monitor 4 with specified date and time while the first macro starting.

Code Block
OnEvent("MACRO","1","RUN")
{
 DoReact("MONITOR","4","ARCH_FRAME_TIME","cam<1>,date<"+date+">,time<11:00:00>");
 DoReact("MONITOR","4","KEY_PRESSED","key<PLAY>");
}

Switch to the mode of video archive viewing on the first video camera of monitor 4 while printing the frame from the first camera and then go on 10 frames further starting from the specified date and time.

Code Block
OnEvent("CAM", "1", "PRINT")
{
 DoReact("MONITOR","4","ARCH_FRAME_TIME","cam<1>,date<"+date+">,time <11:00:00>");
 for(i=0;i<10;i=i+1)
 {
  DoReact ("MONITOR","4","KEY_PRESSED","key<FF>");
 }
}

Zoom in the video image on the monitor screen if video camera is in alarm state and reset it when alarm will be finished.

Code Block
OnEvent("CAM","1","MD_START")
{
 DoReact("MONITOR","1","KEY_PRESSED","key<ZOOM_IN>");
}
 
OnEvent("CAM", "1", "MD_STOP");
{
 DoReact("MONITOR","1","KEY_PRESSED","key<ZOOM_OUT>");
}

Enter the layout number one on the monitor screen while triggering macro.

Code Block
OnEvent("MACRO","1","RUN")
{
 DoReact("MONITOR","1","KEY_PRESSED","key<SELECT_LAYOUT>,number<1>");
}

...

Script (start by Macro 1)

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 resetcam<>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

Code Block
OnEvent("MACRO","1","RUN")
{
 DoReact("CORE","","DO_REACT","source_type<MONITOR>,source_id<1>,action<START_AVI_EXPORT>,params<4>,param0_name<avi_path>,param0_val<c:\aaa.avi>,param1_name<cam>,param1_val<1>,param2_name<finish>,param2_val<24-10-14
 17:10:50>,param3_name<start>,param3_val<24-10-14 17:10:38");
}

When macro 1 is run enable mouse PTZ control on Camera 4 at Monitor 10. Disable it on Macro 2.

...