CAM Camera

ARM

The camera is armed

If the operator armed the camera from the map or video surveillance monitor, the user_id<> parameter contains the identifier of the user who performed this action

ATTACH

Connecting

NA

BLINDING

The camera is blinded

NA

DETACH

Break

The event is generated when the input signal from the camera on the video capture device is lost

DISARM

The camera is disarmed

If the operator disarmed the camera from the map or video surveillance monitor, the user_id<> parameter contains the identifier of the user who performed this action

FILE_REC_ERROR

Writing to disk error

The event is generated when an error occurs when writing the video archive to disk

MD_START

Alarm

NA

MD_STOP

End of alarm

NA

PRINT

Print frame

NA

REC

Writing to disk

If the operator initiated the recording from the map or video surveillance monitor, the user_id<> parameter contains the identifier of the user who performed this action

REC_STOP

Stop writing to disk

If the operator stopped the recording from the map or video surveillance monitor, the user_id<> parameter contains the identifier of the user who performed this action

UNBLINDING

The camera is unblinded

NA

RECORDER_ON

Recording is on

NA

RECORDER_OFF

Recording is off

NA

DISC_MOUNT

The disk is mounted

NA

DISC_UNMOUNT

The disk is unmounted

NA

FINISHED_AVI_EXPORT

Video export is completed

If the video export fails, the event has a non-null error_result parameter.

In the param<0> parameter there is 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>

The event is generated when the number of objects detected by the tracker in the frame is exceeded (see Create and configure the Tracker object). An event is generated whenever the number of objects is changed (up or down), until it is less than the threshold.

The object_count<> parameter is the number of objects in the frame that the tracker detected, exceeds the specified limit, and differs from the previous value.

See also the description of the NEW_OBJECT event below

Among others, it contains the following parameters:

• total<> is the total number of objects in the frame at the time the event occurred
• new_id<> is the identifier of the detected object

Opening a file for playback by a virtual video capture device. Indicates that playback of the next file from the selected folder starts.

Among others, the event contains the following parameters:

• name<> is the name of the file being played back
• tss<> is the time in UTC format in milliseconds from 1/1/1970

Finishing a file playback by a virtual video capture device. Indicates that playback of a file has ended.

Among others, the event contains the following parameters:

• name<> is the name of the file that finished being played back
• tss<> is the time in UTC format in milliseconds from 1/1/1970

The event is displayed when a user protects the file from being overwritten.

The param<0> parameter contains additional information about the computer name, fragment, username, and user ID that is displayed in the Add. Info column in the event viewer in the following format:

"ComputerName;ProtectionPeriod;UserName;UserID", for example, param0<LOCALHOST;04-06-18 16:50:55.612_04-06-18 16:55:55.612;Smith;1>

The event is displayed when a user removes protection from the file from being overwritten.

The param<0> parameter contains additional information about the computer name, fragment, username, and user ID that is displayed in the Add. Info column in the event viewer in the following format:

"ComputerName;ProtectionPeriod;UserName;UserID", for example, param0<LOCALHOST;04-06-18 16:50:55.612_04-06-18 16:55:55.612;Smith;1>

The FRAME_SKIPPED event occurs in Axxon PSIM if there are frames skipped when recording to the archive. By default, the event is generated if there are more than 50 frame skips during the testing period. When frame skipping stops, the FRAME_SKIPPED_STOP event is generated. The description of this event contains information about the number of skipped frames and the time period in which there were skips. By default, both events are generated no more than once every 30 seconds.

The events are controlled by the following registry keys (see Registry keys reference guide):

• You can disable the FRAME_SKIPPED event using the FileSystem.NotifyCoreFrameSkipped registry key.

• The delay time between the state changes in seconds is specified in the FileSystem.RecordingStateChangeDelay key.
  The minimum value is 30 seconds. If you specify a smaller value, the minimum value of 30 seconds will still be used (the key in the registry will be overwritten).
  
• The number of skipped frames for the period, during which the FRAME_SKIPPED event will be generated, is specified in the FileSystem.MaxSkippedFramesByPeriod key

The event is displayed when a user adds a bookmark.

The param<0> parameter (in the Add. Info column in the event viewer) contains the comment to the bookmark

The event is displayed when a user deletes a bookmark

The event is displayed when the user deletes bookmarks within a specific time period.

All bookmarks whose time period overlaps the one specified in this command are also deleted

The param0<> parameter contains the temperature value received from the thermal camera

The event occurs in response to the GET_AVAILABILITY command and contains information about the number of objects added to the license key for the given position. Parameters:

• qty_localpriority<> is the number of allowed objects of the specified type on this computer (local key).
• qty<> is the total number of allowed objects of the specified type in the license (generic key).
• pos<> is the position number in the license key

If there is no position in the key, the event has a zero value

Contains mandatory parameter error_msg<>—error text; can also contain parameters cam<>—camera ID and error_code<>—error code. Example:

CAM|-1|FILESYSTEM_FAILED|error_msg<Failed to delete index file: D:\\VIDEO\\INDEX\\14061608.idx, error code: 5.>,error_code<5>

SETUP—sets (changes) the parameters of a camera

rec_priority<>

Record priority (from 0 to 3, 0—standard, 3—all resources)

compression<>

Compression ratio (0—no compression, 1—maximum quality, …, 5—minimum quality)

sat_u<>

Color saturation (0—min, 10—max)

proc_time<>

Additional recording period (0–30 sec)

manual<>

Control brightness and contrast settings (0—manual; 1—auto; 2—auto, but close to values specified manually)

contrast<>

Contrast (0—min, 10—max)

md_size<>

