DISK_FILE_LIST

 

Description

Get the recorded file listing form the device. The recorded file will NOT send to the remote host by this URL.
User could get the interested files form the device based on the file listing then.

When device received this URL command, it searches the files in its local storage media based on the search conditions. It might take long time for search. Therefore, this URL must be the single URL command. The commands after DISK_FILE_LIST will be ignored (no corresponding return message as well).

Input Argument

None or ALL
When the input argument is NONE, the device will list files to remote host based on the file search conditions defined by DISK_FILE_SEARCH_TIME and DISK_FILE_SEARCH_EVENT.
When the input argument is ALL, the device will list all files in the local storage media no matter the file searching conditions are.

Attribute

Return of Message

The return message is in the XML format. Here is the format definition.

<XML>
  <LOCAL_FILES>
  <FILE StartTime="YYYYMMDD-hh:mm:ss" Duration="xxx" TriggerBy="" Size="KB or B">FileName</FILE>
<FILE StartTime="YYYYMMDD-hh:mm:ss" Duration="xxx" TriggerBy="" Size="KB or B">FileName</FILE>
....
  </LOCAL_FILES>
</XML>
     
where the attributes in this XML message are described below.
Attribute Possible Value Description
StartTime YYYYMMDD-hh:mm:ss YYYY: 4 digits for year, for example, 2011.
MM: 2 digits for month. 01 is for January and 12 is for December.
DD: 2 digits for month day. 01 is the first day in a month.
hh: 2 digits for hour started from 00 to 23.
mm: 2 digits for minute.
ss: 2 digits for second.
Duration 0~ The recorded duration in seconds of the file. For snapshot image file, the duration should be 0.
TriggerBy DI1,DI2,MD1,MD2,MD3,PIR,SCH,READY The recording event type. It should be have one event type in this attribute.
DI1 and DI2 are DI events.
MD1, MD2, MD3 and PIR are motion events
SCH: is the scheduler event
READY: is the continuous recording event.
Size 1B ~ the file size in the recorded file. If the file size is smaller than 1KB (1000 Bytes), it uses B as the unit. Otherwise, KB is used.
FileName file name is defined by the event rule Because the record path is fixed, the file path is no need here.

Example

<XML>
  <LOCAL_FILES>
  <FILE StartTime="20110917-12:45:40" Duration="10" TriggerBy="MD1" Size="30000KB">video-20110917-124540-MD1-01.raw</FILE>
<FILE StartTime="20110917-12:45:45" Duration="0" TriggerBy="PIR" Size="500B">snapshot-20110917-124545-PIR-00.jpg</FILE>
<FILE StartTime="20110917-12:45:45" Duration="0" TriggerBy="PIR" Size="576B">snapshot-20110917-124545-PIR-01.jpg</FILE>
  </LOCAL_FILES>
</XML>
     

Applicability

Platform Devices Supported Firmware Version
PlatformT Camera, Video server with local storage A1D-310-V4.11 and later

Statue

Valid

See also

DISK_REMOVE_FILE, DISK_REMOVE_OLD_FILES, DISK_GET_FILE, DISK_FILE_SEARCH_TIME, DISK_FILE_SEARCH_EVENT

Example

http://ip:port/cgi-bin/system?USER=admin&PWD=123456&DISK_FILE_LIST
or
http://ip:port/cgi-bin/cmd/system?DISK_FILE_LIST

Back To

HOME, SYSTEM CGI