Description of work methods with an objects of the server

TRASSIR objects which belong to one or another class are being used by a methods corresponding to the same class of objects.

To execute a method to an object it is necessary to implement a request of the following type:

        https://[address_server]:[port]/objects/[GUID_object]/[method]?[parameter_1]=[value_1]&[parameter_2]=[value_2]&sid=[id_session]

Key elements of the request:

  • [GUID_object] - guid of server object(see example Request for the TRASSIR object tree);
  • [method] - a method implemented to an object (list of methods implemented to a server objects below);
  • [parameter_x]=[value_x] - parameter and its value used by a method;
  • sid=[id_session] - id of a session in which request is being implemented (see example Get a session ID).

Methods of operation with channels

Table 106. 

Method Description of methods and their parameters TRASSIR
manual_record_start

Enable recording of channel archive.

 ≥3.1
manual_record_stop

Disable recording of channel archive.

 ≥3.1
ptz_position_query

Receive a position of PTZ-camera

 ≥3.2
ptz_preset

Switch PTZ-camera to preset

Parameter:

  • preset_n (integer)
≥3.1
record

Parameter:

  • turn_on_record (integer)
≥3.1
record_off

Disable manual recording of channel archive.

 ≥3.1
record_on

Enable manual recording of channel archive.

 ≥3.1
screenshot

Save screenshot

 ≥3.1
screenshot_ex

Save screenshot from an archive

Parameters:

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

Save screenshot from an archive

Parameters:

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

Add a text in a video

Parameters:

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

Operation methods with operator interface

Table 107. 

Method Description of methods and their parameters TRASSIR
archive_export

Export of main stream from channel archive

Parameters:

  • channel_name_or_guid (string)
  • start_time_YYYYMMDD_HHMMSS (string)
  • end_time_YYYYMMDD_HHMMSS (string)
  • filename (string)
  • archive_export
 ≥3.1
archive_export_ss

Export of substream from channel archive

Parameters:

  • channel_name_or_guid (string)
  • start_time_YYYYMMDD_HHMMSS (string)
  • end_time_YYYYMMDD_HHMMSS (string)
  • filename (string)
  • archive_export
 ≥3.2
archive_export

Open channel archive

Parameters:

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

Parameter:

  • csv_channels (string)
≥3.2
change_view_settings

Change form settings of camera window

Parameters:

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

Enable economic mode

Parameters:

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

Disable economic mode

Parameters:

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

Enable PTZ-camera control

Parameters:

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

Disable PTZ-camera control

Parameters:

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

Show monitor on top of all windows

Parameter:

  • monitor_n (integer)
≥3.2
screenshot

Save screenshot from an archive

Parameters:

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

Save screenshot from an archive

Parameters:

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

Display a channel or a template on monitor

Parameters:

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

Show channel archive on a monitor or in a template

Parameters:

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

Display a channel in a monitor

Parameters:

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

Display html-page

Parameters:

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

Display html-page on a monitor

Parameters:

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

Display html-page in a template

Parameters:

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

Display a template on a monitor

Parameters:

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

Display a template on a monitor

Parameters:

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

Update active monitor

Parameters:

  • csv_channels (string)
≥3.2

Operation methods with"Orion Pro" system

Table 108. 

Method Description of methods and their parameters TRASSIR
refresh_device_list

Update list of a devices.

 ≥3.1

See also