Export start
Export is initiated using one of the following POST requests:
http://IP-Address:port/prefix/export/archive/SERVER1/VIDEOSOURCEID/BEGINTIME/ENDTIME - archive export
http://IP-Address:port/prefix/export/live/SERVER1/VIDEOSOURCEID/BEGINTIME/ENDTIME - live video export
where BEGINTIME and ENDTIME set time in the YYYYMMDDTHHMMSS format. If BEGINTIME is greater than ENDTIME, then the values will swap. BEGINTIME must be equal to ENDTIME for snapshot export.
Complex data structures are in use to describe frames and masks. These structures can be divided into several types:
- point is set using x,y syntax: sample - [0.5, 0.5].
- area sets square frame; defined by two points ! separated. Sample - [[0.5, 0.5], [0.4,0.4]].
- polygon sets closed curve; contains at least 3 points enclosed in []. Sample - [[0.5, 0.5], [0.4,0.4],[0.3,0.3]].
- mask is a collection of polygons. Sample - [[[0.5, 0.5],[0.6, 0.6],[0.7, 0.7]], [[0.1, 0.1],[0.2, 0.2],[0.3, 0.3]]].
Supported parameters that are sent in the body of initial POST request:
- format (string) is a mandatoryparameter; available values are mkv, avi, exe, jpg and pdf. It sets the format of output export container.
- maxfilesize (number) is a maximum export file size (in bytes). A new file will be created when the size limit is exceeded. Export results in the collection of files. Default value is 0 (as a result, a single file).
- vc, ac (number) is a compression quality level for video and audio respectively. Allowed values are from 0 to 6 (6 means the worst). The initial quality level will be set when 0 is specified (original API fault). Default value is 0.
- freq (number) – frame rate of the output stream. Default value is 0. Available values:
- 0 – original
- 1 – half of original
- 2 - quarter of original
- 3 – one-eighth of original
tsformat (string) is a time stamp format template. Any string can be generated http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/date_time_io.html. Default value is %Y-%b-%d %H:%M:%S. Server does not check the format of the input string. |
- croparea (area) is a snapshot area for export (Default value is 0,0!0,0 – the entire snapshot).
- maskspace (mask) is a snapshot mask space. By default a snapshot is not masked.
- color (string) is a color of a comment and time stamp text. It is set in the #FFFFFF format.
- comment (string) is a comment.
Parameters relevant to PDF format only.
- snapshotplace (area) is a snapshot location on the page
- commentplace (area) is a comment location on the page
- tsplace (area) is a time stamp location on the page
layout (number) – page layout. Available values are 0 (portrait), 1 (landscape). |
The request will result in an error response or response that looks like:
HTTP/1.1 202 Accepted
Connection: Close
Location: /export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3
Cache-Control: no-cache |
Possible error codes: - 500 - Server internal error.
|
Get export status
GET http://IP-Address:port/prefix/export/id/status
where id is the value from the Location field (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)
Sample response:
{
"id": "73c2e1d2-0f8f-414c-9cc0-ac5fb43cd8dd"
,"state": 1
,"progress": 0.51062298
,"error": ""
,"files":
[
]
} |
where
- state defines the current state of export. Available values:
1 – export is performed
2 – export is completed
3 – export error
4 – not enough space to complete the operation - progress – progress of export session in the range from 0 to 1.
- error – description of error (if any)
- files - the list of files created as the export result
Export completion
DELETE http://IP-Address:port/prefix/export/id
where id is the value from the Location field.
Download file
GET http://IP- Address:port/prefix/export/id/file?name=SERVER_DeviceIpint.1[20160527T132900-20160527T133000].mkv
where
- id is the value from the Location field
- file?name is the name of file from the files field