Versions Compared

Key

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

...

The CAM object sends the events given in the table. The procedure Procedure is started when the corresponding event occurs.

...

The list of commands and parameters for the CAM object is given in the following table:

Commandcommand description

Parameters

Description of parameters

SETUPsets (changes) the parameters of a camera

rec_priority<>

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

compression<>

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

sat_u<>

Value of color (0min, 10max)

proc_time<>

Append period (0–30 sec)

manual<>

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

contrast<>

Contrast (0min, 10max)

md_size<>

Size of motion detection objects (1–16)

md_mode<>

Mode of pause record (1enabled, 0disabled)

audio_type<>

Type of sound accompaniment

pre_rec_time<>

Time of pre-record  (0–20 sec)

bright<>

Brightness (0min, 10max)

audio_id<>

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

rec_time<>

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

alarm_rec<>

Record of alarms (1enabled, 0disabled)

hot_rec_time<>

Time of hot record (0–30 sec)

hot_rec_period<>

Period of hot record (0–20 sec)

mux<>

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

color<>

Color (0black and white, 1multicolor)

activity<>

-

arch_days<>

Number of archive days

blinding<>

Camera is sealed

config_id<>

-

decoder<>

-

flags<>

Flags

fps<>

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

ifreq<>

Frequency of key frames in sequence (1each frame is key, 2100th frame)

mask 0, mask1, mask2, mask3, mask4

Detection tool mask

md_contrast<>

Sensitivity of motion detection tool (0–15)

motion<>

Estimation of compressor motion (5–255)

name<>

Object name

password_crc<>

Video archive password

priority<>

Priority of record resource (0auto, 1manual)

resolution<>

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

type<>

Type of object

yuv<>

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

DELETEdisables camera

-

-

START_VIDEOenables video stream for the current camera

slave_id<>

Name of the computer to which the camera is connected

comress<>

Level of compression

register_only<>

-

STOP_VIDEOdisables video stream for the current camera

slave_id<>

Name of computer to which camera is connected

REQUEST_MASK

mask<>

Mask

MUX1, MUX2, MUX3display the image of a camera on 1, 2, 3 analog outputs

-

-

ACTIVATEdisplay camera on monitor

monitor<>

Number of a monitor

ARMarm camera

-

-

DISARMdisarm camera

-

-

RECstart recording from a camera

time<>

Time of record in seconds, if null than 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 start and stop recording commands

stream_id<>

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 record by command (and custom on clients), make sure that the Lock disabling streams not in use checkbox is set for itsee The Settings panel of the Camera object

REC_STOPstop recording from a camera

priority<>

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

user_id<>If recording was stopped by a user from the Video surveillance monitor, the parameter contains the user ID. Otherwise the parameter is absent
from_macro<>If recording was stopped by a macro, the parameter contains the macro ID. Otherwise the parameter is absent

SET_MASKset mask

mask<>

Mask

ADD_SUBTITLESadd titles

command<>

Test of imposed titles

title_id<>

The ID of the Captioner object which is used to impose

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_CONNECTSip connected

-

-

SIP_DISCONNECTSip disconnected

-

-

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

Note. For reaction operation it is required to enable the mode of multi-flow video signalsee Configuration of multistream video and Appendix 2. Defining param_id and param_value values for SET_IPINT_PARAM reaction

param_id<>

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

param_value<>

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

vstream_id<>

Number of a video stream (optional parameter). It is given by “Number of camera”.”Number of a stream”, for example 1.1, 1.2

GET_FRAMEget 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 of the The Script object. Programming using the JScript language

stream<>

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

  • stream_archivestream for archive recording
  • stream_alarmstream for archive recording by alarms
  • stream_clientstream for displaying
  • stream_analyticstream for video analytics

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

time<>Optional parameter. It is set to request video frame from the archive. Format: DD-MM-YYYY hh:mm:ss. Example: time<19-09-2017 11:35:34>
gate<>Optional parameter. Specifies the network name of the Videogate from the archive of which to get the frame
arch<>Optional parameter. Specifies the network name of the Backup archive to get the frame from
slave_id<>Optional parameter. Specifies the network name of the Server to get the frame from
password_crc<>Optional parameter. Specifies the CRC sequence to be recorded to the file together with the frame
ARCH_DEL_RECORDdelete archive recordings over the specified period.fromTime<>Mandatory parameter. Time in the YYYY-MM-DDTHH: MM: SS.NNN format, where NNNmilliseconds. The recordings will be deleted (starting with the first one containing the specified time and ending with the last one containing the toTime time). If no time is specified in the toTime parameter, then only one recording will be deleted
toTime<>Optional parameter. Time in the YYYY-MM-DDTHH: MM: SS.NNN format, where NNNmilliseconds. See description above
REC_RESTARTrestart recording--
ARCH_BOOKMARK_RECORDcreate a bookmarktime1<>The date of the archive period beginning included in the bookmark in the DD-MM-YY HH: MM: SS.NNN format, where NNN - milliseconds
time2<>The date of the archive period ending included in the bookmark in the DD-MM-YY HH: MM: SS.NNN format, where NNN milliseconds
comment<>Comment to a bookmark
slave_id<>

Computer and Video surveillance monitor IDs using which the bookmark will be 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

CRUISE_STARTauto cruisecruise_id<>Route name on a camera

action<>

Executed action:

  • CRUISE_STARTstart cruising along the specified route
  • PATROL_PLAYstart patrolling along the specified route

cam_id<>Camera ID
GET_DEPTHget the archive depth. The ARCHIVE_DEPTH event from the SLAVE object (see SLAVE) is created in the system as the response to this reaction. If one or both parameters are absent it means that there is the archive depth request for all possible parametersdrive<>

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


arch

Get the backup archive depth.

Example.

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

gate

Get the videogate archive depth.

Example.

DoReactStr("CAM","1","GET_DEPTH","drive<V:\\>,gate");
CLEAR_SUBTITLES—remove all titles from the video imagetitle_id<>The ID of the Captioner object
GET_AVAILABILITY—check the availability of the key positionpos<>The position number in the license key

Properties of the CAM object are shown in the table.

...