VIVOTEK
User's Manual - 371
© 2022 VIVOTEK INC. All Right Reserved
232
PARAMETER
VALUE
DESCRIPTION
resolution
<text>
Optional.
Indicate the media file resolution.
Please embrace your input value with single quotes.
Ex. resolution=’800x600’
isLocked
<boolean>
Optional.
Indicate if the file is locked or not.
0: file is not locked.
1: file is locked.
A locked file would not be removed from UI or cyclic
storage.
triggerTime
<text>
Optional.
Indicate the event trigger time. (not the file created
time)
Format is “YYYY-MM-DD HH:MM:SS”
Please embrace your input value with single quotes.
Ex. triggerTime=’2008-01-01 00:00:00’
If you want to search for a time period, please apply
“TO” operation.
Ex. triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01
23:59:59’ is to search for records from the start of Jan 1
st
2008 to the end of Jan 1
st
2008.
limit
<positive integer>
Optional.
Limit the maximum number of returned search records.
offset
<positive integer>
Optional.
Specifies how many rows to skip at the beginning of the
matched records.
Note that the offset keyword is used after limit keyword.
To increase the flexibility of search command, you may use “OR” connectors for logical “OR” search
operations. Moreover, to search for a specific time period, you can use “TO” connector.
Ex. To search records triggered by motion or di or sequential and also triggered between 2008-01-
01 00:00:00 and 2008-01-01 23:59:59.
http://<
servername
>/cgi-
bin/admin/lsctrl.cgi?cmd=search&triggerType=’OR+’di’+OR+’seq’&triggerTime=’2008-01-
01 00:00:00’+TO+’2008-01-01 23:59:59’
Command: queryStatus
PARAMETER
VALUE
DESCRIPTION
retType
xml or javascript
Optional.
Ex. retype=javascript
The default return message is in XML format.
Ex. Query local storage status and call for javascript format return message.
© 2022 VIVOTEK INC. All Right Reserved
233
http://<
servername
>/cgi-bin/admin/lsctrl.cgi?cmd=queryStatus&retType=javascript
There are two cgi commands for download and composing jpegs to avi format.
For download single selected file, you can use “/cgi-bin/admin/
downloadMedias.cgi
”. Just assign
the request file path to this cgi.
Syntax:
http://<
servername
>/cgi-bin/admin/
downloadMedias.cgi?<File_Path>
The
<File_Path>
is in queryststus return message.
Ex.
http://
<
servername
>
/cgi-
bin/admin/
downloadMedias.cgi
?/mnt/auto/CF/NCMF/20090310/07/02.mp4
Syntax:
http://<
servername
>/cgi-bin/admin/
downloadMedias.cgi?type=<type>
[&<parameter>=<value>…
]
PARAMETER
VALUE
DESCRIPTION
type
<text>
Required
command to be excuted include
videoclip
device
<text>
command to be excuted include
sd, nas
recordingtoken
<text>
Please refer to Edge Storage API
starttime
<text>
Optional.
Format is “YYYY-MM-DD HH:MM:SS”
Please embrace your input value with single quotes.
Example:
starttime=2008-01-01 00:00:00
Notice: you should use UTC time
endtime
<text>
Optional.
Format is “YYYY-MM-DD HH:MM:SS”
Please embrace your input value with single quotes.
Example:
starttime = 2008-01-01 00:00:00
Notice: you should use UTC time
For creating an AVI file by giving a list of JPEG files, you can use “/cgi-bin/admin/
jpegtoavi.cgi
”.
Syntax:
http://<
servername
>/cgi-
bin/admin/jpegtoavi.cgi?
<resolution>=<width>x<height>&<fps>=<num>&<list>=<fileList>
