Versions Compared

Old Version 4

changes.mady.by.user Vadim Belyakov

Saved on

compared with

New Version 5

changes.mady.by.user Yulia Morozova

Saved on

Key

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

...

Export is initiated using one of the following POST requests:
POST http://IP-Address:port/prefix/export/archive/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - archive export.
POST http://IP-Address:port/prefix/export/live/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - live video export.

Tip

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

...

ParameterRequiredDescription
waittimeoutNo

Wait timeout in milliseconds required for a frame to arrive. The default value is 10. If the parameter value is less than the reference frames interval, then the export will not be performed.

It is recommended to set the value not less than 30.

archiveNoName of the archive in the hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage format (see Get archive contents).

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.  

Sample request:

POST http://127.0.0.1:80/export/archive/Server1/DeviceIpint.1/SourceEndpoint.video:0:0/20200415T085456.908/20200415T085501.908?waittimeout=30

...

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 snapshot area for export (default value is [[0, 0], [1,1]] – the entire snapshot).

Image example:


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


maskspaceArea

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

The area is specified by at least 3 nodal points + 1 terminal point (coincides with one of the nodal 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 to PDF export format only:
snapshotplaceAreaSnapshot 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).


...