getExportVideoStatus

Configuration Article | CA-20240119-MF-21

VDG Sense | API | Functions | Media

1 Request
2 Response
3 Related
4 Changelog

Note:

This function requires an API license
Introduced in VDG Sense version 2.7.3

The getExportVideoStatus command can be used to request the status of an API based video exports. It shows the list of exports that are still pending or are already completed. If an additional ‘exportid’ parameter is added, the progress of a specific export can be monitored.

Please not that after a restart of the SensePluginManager, the exportid will be reset.

Special care must be taken when including xml specific characters. These are ‘&’, ‘<' en '>‘. The ampersand (‘&’) character can not be sent by this command because it will be part of the URL. See next paragraph.

As the value of this event is in the query part of an URL, the ampersand character (‘&’) cannot be part of it. It must be URL Encoded. See i.e. http://www.w3schools.com/TAGS/ref_urlencode.asp. The best practive is to URL Encode the complete value.

Request

command?command=getExportVideoStatus&exportid=[exportid]

The parameter ’exportid' in the request is optional, if omitted, the whole videoexportlist is returned

parameters	type	remarks

parameters	type	remarks
exportid	[exportid]	[optional] The exportid is generated when an exportvideo request is done. See exportVideo function

Response

The response of the server will bea list in XML format which will display with the current exports and status of the export.

<!--?xml version="1.0" ?-->
  <result errorcode="0">
    <exports count=[exportcount]>
      <export>
        <exportid>[exportid]</exportid>
        <path>[path]</path>
        <status>[status]</status>
        <bandwidth>[bandwidth]</bandwidth>
        <devices>
          <device>
            <serverid>[UID]</serverid>
            <deviceid>[UID]</deviceid>
            <starttime>[timestamp]</starttime>
            <endtime>[timestamp]</endtime>
            <progress>0</progress>
            <status>[status]</status>
          <device>
          ...
          </device>
        </devices>
    </export>
  </exports>
</result>

The status node will change during the export. Exporting video can take some time, therefore it’s required to regularly update this request.

The possible status values are: SYNCING; PENDING ; COMPLETED ; REMOVED

parameters	type	remarks

parameters	type	remarks
exportcount	[value]	number of current exports
exportid	[exportid]	id of the export
path	[string]	path to where the export is saved
progress	[value]	progress of the export for the specific device, [0..100%]
status	[string]	Possible values: syncing, pending, completed
bandwidth	[value]	Speed of the export in kilobits per second

Result codes:

error code	description	remarks

error code	description	remarks
0	Ok	Ok, no error
-57	Invalid exportid	Exportid does not exist

Changelog

2.7.3 - Introduced

getExportVideoStatus

Request

Response

Related

Changelog