Page History

...

Section

Column

width	50%

Panel

borderColor	#CCCCCC
bgColor	#FFFFFF
titleBGColor	#F0F0F0
borderStyle	solid
title	On the page:

Table of Contents

Column

Export start

Export from archive:

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

Export of live video:

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

Tip

{

VIDEOSOURCEID

} – the

is a three-component source endpoint ID (see Get list of cameras and information about them). For

instanceBEGINTIME and ENDTIME

example, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

Info

title	Note

BEGINTIME and ENDTIME set time in the YYYYMMDDTHHMMSSformat in the UTC+0 time zone. If BEGINTIME is greater than ENDTIME,

then

the values will swap. BEGINTIME must be equal to ENDTIME for frame export.

The ENDTIME and BEGINTIME syntax is described

in

in Get archive contents.

Parameter	Required	Description
waittimeout	No	Wait timeout in milliseconds required for a frame to arrive. The default value is 10000. If the parameter value is less than the reference

frames

frame interval,

then the export will not be performed.It is recommended to set the value not less than

export isn't performed. We recommend specifying the value to at least 30000
archive	No	Name of the archive in the hosts/SERVER1/MultimediaStorage.AliceBlue/

MultimediaStorage format

MultimediaStorage format (

see

see Get archive contents). If you don't specify the value

is not specified

, the default archive

will be

is used for export

Sample Example of a request:

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

Request Example of a 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:

Parameter	Format	Description	Example
format

String

Text value

Mandatory parameter

. Available

. It sets the format of the output export container. Acceptable values are:

mp4,

mkv,
avi,
exe,
jpg

and pdf. It sets the format of output export container

maxfilesize

Number

, pdf	"format": "mp4" "format": "exe"
maxfilesize	Numeric value	Maximum size of an export file

Maximum export file size

in bytes. A new file

will be

is created when the size limit is exceeded. Export results in the collection of files.

Default

The default value is 0 (as a result, a single file)

"maxfilesize": 1e+6

"maxfilesize": 1000000

vc, ac

NumberA compression quality

Numeric value

Quality of a compression level for video and audio, respectively.

Allowed

Acceptable values are from 0 to 6 (6

means

is the worst).

Default

The default value is 0	"vc": 3
freq

Number

Numeric value

Frame rate of the output stream. Default value is 0.

Available

Acceptable values are:

0

—original

—original (default),
1

—half

—half of original,
2

—quarter

—quarter of original,
3

—one

—one-eighth of original
tsformat

String

Text value

A template of a time stamp format

template

. Any string can be generated on the basis

of

of http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/date_time_io.html.

Default

The default value is %Y-%b-%d %H:%M:%S

.

Note

title	Attention!

The Server does not

The server doesn't check the format of the input string.

"tsformat": "%B %Y",

croparea

Area

A

An area of a frame

area

for export

(

. The default value is [[0, 0], [1,1]]

—the

(entire frame)

.

Example of an image

Image example

:

Image Modified

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

maskspace

Area

A

An area of a frame

area

for masking, set in coordinates. By default, a frame

is not

isn't masked.

The area

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

multiple polygons

several areas.

Image example

Example of an image:

Image Modified

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

color

String

Text value	Text color of a comment and a time stamp. It is set in the #FFFFFF web format	"color": "#e31e1e",
comment

String

Text value	A comment	"comment": "сomment"
Parameters relevant for PDF export only

:


snapshotplace	Area

Frame location

Location of a frame on the page
commentplace	Area

Comment location

Location of a comment on the page
tsplace	Area

Time

Location of a time stamp

location

on the page
layout

Number

Numeric value

Page layout. Available values are

0

(portrait), 1 (landscape)

—portrait,
1—landscape

Example of a responseSample response:

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

Possible errors:

Error code	Description
400	Incorrect request
500	Server internal error

Get export status

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

Tip
id id is the value from the Location field (here in this case, 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).

Sample Example of a request:

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

Sample Example of a response:

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"
  ]
}

Parameter

Description

state

Current state of export. Available values are:

0

—export

—export hasn't been performed,
1

—export

—export is performed,
2

—export

—export is

completed

complete,
3

—export

—export error,
4

—not

—not enough space to complete the operation,
5

—the file

—file with the given name already exists,
6

—no

—no data to export
progress	Progress of export session in the range from 0 to 1
error	Description of error

(

, if any

)


files	List of files created as the result of the export

Download file

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

Tip
id id is the value from the Location field (here in this case, 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).

Parameter	Required	Description
name	Yes	Name of a file from the files field

Sample Example of a request:

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

Info

title	Note

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

Export completion

This request deletes the Deletion of a created file on the Server.server:

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

Tip

id

id is the value from the Location field (

here

in this case, 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

Sample request:

...

.

...

Files from the export folder can be automatically deleted:
1. When the Web-Server is stopped.
2. By

...

1. the 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.

Example of a request:

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

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Export start

Get export status

Download file

Export completion