Перейти в хранилище документации
Обратиться в техническую поддержку
GET http://IP-адрес:порт/префикс/camera/list – получить все доступные оригинальные источники (камеры) домена.
Возвращаемые идентификаторы VIDEOSOURCEID будут иметь вид "HOSTNAME/ObjectType.Id/Endpoint.Name". Также будут возвращены friendly name и прочая метаинформация.
Параметр | Обязательный | Описание |
---|---|---|
limit | Нет | Определяет максимальное количество возвращаемых результатов, по умолчанию 1000 |
next_page | Нет | Значение параметра nextPageToken, который будет в ответе, если запрос вернул не все результаты. Применяется для получения следующих значений |
filter | Нет | Позволяет получить подмножество результатов в соответствии с фильтром. На данный момент может принимать значения HOSTNAME или VIDEOSOURCEID Внимание! Если имя сервера Office, то запрос GET http://IP-адрес:порт/префикс/camera/list?filter=Office вернет всё видеокамеры Сервера Office. |
group_ids | Нет | Список идентификаторов групп, которым должны принадлежать камеры (см. Получение списка групп и их содержимого). Возможно задание нескольких идентификаторов, используя разделитель "|". Например: http://localhost:80/camera/list?group_ids=6af92229-43ff-0347-9dae-081bf9835733|b48111eb-64c5-294c-a69c-4adb07c954d1 В этом случае ответ будет содержать все камеры, которые входят как минимум в одну из заданных групп |
query | Нет | Позволяет получить подмножество результатов в соответствии с запросом поиска |
Пример запроса 1:
GET http://127.0.0.1:80/camera/list?filter=hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0
Пример ответа:
{ "cameras" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", "archives" : [], "audioStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.audio:0", "isActivated" : false } ], "azimuth" : "0", "camera_access" : "CAMERA_ACCESS_FULL", "comment" : "", "detectors" : [], "displayId" : "1", "displayName" : "Street", "enabled" : true, "groups" : [ "e2f20843-7ce5-d04c-8a4f-826e8b16d39c" ], "ipAddress" : "0.0.0.0", "isActivated" : true, "latitude" : "0", "longitude" : "0", "model" : "TestDevice", "offlineDetectors" : [], "panomorph" : false, "ptzs" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/TelemetryControl.0", "areaZoom" : false, "focus" : { "isAbsolute" : false, "isAuto" : false, "isContinous" : true, "isRelative" : false }, "iris" : { "isAbsolute" : false, "isAuto" : false, "isContinous" : true, "isRelative" : false }, "is_active" : true, "move" : { "isAbsolute" : false, "isAuto" : false, "isContinous" : true, "isRelative" : false }, "pointMove" : false, "zoom" : { "isAbsolute" : false, "isAuto" : false, "isContinous" : true, "isRelative" : false } } ], "rays" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/EventSupplier.ray0:0", "displayId" : "1.0.0", "displayName" : "Ray", "enabled" : true, "isActivated" : true }, { "accessPoint" : "hosts/Server1/DeviceIpint.1/EventSupplier.ray0:1", "displayId" : "1.0.1", "displayName" : "Ray", "enabled" : true, "isActivated" : true } ], "textSources" : [], "vendor" : "Virtual", "videoStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0" } ] }, { "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0", "archives" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0", "default" : false, "incomplete" : false, "isEmbedded" : false, "storage" : "hosts/Server1/MultimediaStorage.AliceBlue/MultimediaStorage", "storageDisplayName" : "AliceBlue" } ], "audioStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.audio:0", "isActivated" : true } ], "azimuth" : "0", "camera_access" : "CAMERA_ACCESS_FULL", "comment" : "", "detectors" : [ { "accessPoint" : "hosts/Server1/AVDetector.1/EventSupplier", "displayName" : "Face detection", "events" : [ "TargetList", "faceAppeared" ], "isActivated" : false, "parentDetector" : "", "type" : "TvaFaceDetector" } ], "displayId" : "2", "displayName" : "Hall", "enabled" : true, "groups" : [ "e2f20843-7ce5-d04c-8a4f-826e8b16d39c" ], "ipAddress" : "0.0.0.0", "isActivated" : true, "latitude" : "78.2379", "longitude" : "15.4466", "model" : "Virtual several streams", "offlineDetectors" : [], "panomorph" : false, "ptzs" : [], "rays" : [], "textSources" : [], "vendor" : "Virtual", "videoStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0" }, { "accessPoint" : "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:1" } ] } ], "search_meta_data" : [ { "matches" : [ 6, 7, 8, 9, 10, 11, 12 ], "score" : 0 }, { "matches" : [ 6, 7, 8, 9, 10, 11, 12 ], "score" : 0 } ] }
Параметр | Описание параметра |
---|---|
archives | Список архивов, к которым привязана видеокамера |
audioStreams | Аудиопоток |
comment | Комментарий |
camera_access | Права доступа к камере, где:
|
detectors | Список созданных детекторов |
displayId | Дружественный идентификатор |
displayName | Имя |
groups | Список групп, к которым принадлежит видеокамера |
ipAddress | IP-адрес |
isActivated | True – объект включен, False – объект отключен |
azimuth, latitude, longitude | Координаты видеокамеры. В зависимости от локализации Сервера разделителем в значении параметров может быть либо точка, либо запятая |
model | Модель |
ptzs | PTZ-устройства, где:
|
textSources | Источники событий |
vendor | Производитель |
videoStreams | Видеопотоки |
rays | Лучи |
Пример запроса 2:
GET http://127.0.0.1:80/camera/list?query.query=1.Камера&query.search_type=FUZZY&search_fields=DISPLAY_NAME&decorated_name_template={display_id}.{display_name}
Параметр | Описание параметра |
---|---|
search_type | Целое число или значение, определяющее, какой тип поиска использовать. Допустимыми значениями являются:
|
search_fields | Список целых чисел или значений, разделенных символом "|", определяющий, в каких полях необходимо выполнять поиск. Если найдено совпадение, поиск в последующих полях производиться не будет. Допустимыми значениями являются:
|
decorated_name_template | Шаблон, определяющий, как будет построена конечная строка поиска, на основе которой будет выполняться поиск. Существуют ключевые слова, которые могут быть заменены фактическими значениями устройства. Ключевыми словами являются:
По умолчанию задан шаблон {display_id}.{display_name}. Например, для устройства, имеющего имя "Камера" и короткое имя "1", конечной строкой поиска будет "1.Камера". |
Пример ответа:
{ "cameras" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0", "archives" : [], "audioStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.audio:0", "isActivated" : false } ], "azimuth" : "0", "camera_access" : "CAMERA_ACCESS_FULL", "comment" : "", "detectors" : [], "displayId" : "1", "displayName" : "\u041a\u0430\u043c\u0435\u0440\u0430", "enabled" : true, "groups" : [ "e2f20843-7ce5-d04c-8a4f-826e8b16d39c" ], "ipAddress" : "0.0.0.0", "isActivated" : true, "latitude" : "0", "longitude" : "0", "model" : "Virtual", "offlineDetectors" : [], "panomorph" : false, "ptzs" : [], "rays" : [], "textSources" : [], "vendor" : "Virtual", "videoStreams" : [ { "accessPoint" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0" } ] } ], "search_meta_data" : [ { "matches" : [ 0, 1, 2, 3, 4, 5, 6, 7 ], "score" : 220 } ] }