GET /command?type=getchannelsstates : Получение информации о состоянии каналов🔗

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

Важно

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

Примечание

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

Для получения информации о состоянии каналов и их опций используется запрос к ресурсу command с типом getchannelsstates.

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

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

GET http://localhost:8080/command?type=getchannelsstates&login=root&password=

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

GET http://localhost:8080/command?type=getchannelsstates&login=root&password=&responsetype=json

В ответ сервер передаст информацию о состоянии потоков данных, использующихся активными каналами.

Примечание

Ответ на запрос содержит информацию только о включённых каналах. Информация о существующих, но выключенных каналах не передаётся.

Дополнительные параметры запроса🔗

Параметр	Значение по умолчанию	Описание
responsetype	xml	Формат представления возвращаемых данных. Если не указан в запросе, используется значение по умолчанию. Опциональный параметр. Допустимые значения: xml, json

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

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

<ArrayOfChannelState>
    <ChannelState>
        <Id>a3785d7f-9259-456b-a64a-048342f22964</Id>
        <IsRecordingOn>true</IsRecordingOn>
        <StreamsStates>
            <Stream>
                <Type>MainVideo</Type>
                <State>NoConnection</State>
            </Stream>
            <Stream>
                <Type>AlternativeVideo</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>MainSound</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>AlternativeSound</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>OutputSound</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>MotionDetection</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>IO</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>ArchiveVideo</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>ArchiveSound</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>SecondAlternativeVideo</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>ThirdAlternativeVideo</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>SecondAlternativeSound</Type>
                <State>Stopped</State>
            </Stream>
            <Stream>
                <Type>ThirdAlternativeSound</Type>
                <State>Stopped</State>
            </Stream>
        </StreamsStates>
        <IsAnalogCameraConnected>false</IsAnalogCameraConnected>
    </ChannelState>
</ArrayOfChannelState>

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

[
    {
        "Id": "a3785d7f-9259-456b-a64a-048342f22964",
        "IsRecordingOn": false,
        "StreamsStates":
        [
            {
                "Type": "MainVideo",
                "State": "Active"
            },
            {
                "Type": "AlternativeVideo",
                "State": "Stopped"
            },
            {
                "Type": "MainSound",
                "State": "Active"
            },
            {
                "Type": "AlternativeSound",
                "State": "Stopped"
            },
            {
                "Type": "OutputSound",
                "State": "Stopped"
            },
            {
                "Type": "MotionDetection",
                "State": "Stopped"
            },
            {
                "Type": "IO",
                "State": "Stopped"
            },
            {
                "Type": "ArchiveVideo",
                "State": "Stopped"
            },
            {
                "Type": "ArchiveSound",
                "State": "Stopped"
            },
            {
                "Type": "SecondAlternativeVideo",
                "State": "Stopped"
            },
            {
                "Type": "ThirdAlternativeVideo",
                "State": "Stopped"
            },
            {
                "Type": "SecondAlternativeSound",
                "State": "Stopped"
            },
            {
                "Type": "ThirdAlternativeSound",
                "State": "Stopped"
            },

        ]
    }
]

Где:

Параметр	Подпараметр	Описание
Id	—	Уникальный идентификатор канала
IsRecordingOn	—	Состояние записи архива канала. Возможные значения: true – запись в архив разрешена, false – запрещена
StreamStates		Состояние потоков получения данных. У каждого потока есть тип Type и состояние State
	Type	Тип канала связи. Возможные значения: MainVideo — приём видео, поток Основной; AlternativeVideo — приём видео, поток Дополнительный 1; MainSound — прием звука, поток Основной; AlternativeSound — прием звука, поток Дополнительный 1; OutputSound — передача звука; MotionDetection — встроенный детектор движения; IO — цифровые входы/выходы; ArchiveVideo — архивное видео; ArchiveSound — архивный звук; SecondAlternativeVideo — приём видео, поток Дополнительный 2; ThirdAlternativeVideo — приём видео, поток Дополнительный 3; SecondAlternativeSound — приём звука, поток Дополнительный 2; ThirdAlternativeSound — приём звука, поток Дополнительный 3.
	State	Состояние канала связи. Возможные значения: Stopped — поток остановлен, т.к. он не требуется системе; Active — поток находится в состоянии получения кадров и событий; NoConnection — в потоке произошел обрыв соединения с устройством.
IsAnalogCameraConnected	—	Флаг типа камеры, использующейся каналом. Возможные значения: true – устройство подключено как аналоговая камера, false – как цифровое устройство