Versions Compared

Old Version 1

changes.mady.by.user Vadim Belyakov

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.
Comment: Reverted from v. 12

...

Tip

{VIDEOSOURCEID} - трехкомпонентный идентификатор endpoint-а источника (см. Получение списка источников видео (камер)).    Например,    "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

...

Info
titleПримечание

BEGINTIME и ENDTIME задают время в формате YYYYMMDDTHHMMSS в часовом поясе UTC+0.  Если BEGINTIME больше ENDTIME, то значения поменяются местами.  Для экспорта кадра BEGINTIME должно быть равно ENDTIME.

Синтаксис ENDTIME и BEGINTIME описан в разделе Получение содержания архивов.


ПараметрОбязательныйОписание
waittimeoutНет

Таймаут ожидания поступления кадра в миллисекундах. Значение по умолчанию - 10. Если значение параметра меньше, чем интервал опорных кадров, экспорт выполнен не будет. Рекомендуется устанавливать значение не меньше 30

archiveНетИмя архива в формате "hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage" (см. Получение содержания архивов). Если значение не задано, для экспорта будет использоваться архив по умолчанию

Пример запроса:

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

Пример тела запроса:

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

Поддерживаемые параметры передаваемые в теле начального POST запроса:

ПараметрФорматОписаниеПример
formatТекстовое значение

Обязательный параметр. Доступные значения mp4, mkv, avi, exe, jpg, pdf. Задает формат выходного контейнера экспорта. 


maxfilesize

Числовое значениеМаксимальный размер файла экспорта в байтах. При достижении этого размера будет создаваться новый файл. Результатом экспорта будет коллекция файлов. Значение по умолчанию - 0 (на выходе единственный файл).
"maxfilesize": 1e+6
"maxfilesize": 1000000
vc, acЧисловое значениеУровень качества сжатия для видео и аудио соответственно. Допустимые значения от 0 до 6 (6 - наихудшее). Тонкий нюанс - при указании 0 в значении параметра будет оставлен исходный уровень качества (скорее всего недоработка исходного API). Значение по умолчанию - 0.
freq Числовое значение

Частота кадров выходного потока. Значение по умолчанию - 0. Допустимые значения:

  1. 0 - оригинальная
  2. 1 - половина оригинальной
  3. 2 - четверть
  4. 3 - осьмушка

tsformatТекстовое значение

Шаблон формата временной метки. Можно генерировать любую строку на основании http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/date_time_io.html. Значение по умолчанию: %Y-%b-%d %H:%M:%S. 

Внимание! Сервер не проверяет формат введенной строки.

"tsformat": "%B %Y",
cropareaОбласть

Область кадра для экспорта (Значение по умолчанию [[0, 0], [1,1]] - весь кадр).

Изображение для примера:


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


maskspaceОбласть

Область маскировки кадра, задается в координатах. По умолчанию кадр не маскируется.

Построение области происходит минимум по 3 узловым точкам + 1 замыкающая (совпадает с одной из точек). Начало координат - левый верхний угол. Допускается задание нескольких полигонов. 

Изображение для примера:


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


colorТекстовое значениеЦвет текста для комментария и временной метки. Задается в Web-формате - #FFFFFF."color": "#e31e1e",
comment Текстовое значениеКомментарий
Параметры актуальные только для экспорта в PDF:
snapshotplaceОбластьПоложение кадра на странице
commentplaceОбластьПоложение комментария на странице
tsplaceОбластьПоложение временной метки на странице
layoutЧисловое значениеОриентация страницы. Допустимые значения - 0 (портретная), 1 (альбомная).

Пример тела запроса:

...


Пример ответа:

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

Возможные ошибки:

Код ошибкиОписание
400Неправильно сформированный запрос.
500Внутренняя ошибка Сервера.

...

ПараметрОписание
state

Текущее состояние экспорта. Возможные значения:
0 - экспорт еще не выполняется
1 - экспорт выполняется
2 - экспорт завершен 
3 - ошибка экспорта
4 - недостаточно места для выполнения операции
5 - файл с заданным именем уже существует
6 - нет данных для экспорта

progressПрогресс сессии экспорта в диапазоне от 0 до 1.
errorОписание ошибки, если таковая присутствует.
filesСписок файлов, созданных в результате экспорта.

...

Скачивание файла

DELETE httpGET http://IP-адрес:порт/префикс/export/{id}/file

Tip

id - значение из поля Location (в данном случае 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).


ПараметрОбязательныйОписание
nameДаИмя файла из поля files.

Пример запроса:

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

Скачивание файла

/file?name=Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4


Info
titleПримечание

На Сервере экспортированный файл сохраняются в папку C:\ProgramData\AxxonSoft\AxxonNext\Export\{ID}.

Завершение экспорта

Данный запрос удаляет сформированный файл на Сервере.

DELETE httpGET http://IP-адрес:порт/префикс/export/{id}/file

Tip

id - значение из поля Location (в данном случае 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).

...

.

Пример запроса:

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