Versions Compared

Key

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

...

Экспорт инициируется с помощью одного из следующих POST запросов:
 http://IP-адрес:порт/префикс/export/archive/SERVER1/VIDEOSOURCEID/BEGINTIME/ENDTIME - экспорт из архива
 http://IP-адрес:порт/префикс/export/live/SERVER1/VIDEOSOURCEID/BEGINTIME/ENDTIME - экспорт живого потока

где 

  • BEGINTIME и ENDTIME задают время в формате YYYYMMDDTHHMMSS. Если BEGINTIME больше ENDTIME, то значения поменяются местами.  Для экспорта кадра BEGINTIME должно быть равно ENDTIME.
  • waittimeout - таймаут ожидания поступления кадра в миллисекундах. Значение по умолчанию - 10. Если значение параметра меньше, чем интервал опорных кадров, экспорт выполнен не будет.

Для описания рамок и масок используются сложные структуры данных, которые можно разделить на следующие типы:

...

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

...

ПараметрФормат

...

Описание

...

Пример
format

...

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

Обязательный параметр. Доступные значения mp4mkv, 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.

...

Параметры, имеющие смысл только для формата PDF.

"color": "#e31e1e",
comment Текстовое значениеКомментарий
Параметры актуальные только для экспорта в PDF:
snapshotplaceОбластьПоложение

...

кадра на странице
commentplace

...

ОбластьПоложение комментария на странице
tsplace

...

ОбластьПоложение временной метки на странице
layout

...

Числовое значениеОриентация страницы. Допустимые значения - 0 (портретная), 1 (альбомная).


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

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

...