Versions Compared

Old Version 1

changes.mady.by.user Yulia Morozova

Saved on

compared with

New Version 2

changes.mady.by.user Yulia Morozova

Saved on

Key

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

...

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 anchor points + 1 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)


...

Get export status

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

...

Download file

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

Tip

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


ParameterRequiredDescription
nameYes

Name of file from the files field

Sample request:

GET http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3/file?name=Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4

...

This request deletes the created file on the Server.

DELETE http://IP-Address:port/prefix/export/{id}

...