Go to documentation repository
Page History
...
Command – command description | Parameters | Description of parameters |
"SETUP" – sets (changes) parameters of camera | rec_priority<> | Record priority (from 0 to 3, 0 – standard, 3 – all recources). |
compression<> | Compression ration (0 – no compression, 1- maximal quility, …, 5 – minimal quality). | |
sat_u<> | Value of colour (0 – min, 10 – max). | |
proc_time<> | Append 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 detection 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 microphone (empty parameter if there is no microphone). | |
rec_time<> | Record speed (1 – 30 fps, 0 – not used). | |
alarm_rec<> | Record of alarms (1 – enabled, 0 – disabled). | |
hot_rec_time<> | Time of hot record (0 – 30 sec). | |
hot_rec_period<> | Period of hot (0 – 20 sec). | |
mux<> | Number of channel (0 – 1 channel, 15 – 16 channel). | |
color<> | Colour (0 – black and white, 1 – multicolor). | |
activity<> | - | |
arch_days<> | Number of archive days. | |
blinding<> | Camera is sealed. | |
config_id<> | - | |
decoder<> | - | |
flags<> | Flags. | |
fps<> | Speed of record (0 – not used, 1 – 30 fps). | |
ifreq<> | Frequency of anchor frames in sequence (1 – each frame is anchor, 2 – 100 frame). | |
mask 0, mask1, mask2, mask3, mask4 | Detection mask. | |
md_contrast<> | Sensibility of motion detection (0 – 15). | |
motion<> | Estimation of motion compressor (5 - 255). | |
name<> | Name of object. | |
password_crc<> | Password for video archive. | |
priority<> | Priority of record resource (0 – auto, 1 – manual). | |
resolution<> | Resolution (0 – standard CIF, 1 - high 2CIF, 2 –maximal 4CIF). | |
type<> | Type of object. | |
yuv<> | Colour schema of video signal coding (0 – YUV4:2:0, 1 - YUV4:2:2). | |
"DELETE" – disables camera. | - | - |
"START_VIDEO" – enables video stream for current camera. | slave_id<> | Name of computer to which camera is connected. |
comress<> | Value of compression. | |
register_only<> | - | |
"STOP_VIDEO" – disables video flow stream for current camera. | slave_id<> | Name of computer to which camera is connected. |
"REQUEST_MASK" | mask<> | Mask. |
"MUX1", "MUX2", "MUX3" – display image of camera on 1, 2, 3 analog outputs. | - | - |
"ACTIVATE" – display camera on monitor. | monitor<> | Number of monitor. |
"ARM" – arm camera. | - | - |
"DISARM" – disarm camera. | - | - |
"REC" – start record from camera. | time<> | Time of record in seconds, if null than only one frame is recorded. |
rollback<> | If one, than record is performed with rollback. | |
priority<> | Set priority of command to start record. See Appendix 1. Priorities of start and stop recording commands | |
stream_id<> | Set an identification number of stream for record. Stream ID is set as "n.m" where n is the Camera object ID, m is the number of the stream. Note. If the specified stream is not in use 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 checked for it – see the The Settings panel of the Camera object section of the Administrator's Guide. | |
"REC_STOP" – stop record from camera. | priority<> | Set priority of command to stop record. See Appendix 1. Priorities of start and stop recording commands |
"SET_MASK" – set mask. | mask<> | Mask. |
"ADD_SUBTITLES" – add titles. | command<> | Test of imposed titles. |
title_id<> | ID of Captioner object which is used to impose. | |
page<> | Parameter allows record titles to the titles database to provide search by titles. Available values: BEGIN (start of record in database), END (end of record in database). | |
"SIP_CONNECT" - Sip connected | - | - |
"SIP_DISCONNECT" – Sip disconnected | - | - |
"SET_IPINT_PARAM" – Set (change) parameters of IP-device. Reaction allows changing of IP-device settings not entering its web-interface. Note. For reaction operation it is required to enable the mode of multi-flow video signal - see. Administrator's Guide, sectionConfiguration of multistream video, andAppendix 2. Defining param_id and param_value values for SET_IPINT_PARAM reaction | param_id<> | Name of parameter. Set of parameters for each camera is individual - see Appendix 2. Defining param_id and param_value values for SET_IPINT_PARAM reaction |
param_value<> | Value of parameter. Set of parameters for each camera is individual - see Appendix 2. Defining param_id and param_value values for SET_IPINT_PARAM reaction | |
vstream_id<> | Number of video flow (optional parameter). Is given by “Number of camera”.”Number of flow”, for example 1.1, 1.2. | |
GET_FRAME – get frame from camera even if it is not displayed in the Video surveillance monitor. | path<> | Path to save frame. If there is no parameter than the FRAME_SENT event with the data parameter will be formed in the system. Processing of this event is described in the section The SaveToFile method of the Programming Guide (JScript). |
ARCH_DEL_RECORD – delete archive recordings over the specified period. | fromTime<> | Mandatory parameter. Time in the YYYY-MM-DDTHH: MM: SS.NNN format, where NNN - milliseconds. 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 NNN - milliseconds. See description above. | |
REC_RESTART – restart recording. | - | - |
ARCH_BOOKMARK_RECORD – create a bookmark. | time1<> | 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 – the bookmark is created using them. Parameter format: <computer id >.<monitor id>. For example, slave_id<WS2.1> –WS2 is computer ID and 1 is Video surveillance monitor ID. | |
CRUISE_START – Auto cruise | cruise_id<> | Route name on camera |
action<> | Executed action: CRUISE_START – start cruising along the specified route. PATROL_PLAY – start patrolling along the specified route. | |
cam_id<> | Camera ID |
Properties of the CAM object are shown in the table.
"GET_DEPTH" – get 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 parameters. | drive<> | 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 video gate archive. Example. DoReactStr("CAM","1","GET_DEPTH","drive<V:\\>,gate"); |
Properties of the CAM object are shown in the table.
Properties of the CAMobject | Description of | Properties of the CAMobject | Description of properties |
ID<> | Object ID. | ||
PARENT_ID<> | Parent object ID. | ||
TELEMETRY_ID<> | Telemetry module ID (ID of ptz) | ||
REGION_ID<> | Region ID |
...
Switch camera to the colored mode and start record recording from it while arming the first camera.
Code Block OnEvent("CAM","1","ARM") //first video camera is armed { DoReact("CAM","1","SETUP","color<1>"); // set colored mode of video camera DoReact("CAM","1","REC"); //record from the first camera }
Arm the first video camera while disabling the fifth video camera.
Code Block OnEvent("CAM","5","DETACH") // fifth video camera is disabled { DoReact("CAM","1","ARM"); //first video camera is armed }
Use half of resources while recording from the first camera (i.e. if 4 video cameras are connected through the first video capture device than the first camera will record with speed 6 fps, and other three cameras – with speed 2-2,5 fps) if it is in alarm state.
Code Block OnEvent("CAM","1","MD_START") //first video camera is in alarm state { DoReact("CAM","1","SETUP","rec_priority<2>"); // use half of resources while recording }
Set maximal compression synchronously with the fourth microphone of audio card on the first video camera while recording from the first video camera on disk.
Code Block OnEvent("CAM","1","REC") //first video camera recording on disk { DoReact("CAM","1", "SETUP", "compression<5>, audio_type<OLXA_LINE>, audio_id<4>"); //first video camera, maximal compression, synchronously with forth microphone of audio card.
Start record recording from the first camera with minimal quality in black and white mode when it stopped to be in alarm.
Code Block OnEvent("CAM","1","MD_STOP") // first camera stopped to be in alarm state { value = 5; DoReact("CAM", "1", "SETUP", "compression<" + value + ">,color<0>"); //start record from the first video camera with minimal quality in black and white mode. }
Start record recording from the first camera in the “rollback” mode when it disarmed.
Code Block OnEvent("CAM","1","DISARM") //first video camera is disarmed { DoReact("CAM","1","REC","rollback<1>"); // Start record from the first video camera in the "rollback" mode }
Set new parameters of video signal while connecting the first video camera.
Code Block OnEvent("CAM","1","ATTACH") //first video camera is connected { VIDEO_CANAL_ID = GETOBJECTPARAM("CAM","1","PARENT_ID"); // define ID of video channel to which the first camera belongs DoReact("GRABBER",VIDEO_CANAL_ID,"SETUP","chan<0>,mode<0>,resolution<1>,format<pal>"); //set new parameters of video channel. }
Start autopanning auto cruising on Camera 1 when Macro 2 is run.
Code Block OnEvent ("MACRO","2","RUN") { DoReact("CAM","1","CRUISE_START","cruise_id<1>,action<CRUISE_START>,cam_id<1>"); }
...