Go to documentation repository
The data source for loading video clips is the .xml text file. The uniqueness of the name of this file is provided by the third party system that forms this file.
The request file includes the following parameters:
Name | Description |
ID | Partition Of Control object identification number. |
DateTimeBegin | Date and time of recording start and search by titles start in the following format: DD-MM-YYYY hh:mm:ss |
DateTimeEnd | Date and time of search by titles end in the following format: DD-MM-YYYY hh:mm:ss Note. To be used if the Titles parameter is not set to 0 |
Length | The length of the requested video clip. Possible values: 1-9999 |
DateTimeExecute | Date and time to execute the request of the video clip in the following format: DD-MM-YYYY hh:mm:ss Note. If 0 is set for this parameter, the request is executed immediately. |
Cam | Camera sequence number from top to bottom. The need to use the camera sequence number rather than the internal number is due to the fact that the internal camera number is not transmitted from older system versions. Example. There are 3 cameras on the Agent of Control:
The cameras are added to the Partition Of Control in the following order:
Cameras are displayed on Server of Control in the corresponding order. Thus, to get a video from the camera "Arch", the parameter Cam should be equal to 2. Note. If you specify 0, the video clips are downloaded from all object video cameras added while setting the Agent of Control. |
Titles | A string to search by titles. The string should not be longer than 40 characters. Use * to search for any number of characters, for example:
Note 1. If you specify a value of 0, no titles will be searched. Also, in this case, the parameters OnlyWithTitles and DateTimeEnd are shall not be used. Note 2. If you specify an empty string, the search will be performed by any titles. Note 3. To use the characters in the search string as characters only, not as markup, use the CDATA section. |
OnlyWithTitles | Download video clip if titles found only. Possible values: 0 — video clip is downloaded 1 — video clip is not downloaded |
DownloadSpeed | Download speed of the video in KB / sec. Possible values: 0-1000 Note. If you specify a value of 0, then the download speed is not limited. |
See the example of the file on the picture below.