getClips

Obtains a list of all created or pending clips. See addClip for the usage of the all the clip methods.

Note: This function requires VDG Sense version 2.5.4 or higher

Request

command=getClips&serverID=[UID]
Parameter type remarks
serverID [UID] unique server id (Optional)

Response

<result errorcode="0">
  <clips count="[number]">
    <clip>
      <id>[UID]</id>
      <serverid>[UID]</serverid>
      <deviceid>[UID]</deviceid>
      <startdate>[timestamp]</startdate>
      <enddate>[timestamp]</enddate>
      <description>[string]</description>
      <filesize>[number]</filesize>
      <imagewidth>[number]</imagewidth>
      <imageheight>[number]</imageheight>
      <status description="[string]">[string]</status>
    </clip>
  </clips>
</result>
node value remarks
/result
@errorcode [number] See error codes below
/result/clips
@count [number] The number of video clips.
/result/clips/clip
id [UID] unique id
serverid [UID] unique server id
deviceid [UID] unique device id
startdate [timestamp] Clips with a UTC timestamp >= startdate are returned.
enddate [timestamp] Clips with a UTC timestamp < = enddate are returned.
description [string] A user defined description
filesize [number] Size of the clip in bytes
imagewidth [number] Width of the clip in pixels
imageheight [number] Height of the clip in pixels
status [string] 'pending', 'busy', 'finished', or 'failed'
error code description remarks
0 Ok Ok, no error.
-17 No server There is no server with the supplied id.
-18 General error An undefined error occurred.

See Also

Changelog

  • 2.7.2 – Added