⌂ > ⎘ Открытый REST API

GET /ptz?command=getcapabilities : Получение информации о возможностях устройства🔗

Доступно во всех типах лицензий.

Предупреждение

Данная команда передаётся через сервер на PTZ-устройство (камеру). Способность устройства выполнить команду и точность её выполнения зависят непосредственно от устройства и его интеграции с .

Важно

Во всех примерах указан локальный хост (localhost). При отправке реальных запросов замените его на адрес и порт сервера, на который отправляете запрос.

Примечание

Доступно получение ответа в формате JSON.

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

Пример запроса данных в формате XML:

GET http://localhost:8080//ptz?command=getcapabilities&login=root&password=&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b

Пример запроса данных в формате JSON:

GET http://localhost:8080//ptz?command=getcapabilities&login=root&password=&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b=&responsetype=json

В ответ сервер передаст список PTZ-возможностей, поддерживаемых системой, с указанием через значения параметров тех возможностей, которые поддерживаются самим устройством.

Пример ответа на запрос🔗

Пример ответа на запрос в формате XML:


Пример ответа на запрос в формате JSON:

GET http://localhost:8080//ptz?command=getcapabilities&login=root&password=&channelid=20d9884f-ae8c-45d3-ac5a-505ec258f01b=&responsetype=json

В ответ сервер передаст список PTZ-возможностей, поддерживаемых системой, с указанием через значения параметров тех возможностей, которые поддерживаются самим устройством.

Пример ответа на запрос🔗

Пример запроса данных в формате XML:

<CameraCapabilities>
    <PtzCapabilities>
        <HomePositionSupports>true</HomePositionSupports>
        <MoveToSupports>true</MoveToSupports>
        <AreaZoomSupports>true</AreaZoomSupports>
        <ZoomSupports>true</ZoomSupports>
        <ContiniousZoomSupports>true</ContiniousZoomSupports>
        <AbsoluteZoomSupports>false</AbsoluteZoomSupports>
        <MaxMinZoomSupports>false</MaxMinZoomSupports>
        <AutoFocusSupports>true</AutoFocusSupports>
        <ManualFocusSupports>true</ManualFocusSupports>
        <ContiniousFocusSupports>true</ContiniousFocusSupports>
        <AutoIrisSupports>false</AutoIrisSupports>
        <ManualIrisSupports>false</ManualIrisSupports>
        <InfraredLightSupports>true</InfraredLightSupports>
        <WipersControlSupports>true</WipersControlSupports>
        <WasherControlSupports>true</WasherControlSupports>
        <SupportedStepMoveDirections>None</SupportedStepMoveDirections>
        <SupportedContiniousMoveDirections>Any</SupportedContiniousMoveDirections>
        <SetRelativePositionSupports>false</SetRelativePositionSupports>
        <SetAbsolutePositionSupports>false</SetAbsolutePositionSupports>
        <GetAbsolutePositionSupports>false</GetAbsolutePositionSupports>
        <BlackWhiteModeSupports>false</BlackWhiteModeSupports>
        <NightModeSupports>false</NightModeSupports>
    </PtzCapabilities>
    <Resolution>
        <Width>1920</Width>
        <Height>1080</Height>
    </Resolution>
</CameraCapabilities>

Пример запроса данных в формате JSON:

{
    "PtzCapabilities": {
            "HomePositionSupports": true,
            "MoveToSupports": true,
            "AreaZoomSupports": true,
            "ZoomSupports": true,
            "ContiniousZoomSupports": true,
            "AbsoluteZoomSupports": false,
            "MaxMinZoomSupports": false,
            "AutoFocusSupports": true,
            "ManualFocusSupports": true,
            "ContiniousFocusSupports": true,
            "AutoIrisSupports": false,
            "ManualIrisSupports": false,
            "InfraredLightSupports": true,
            "WipersControlSupports": true,
            "WasherControlSupports": true,
            "SupportedStepMoveDirections": "0",
            "SupportedContiniousMoveDirections": "255",
            "SetRelativePositionSupports": false,
            "SetAbsolutePositionSupports": false,
            "GetAbsolutePositionSupports": false,
            "BlackWhiteModeSupports": false,
            "NightModeSupports": false
    },
    "Resolution": {
        "Width": 1920,
        "Height": 1080
    }
}

Параметры ответа🔗

Параметр

Описание

HomePositionSupports

Поддержка возврата к домашнему положению камеры

MoveToSupports

Поддержка центрирования (перемещения камеры) на заданной точке

AreaZoomSupports

Поддержка функции приближения выделенной области кадра

ZoomSupports

Поддержка «шагового» (однократного) изменения уровня зума

ContiniousZoomSupports

Поддержка «непрерывного» (выполняемого до принудительного завершения) изменения уровня зума

AbsoluteZoomSupports

Поддержка абсолютного зума

MaxMinZoomSupports

Поддержка перехода к максимальному или минимальному уровню зума

AutoFocusSupports

Поддержка функции автофокусировки

ManualFocusSupports

Поддержка ручного управления фокусом

ContiniousFocusSupports

Поддержка «следящего» фокуса

ManualIrisSupports

Поддержка ручного управления диафрагмой

InfraredLightSupports

Поддержка управления инфракрасной подсветкой

WipersControlSupports

Поддержка управления механическим очистителем

WasherControlSupports

Поддержка управления омывателем

SupportedStepMoveDirections

Маска, описывающая доступные направления для «шагового» перемещения

SupportedContiniousMoveDirections

Маска, описывающая доступные направления для «непрерывного» перемещения

SetRelativePositionSupports

Поддержка возможности указать позицию относительно текущего положения устройства

SetAbsolutePositionSupports

Поддержка возможности указать абсолютную позицию устройства

GetAbsolutePositionSupports

Поддержка возможности получить информацию о текущей абсолютной позиции камеры

BlackWhiteModeSupports

Поддержка переключения устройства в чёрно-белый режим

NightModeSupports

Поддержка переключения устройства в «ночной» режим

Resolution

Текущее разрешение кадра основного потока, где:

Width

ширина кадра.

Height

высота кадра.

Для большинства PTZ-возможностей логические (булевы) значения: true — поддерживается; false — не поддерживается. Исключение составляют параметры SupportedStepMoveDirections, SupportedContiniousMoveDirections и Width/Height: их значения являются числами.