*updateClip
- Tom Polman
Configuration Article | CA-20220907-TP-52 VDG Sense | API | Functions | Media  |  |
Update the description of a clip of the given id. 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=updateClip&id=[UID]&serverid=[UID] |
Parameter | type | remarks |
|---|---|---|
id | [UID] | unique clip id |
serverid | [UID] | unique server id |
description | [string] | description of the clip |
Response
<result errorcode="0">
  <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>
</result> |
Â
node | value | remarks |
|---|---|---|
/result | Â | Â |
@errorcode | [number] | See error codes below |
/result/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 |
-40 | Clip not found | Clip with given ID does not exist |
See also
Changelog
2.7.2 – Added