Versions Compared

Old Version 2

changes.mady.by.user Yulia Morozova

Saved on

compared with

New Version 3

changes.mady.by.user Alena Kniazeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column
width35%50%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleOn the page:
Table of Contents



Column


Export start

POST http://IP Address address:port/prefix/export/archive/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} – —archive export.
POST http://IP Address address:port/prefix/export/live/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} – —live video export.

Tip

{VIDEOSOURCEID} – the three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

...

Info
titleNote

BEGINTIME and ENDTIME set time in the YYYYMMDDTHHMMSS format in the UTC+0 time zone. If BEGINTIME is greater than ENDTIME, then the values will swap. BEGINTIME should must be equal to ENDTIME for frame export.  

The ENDTIME and BEGINTIME syntax is described in Get archive contents.

...

ParameterFormatDescriptionExample
formatString

Mandatory parameter. Available values are mp4, mkv, avi, exe, jpg and pdf. It sets the format of output export container


maxfilesize

Number

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)

"maxfilesize": 1e+6
"maxfilesize": 1000000
vc, acNumber

A compression quality level for video and audio respectively. Allowed values are from 0 to 6 (6 means the worst). Default value is 0


freq Number

Frame rate of the output stream. Default value is 0. Available values:

  1. 0 – —original
  2. 1 – —half of original
  3. 2 – —quarter of original
  4. 3 – —one-eighth of original

tsformatString

A time stamp format template. Any string can be generated on the basis of 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.

Attention! The Server does not check the format of the input string

"tsformat": "%B %Y",
cropareaArea

A frame area for export (default value is [[0, 0], [1,1]] – —the entire frame).

Image example:


Code Block
"croparea": [
        [
            0.3,
            0.3
        ],
        [
            0.8,
            0.8
        ]
    ]


maskspaceArea

A frame area for masking, set in coordinates. By default a frame is not masked.

The area is specified by at least 3 three anchor points + 1 one terminal point (coincides with one of the anchor points). The reference point is the upper left corner. You can specify multiple polygons.

Image example:


Code Block
"maskspace": [
    [
        [
            0.2,
            0.2
        ],
        [
            0.3,
            0.7
        ],
        [
            0.5,
            0.5
        ],
        [
            0.2,
            0.2
        ]
    ]
]


colorString

Text color of a comment and a time stamp. It is set in the #FFFFFF web format

"color": "#e31e1e",
comment StringA comment
Parameters relevant for PDF export only:
snapshotplaceAreaFrame location on the page
commentplaceAreaComment location on the page
tsplaceAreaTime stamp location on the page
layoutNumber

Page layout. Available values are 0 (portrait), 1 (landscape)


...

Code Block
HTTP/1.1 202 Accepted
Connection: Close
Location: /export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3
Cache-Control: no-cache

Possible error codeserrors:

Error codeDescription
400Incorrect request
500Server internal error

Get export status

GET http://IP Address address:port/export/{id}/status

Tip

 id is the value from the Location field (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

...

ParameterDescription
state

Current state of export. Available values:
0 – export is not yet in perform—export hasn't been performed
1 – —export is performed
2 – —export is completed
3 – —export error
4 – —not enough space to complete the operation
5 – —the file with the given name already exists
6 – —no data to export

progressProgress of export session in the range from 0 to 1
errorDescription of error (if any)
filesList of files created as the result of the export

Download file

GET http://IP Address address:port/prefix/export/{id}/file

...

Info
titleNote

On the Server the exported file is saved to the folder C:\ProgramData\AxxonSoft\AxxonOne\Export\{ID} folder

Export completion

This request deletes the created file on the Server.

DELETE http://IPAddress address:port/prefix/export/{id}

Tip

 id is the value from the Location field (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

Sample request:

DELETE DELETE http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3

Files from the export folder can be automatically deleted:

  1. When the Web-Server is stopped.
  2. By a timeout cleanup procedure that runs for the first time after 10 hours of continuous Web-Server operation and repeats every 10 minutes. It deletes all files that have had no activity (upload status request, file download) in the last 10 hours.