Size of motion detector objects (1–16)

md_mode<>

Mode of pause record (1—enabled, 0—disabled)

audio_type<>

Type of sound accompaniment

pre_rec_time<>

Time of pre-record  (0–20 sec)

bright<>

Brightness (0—min, 10—max)

audio_id<>

Number of a microphone (empty parameter if there is no microphone)

rec_time<>

Record speed (1–30 FPS, 0—not used)

alarm_rec<>

Recording of alarms (1—enabled, 0—disabled)

hot_rec_time<>

Time of hot record (0–30 sec)

hot_rec_period<>

Period of hot record (0–20 sec)

mux<>

Number of a channel (0–1 channel, 15–16 channel)

color<>

Color (0—black and white, 1—multicolor)

activity<>

NA

arch_days<>

Number of archive days

blinding<>

The camera is blinded

config_id<>

NA

decoder<>

NA

flags<>

Flags

fps<>

Speed of recording (0—not used, 1–30 FPS)

ifreq<>

Frequency of key frames in sequence (1—each frame is key, 2—100th frame)

mask 0, mask1, mask2, mask3, mask4

Detector mask

md_contrast<>

Sensitivity of motion detector (0–15)

motion<>

Estimation of compressor motion (5–255)

name<>

Object name

password_crc<>

Video archive password

priority<>

Priority of record resource (0—auto, 1—manual)

resolution<>

Resolution (0—standard CIF, 1—high 2CIF, 2—maximum 4CIF)

type<>

Type of object

yuv<>

Color scheme of video signal coding (0—YUV4:2:0, 1—YUV4:2:2)

DELETE—disables camera

NA

NA

START_VIDEO—enables video stream for the current camera

slave_id<>

Name of the computer to which the camera is connected

comress<>

Level of compression

register_only<>

NA

STOP_VIDEO—disables video stream for the current camera

slave_id<>

Name of computer to which camera is connected

REQUEST_MASK

mask<>

Mask

MUX1, MUX2, MUX3—display the image of a camera on 1, 2, 3 analog outputs

NA

NA

ACTIVATE—display camera on monitor

monitor<>

Number of a monitor

ARM—arm camera

NA

NA

DISARM—disarm camera

NA

NA

REC—start recording

time<>

Time of recording in seconds, if null, then only one frame is recorded

rollback<>

If 1, the record is performed with a rollback

priority<>

Sets priority of command to start recording. See Appendix 1. Priorities of the start and stop recording commands

Sets an identification number of a stream for recording. The stream ID is set as "n.m" where n is the camera ID, m is the number of the stream.

Note. If the specified stream isn't used for any purpose other than recording by command (and custom on clients), make sure that the Lock disabling streams not in use checkbox is set for it—see The settings panel of the Camera object

REC_STOP—stop recording

priority<>

Sets priority of a command to stop recording. See Appendix 1. Priorities of the start and stop recording commands

SET_MASK—set mask

mask<>

Mask

ADD_SUBTITLES—add titles

command<>

Test of the titles

title_id<>

The ID of the Captioner object that is used to add the titles

page<>

Required parameter to allow recording titles to the titles database to provide search by titles. Available values: BEGIN (start of recording in the database), END (end of recording in the database)

SIP_CONNECT—SIP connected

NA

NA

SIP_DISCONNECT—SIP disconnected

NA

NA

SET_IPINT_PARAM—set (change) the parameters of an IP device. Reaction allows changing the IP device settings without going into its web interface.

Note. For the reaction to work, it is required to enable the mode of multi-stream video signal—see Configuring the multistream video and Appendix 2. Defining the param_id and param_value values for the SET_IPINT_PARAM reaction

param_id<>

Name of a parameter. Set of parameters for each camera is individual—see Appendix 2. Defining the param_id and param_value values for the SET_IPINT_PARAM reaction

param_value<>

Value of a parameter. Set of parameters for each camera is individual—see Appendix 2. Defining the param_id and param_value values for the SET_IPINT_PARAM reaction

vstream_id<>

Number of a video stream (optional parameter). It has the format “Number of camera”.”Number of a stream”, for example 1.1, 1.2

GET_FRAME—get frame from a camera even if it is not displayed in the video surveillance monitor

path<>

Path to save a frame. If there is no parameter, the FRAME_SENT event with the data parameter will be formed in the system. Processing of this event is described in The SaveToFile method

Optional parameter. Sets Axxon PSIM stream to get a frame from. The stream can be specified by a number or purpose. Possible purposes:

• stream_archive—stream for archive recording
• stream_alarm—stream for archive recording by alarms
• stream_client—stream for display
• stream_analytic—stream for video analytics

Stream number consists of a camera ID and a stream ID divided by a dot, for example, 4.3 is for stream 3 from camera 4

Optional parameter. Specifies the network name of the videogate from whose archive the frame must be retrieved.

IDs of the computer and video surveillance monitor using which the bookmark is created. Parameter format: <computer id>.<monitor id>.

For example, slave_id<WS2.1>—WS2 is a computer ID, and 1 is video surveillance monitor ID

Executed action:

• CRUISE_START—start cruising along the specified route
• PATROL_PLAY—start patrolling along the specified route

Disk or network path to request the archive depth.

The disk name is set in the "<disk letter>:\\" format, for example drive<D:\\>

Note. The "\" character is an escape character.

The network path is set in the UNC format

Get the backup archive depth.

Example.

DoReactStr("CAM","2","GET_DEPTH","drive<D:\\>,cam<2>,arch");

Get the videogate archive depth.

Example.

DoReactStr("CAM","1","GET_DEPTH","drive<V:\\>,gate");