⌂ > 🛠 Конфигурационный REST API > ⇄ Маршрут
POST /configure/channels : Добавление новых камер🔗
Предупреждение
Доступно только в лицензиях Enterprise и ULTRA.
Данный запрос может выполняться только пользователем с максимальными правами, то есть входящим в группу Старшие администраторы.
Важно
Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.
Параметры JSON-объекта камеры🔗
Поле |
Описание |
|---|---|
Name |
Название камеры |
Disabled |
Отключена ли камера |
ServerBindingsSettings |
Обязательный параметр. Параметры привязки камеры к серверам |
ServerBindingsSettings.OwnerServerId |
Обязательный параметр. Id сервера, на который пишется архив. Считается, что камера «прикреплена» к этому серверу |
ServerBindingsSettings.ReservedServerId |
Id сервера, на который камера производит резервирование |
ServerBindingsSettings.ReplicationServerId |
Id сервера, на который камера производит репликацию |
ParentSecObjectId |
Id объекта безопасности, в котором расположена камера |
Description |
Описание камеры |
ConnectionSettings |
Обязательный параметр. Параметры подключения к камере |
ConnectionSettings.ModelId |
Модель камер |
ConnectionSettings.Hostname |
Адрес для подключения к камере |
ConnectionSettings.Login |
Логин для подключения к камере |
ConnectionSettings.Password |
Пароль для подключения к камере |
ConnectionSettings.MainVideoStreamFormat |
Формат видео основного потока: MJPEG , MPEG4_Part2, H264, Hevc |
ConnectionSettings.AltVideoStreamEnabled |
Включен ли альтернативный поток |
ConnectionSettings.AltVideoStreamFormat |
Формат видео альтернативного потока: MJPEG , MPEG4_Part2, H264, Hevc |
ConnectionSettings.SoundReceivingEnabled |
Включен ли приём звука |
ConnectionSettings.PtzEnabled |
Включено ли PTZ-управление камерой |
ConnectionSettings.Ipv6Enabled |
Включено ли IPv6 |
ConnectionSettings.MultiChannelServerEnabled |
Является ли камера каналом видеосервера |
ConnectionSettings.MultiChannelServerChannelNum |
Номер канала видеосервера |
ConnectionSettings.IoProcessingEnabled |
Включена ли обработка входов/выходов камеры |
ConnectionSettings.SoundTransmittingEnabled |
Включена ли передача звука на камеру |
ConnectionSettings.ExternalNetworkPorts |
Внешние сетевые порты камеры. Указывается проинтегрированный порт камеры (DefaultPortValue) и внешний порт (PortValue). Проинтегрированный порт изменять нельзя. При изменении необходимо указывать проинтегрированный порт и измененный внешний порт |
ConnectionSettings.SoundVolume |
Уровень звука (значение от 0 до 100) |
ConnectionSettings.MainVideoAdditionalParams |
Дополнительные параметры подключения для основного потока |
ConnectionSettings.AltVideoAdditionalParams |
Дополнительные параметры подключения для альтернативного потока |
ConnectionSettings.MainStreamRotationMode |
Поворот основного потока при отображении в клиенте (None, By90ClockwiseDegree, By90AntiClockwiseDegree, By180Degree). Не рекомендуется изменять данное поле, т.к. детекторы и аналитика могут работать неверно. Поворот лучше производить в настройках IP-камеры |
ConnectionSettings.AltStreamRotationMode |
Поворот альтернативного потока при отображении в клиенте (None, By90ClockwiseDegree, By90AntiClockwiseDegree, By180Degree). Не рекомендуется изменять данное поле, т.к. детекторы и аналитика могут работать неверно. Поворот лучше производить в настройках IP-камеры |
ConnectionSettings.DirectNetworkConnectionToCameraEnabled |
Будет ли клиентское приложение подключаться к камере напрямую. Не рекомендуется изменять данное поле, т.к. это может привести к множеству проблем |
ConnectionSettings.GpuClientVideoDecodingEnabled |
Разрешать ли использовать декодирование на видеокарте в клиентском приложении. Для работы необходимо также активировать соответствующую опцию в настройках клиентского приложения |
ConnectionSettings.AlternativeVideoDecoderEnabled |
Разрешать ли использовать альтернативный декодер для декодирования видеопотока. Не рекомендуется изменять данное поле, т.к. это может привести к множеству проблем |
ConnectionSettings.IsSecureConnectionEnabled |
Установить только безопасное подключение к камере для всех функций |
ConnectionSettings.StreamSettings.MainStreamSettings.VideoStreamEnabled |
Включен ли основной поток. Поле только для чтения, основной поток нельзя отключить |
ConnectionSettings.StreamSettings.MainStreamSettings.VideoFormat |
Формат видео основного потока: MJPEG , MPEG4_Part2, H264, Hevc |
ConnectionSettings.StreamSettings.MainStreamSettings.VideoAdditionalParams |
Дополнительные параметры подключения для основного потока |
ConnectionSettings.StreamSettings.MainStreamSettings.RotationMode |
Поворот основного потока при отображении в клиенте (None, By90ClockwiseDegree, By90AntiClockwiseDegree, By180Degree). Не рекомендуется изменять данное поле, т.к. детекторы и аналитика могут работать неверно. Поворот лучше производить в настройках IP-камеры |
ConnectionSettings.StreamSettings.MainStreamSettings.Roles |
Роли основного потока: Archive — запись в архив, VideoAnalysis — видеоанализ, DesktopClient — отображение в десктоп-клиенте, MobileClient — отображение в мобильном приложении. Роли Archive и VideoAnalysis можно задать только для одного потока |
ConnectionSettings.StreamSettings.AlternativeStreamSettings.[...] |
Настройки дополнительного потока 1 |
ConnectionSettings.StreamSettings.SecondAlternativeStreamSettings.[...] |
Настройки дополнительного потока 2 |
ConnectionSettings.StreamSettings.ThirdAlternativeStreamSettings.[...] |
Настройки дополнительного потока 3 |
ArchiveSettings |
Параметры записи в архив |
ArchiveSettings.ArchivingDisabled |
Включено ли архивирование |
ArchiveSettings.ArchivingMode |
Режим архивирования: MDandManual — по детектору, AlwaysOn — постоянная, OnlyManual — ручная, BySchedule — по расписанию |
ArchiveSettings.ArchivingVideoStreamType |
Видеопоток, сохраняемый в архив (Main, Alternative) |
ArchiveSettings.ArchivingMinDeepnessInDays |
Хранить архив не менее в днях |
ArchiveSettings.ArchivingMaxDeepnessInDays |
Хранить архив не более в днях |
ArchiveSettings.ArchivingSoundDisabled |
Записывать ли звук в архив |
ArchiveSettings.PreMotionDetectionRecSecs |
Сколько секунд записывать в архив до движения (при включенном режиме записи по движению). Значение от 1 до 6 |
ArchiveSettings.PostMotionDetectionRecSecs |
Сколько секунд записывать в архив после движения (при включенном режиме записи по движению). Значение от 1 до 6 |
ArchiveSettings.LimitRecordFpsAndOnlyIndepFramesEnabled |
Ограничивать ли частоту записи в архив |
ArchiveSettings.LimitedRecordFps |
Сколько кадров в секунду записывать в архив при ограниченной частоте записи |
ArchiveSettings.DeviceArchiveEnabled |
Разрешен ли доступ до архива устройства (SD-карта камеры) |
ArchiveSettings.DeviceArchiveAutoSynchronizationEnabled |
Включена ли автоматическая синхронизация основного архива и архива на устройстве (SD-карте камеры) |
AnalyzeSettings |
Параметры анализа |
AnalyzeSettings.MotionDetectorEnabled |
Включен ли детектор движения |
AnalyzeSettings.MotionDetectorSettings |
Настройки детектора движения |
[...].BuildInCameraDetectorEnabled |
Включен ли встроенный в камеру детектор движения |
[...].GenerationOfEventMotionStartAndEndEnabled |
Включена ли генерация события о начале и окончании движения |
[...].DetectOnlyIndependentFrames |
Детектировать ли только опорные кадры. Данный режим может значительно уменьшить загрузку ЦП |
[...].CustomFpsEnabled |
Детектировать ли движение с определенной частотой. Активация данного режима может значительно увеличить загрузку ЦП |
[...].CustomFpsValue |
Частота, с которой будут детектироваться кадры. Значение используется только в случае, если поле CustomFpsEnabled == true |
[...].Zones |
Зоны детекции |
AnalyzeSettings.AnalyzeStreamType |
Видеопоток для анализа (Main, Alternative). Включение режима Main приведет к увеличению потребления ресурсов ЦП |
AnalyzeSettings.FaceDetectorEnabled |
Включен ли модуль Обнаружение лиц. Включение режима приведет к увеличению потребления ресурсов ЦП |
AnalyzeSettings.FaceDetectorMode |
Качество модуля Обнаружение лиц (Basic, OptimizedQuality). OptimizedQuality потребляет больше ресурсов ЦП |
AnalyzeSettings.InteractiveSearchEnabled |
Включен ли интерактивный поиск. Включение режима приведет к увеличению потребления ресурсов ЦП |
AnalyzeSettings.InteractiveSearchSettings |
Настройки интерактивного поиска |
MapSettings |
Необязательный параметр, указывающий на привязку камеры к координатам. При добавлении новых координат необходимо заполнить оба поля: Latitude и Longitude |
MapSettings.Latitude |
Широта камеры на карте, диапазон значений от -90`` до 90 градусов. Если у камеры еще не заданы координаты, возвращается null |
MapSettings.Longitude |
Необязательный параметр. Индикатор, указывающий на наличие камеры на карте. Принимает значение true, если камера присутствует, при отсутствии — false. |
Пример запроса🔗
POST http://localhost:8080/configure/channels
Пример тела POST-запроса🔗
Примечание
Тело POST-запроса должно содержать массив JSON-объектов, соответствующих добавляемым камерам (см. ресурс configure/channels/{channel-id}).
Добавление 2 новых камер, прикрепленных к серверу cd81195c-9c0e-42f0-8535-c55af9c35161.
[
{
"Name": "New Camera 1",
"ServerBindingsSettings": {
"OwnerServerId": "cd81195c-9c0e-42f0-8535-c55af9c35161"
},
"ConnectionSettings": {
"ModelId": "b499b4c5-4109-475d-8f08-341a5a5e70bd"
}
},
{
"Name": "New Camera 2",
"ServerBindingsSettings": {
"OwnerServerId": "cd81195c-9c0e-42f0-8535-c55af9c35161"
},
"ConnectionSettings": {
"ModelId": "b499b4c5-4109-475d-8f08-341a5a5e70bd"
}
}
]
Пример ответа🔗
{
"CreatedObjectsIds": [
"aafb80e1-56a0-488d-9e99-8683d34fd37a",
"7e2fc411-000b-4c12-b62e-1cd17f2f291e"
]
}