Описание методов работы с объектами сервера

К объектам сервера, принадлежащие тому или иному классу, применяются методы, соответствующие этому же классу объектов.

Для применения метода к объекту необходимо выполнить запрос вида:

        https://[адрес_сервера]:[порт]/objects/[GUID_объекта]/[метод]?[параметр_1]=[значение_1]&[параметр_2]=[значение_2]&sid=[id_сессии]

Ключевые элементы запроса:

  • [GUID_объекта] - guid объекта сервера (см. пример Запрос дерева объектов);
  • [метод] - метод, применяемый к объекту (ниже приведен список методов, применяемые к объектам сервера);
  • [параметр_x]=[значение_x] - параметр и его значение, используемое методом;
  • sid=[id_сессии] - id сессии, в которой выполняется запрос (см. пример Получение id сессии).

Методы для работы с каналами

Таблица 161.

Метод Описание методов и их параметров Версия ПО
manual_record_start

Включить запись архива канала.

 ≥3.1
manual_record_stop

Выключить запись архива канала.

 ≥3.1
ptz_position_query

Получить положение поворотной камеры

 ≥3.2
ptz_preset

Переместить поворотную камеру на предустановку

Параметр:

  • preset_n (integer)
≥3.1
record

Параметр:

  • turn_on_record (integer)
≥3.1
record_off

Выключить ручную запись архива канала.

 ≥3.1
record_on

Включить ручную запись архива канала.

 ≥3.1
screenshot

Сохранить скриншот

 ≥3.1
screenshot_ex

Сохранить скриншот из архива

Параметры:

  • timestamp (string)
  • directory (string)
≥3.1
screenshot_v2

Сохранить скриншот из архива

Параметры:

  • time_YYYYMMDD_HHMMSS (string)
  • screenshot_filename (string)
  • screenshot_folder (string)
  • make_thumb (integer)
≥3.2
set_watermark

Добавить текст на видео

Параметры:

  • watermark_text (string)
  • watermark_position (integer)
  • timestamp_position (integer)
≥3.1

Методы для работы с интерфейсом оператора

Таблица 162.

Метод Описание методов и их параметров Версия ПО
archive_export

Экспорт основного потока их архива канала

Параметры:

  • channel_name_or_guid (string)
  • start_time_YYYYMMDD_HHMMSS (string)
  • end_time_YYYYMMDD_HHMMSS (string)
  • filename (string)
  • archive_on_device (integer)
≥3.1
archive_export_ss

Экспорт дополнительного потока их архива канала

Параметры:

  • channel_name_or_guid (string)
  • start_time_YYYYMMDD_HHMMSS (string)
  • end_time_YYYYMMDD_HHMMSS (string)
  • filename (string)
  • archive_on_device (integer)
≥3.2
archive_open_inplace

Открыть архив канала

Параметры:

  • channel_or_template (string)
  • start_time_YYYYMMDD_HHMMSS (string)
≥3.2
assign_channels

Параметр:

  • csv_channels (string)
≥3.2
change_view_settings

Изменить настройки внешнего вида окна камеры

Параметры:

  • name (string)
  • value (string)
≥3.2
eco_start

Включить экономичный режим

Параметры:

  • channel_name (string)
  • monitor_n (integer)
≥3.2
eco_stop

Выключить экономичный режим

Параметры:

  • channel_name (string)
  • monitor_n (integer)
≥3.2
ptz_start

Включить управление PTZ-камерой

Параметры:

  • channel_name (string)
  • monitor_n (integer)
≥3.2
ptz_stop

Выключить управление PTZ-камерой

Параметры:

  • channel_name (string)
  • monitor_n (integer)
≥3.2
raise_monitor

Отобразить монитор поверх всех окон

Параметр:

  • monitor_n (integer)
≥3.2
screenshot

Сохранить скриншот из архива

Параметры:

  • channel_name (string)
  • time_YYYYMMDD_HHMMSS (string)
  • screenshot_filename (string)
≥3.1
screenshot_ex

Сохранить скриншот из архива

Параметры:

  • channel_name (string)
  • time_YYYYMMDD_HHMMSS (string)
  • screenshot_filename (string)
  • screenshot_folder (string)
  • make_thumb (integer)
≥3.2
show

Отобразить канал или шаблон на мониторе

Параметры:

  • channel_or_template (string)
  • monitor_n (integer)
≥3.1
show_archive

Показать архив канала на мониторе или в шаблоне

Параметры:

  • channel_name_or_guid (string)
  • monitor_n (integer)
  • start_time_YYYYMMDD_HHMMSS (string)
  • end_time_YYYYMMDD_HHMMSS (string)
≥3.1
show_channel

Отобразить канал на мониторе

Параметры:

  • channel_name (string)
  • monitor_n (integer)
≥3.1
show_html

Отобразить html-страницу

Параметры:

  • source (string)
  • url (string)
≥3.2
show_html_on_monitor

Отобразить html-страницу на мониторе

Параметры:

  • monitor_n (integer)
  • source (string)
  • url (string)
≥3.2
show_html_on_template

Отобразить html-страницу в шаблоне

Параметры:

  • monitor_n (integer)
  • template_name (string)
  • source (string)
  • url (string)
≥3.2
show_template

Отобразить шаблон на мониторе

Параметры:

  • template_name (string)
  • monitor_n (integer)
≥3.1
show_template_by_guid

Отобразить шаблон на мониторе

Параметры:

  • template_name (string)
  • monitor_n (integer)
≥3.1
update_active_monitor

Обновить активный монитор

Параметры:

  • csv_channels (string)
≥3.2

Методы для работы с системой "Орион Про"

Таблица 163.

Метод Описание методов и их параметров Версия ПО
refresh_device_list

Обновить список устройств.

 ≥3.1

См. также