Versions Compared

Old Version 7

changes.mady.by.user Alina Luchkina

Saved on

compared with

New Version Current

changes.mady.by.user Yulia Morozova

Saved on

Key

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

...

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 be equal to ENDTIME for frame export.  

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


ParameterRequiredDescription
waittimeoutNo

Wait timeout in milliseconds required for a frame to arrive. The default value is

10

10000. 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.

30000

archiveNoName of the archive in the hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage format (see Get archive contents). If the value is not specified, the default archive will be used for export
.

Sample request:

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

Request body example:

Code Block
{
    "format": "mp4",
    "vc": 4,
    "comment": "сomment"
}

The supported parameters that are sent in the body of the initial POST request:

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
.
  2. 2 – quarter of original
.
  2. 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:

Image Modified


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:

Image Modified


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)

.


Sample response:

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

Possible error codes:

Error codeDescription
400Incorrect request
.
500Server internal error
.

Get export status

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

Tip

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

...

Code Block
{
  "id": "38e3e286-c07c-490f-a452-e4b541b958c4",
  "state": 2,
  "progress": 1.000000000e+00,
  "error": "",
  "files": [
    "Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4"
  ],
  "filesFriendly": [
    "Server1_10.RHCP[20190903T050000-20190903T050100].mp4"
  ]
}


ParameterDescription
state

Current state of export. Available values:
0 – export is not yet in perform

.


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: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

...