Description of IP device settings

Request to get the settings:

https://[server_address]:[port]/settings/ip_cameras/?sid=[session_id]

Response:

{
    "name" : "ip_cameras",
    "type" : "IpCamerasFolder",
    "subdirs" : [
        "ip_camera_add",
        "AOig495k",
        "DSIbCqzj",
        "wQGQa0Vc"
    ],
    "values" : [
        "grabber_delete",
        "hw_analytics_available",
        "more_channels_licensed",
        "sw_dewarp_available"
    ]
}

Table 137. 

subdirs Description TRASSIR
ip_camera_add Connection of a new IP device ≥3.1
[camera_GUID] Connected device GUID ≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/ip_cameras/[setting]?sid=[session_id]

Table 138. 

values Description Type   TRASSIR
grabber_delete Request for device removal string W ≥3.1
hw_analytics_available   integer R ≥4.1
more_channels_licensed Total amount of licenses for adding IP devices integer R ≥3.1
sw_dewarp_available Device supports software dewarp integer R ≥4.0

Request to get the settings:

https://[server_address]:[port]/settings/ip_cameras/ip_camera_add/?sid=[session_id]

Response:

{
    "name" : "ip_camera_add",
    "type" : "GrabberAddStep1",
    "subdirs" : [
        "3S",
        "ACTi",
        "AVTech",
        "ActiveCam",
        "Axis",
        "Dahua",
        "Hikvision",
        "TRASSIR",
        "Vivotek",
        "Zavio",
        "File",
        "MJPEG",
        "ONVIF",
        "RTSP"
    ],
    "values" : [
        "families"
    ]
}

Table 139. 

subdirs Description TRASSIR
[manufacturer_name] IP device manufacturer name ≥3.1
File Connected video files settings ≥3.1
ONVIF ONVIF IP devices settings ≥3.1
RTSP Settings of IP devices, connected via RTSP protocol ≥3.1
MJPEG Settings for IP devices connected via RTSP and streamed in MJPEG format ≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/ip_cameras/[setting]?sid=[session_id]

Table 140. 

values Description Type   TRASSIR
families List of all IP device manufacturers, supported by TRASSIR string R ≥3.1

Request to get the settings:

https://[server_address]:[port]/settings/ip_cameras/ip_camera_add/[manufacturer_name]/?sid=[session_id]

Response:

{
    "name" : "ActiveCam",
    "type" : "GrabberAddStep2",
    "subdirs" : [

    ],
    "values" : [
        "allocated_guid",
        "autodetect_result",
        "autodetect_status",
        "available_models",
        "create_address",
        "create_defaults",
        "create_disabled",
        "create_economy_mode",
        "create_model",
        "create_now",
        "create_password",
        "create_port",
        "create_username",
        "discovery_result",
        "discovery_start",
        "discovery_supported",
        "discovery_update_result",
        "enable_economy_mode",
        "initial_password",
        "initial_port",
        "initial_username",
        "license_allocation_error",
        "license_allocation_state",
        "load_dll",
        "load_dll_error",
        "model_detect_start",
        "model_detect_stop"

    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/ip_cameras/ip_camera_add/[manufacturer_name]/[setting]?sid=[session_id]

Table 141. 

values Description Type   TRASSIR
allocated_guid   string R ≥3.1
autodetect_result Autodetection result string RW ≥3.2
autodetect_status Autodetection status string RW ≥3.2
available_models List of ID device models, found online and available for adding string R ≥3.1
create_address Set IP address string W ≥3.1
create_defaults Add device with default settings string W ≥4.0
create_disabled Add and shut down device integer RW ≥4.0
create_economy_mode Add device and set the Economy mode flag. integer RW ≥3.1
create_model Add a particular model of device string RW ≥3.1
create_now Create connection integer RW ≥3.1
create_password Set password string W ≥3.1
create_port Set port integer W ≥3.1
create_username Set username string R ≥3.1
discovery_result Search result string R ≥3.1
discovery_start Start search integer RW ≥3.1
discovery_supported

Device supports online detection:

0 - no, 1 - yes

integer R ≥3.1
discovery_update_result   integer RW ≥3.1
enable_economy_mode

Economy mode on the device:

0 -disabled, 1 - enabled

integer R ≥3.2
initial_password Default password string R ≥3.1
initial_port Default port integer R ≥3.1
initial_username Default username string R ≥3.1
license_allocation_error   string RW ≥4.0
license_allocation_state   string RW ≥4.0
load_dll   integer W ≥3.1
load_dll_error   string R ≥3.1
model_detect_start Start model search integer R ≥3.1
model_detect_stop Stop model search integer R ≥3.1

Request to get the settings:

https://[server_address]:[port]/settings/ip_cameras/[camera_GUID]/?sid=[session_id]

Response:

{
    "name" : "AOig495k",
    "type" : "Grabber",
    "subdirs" : [
        "bz_caps",
        "caps",
        "feedback",
        "gpio",
        "md_caps",
        "roi_caps",
        "sd_caps"

    ],
    "values" : [
        "autodetect",
        "channel00_analytics_setup",
        "channel00_audio_bitrate",
        "channel00_audio_codec",
        "channel00_audio_default",
        "channel00_audio_enabled",
        "channel00_audio_sample_rate",
        "channel00_bright_default",
        "channel00_brightness",
        "channel00_bz_setup",
        "channel00_camera_matrix",
        "channel00_codec",
        "channel00_color",
        "channel00_compression",
        "channel00_contrast",
        "channel00_deinterlace",
        "channel00_distortion_coeff",
        "channel00_distortion_model",
        "channel00_ext_audio_bitrate",
        "channel00_ext_audio_enabled",
        "channel00_ext_color",
        "channel00_ext_compression",
        "channel00_ext_enabled",
        "channel00_ext_fps",
        "channel00_ext_gop",
        "channel00_ext_resolution",
        "channel00_ext_video_bitrate",
        "channel00_ext_video_bitrate_restriction",
        "channel00_ext_video_bitrate_type",
        "channel00_extcal_points",
        "channel00_fps",
        "channel00_gop",
        "channel00_guid",
        "channel00_hue",
        "channel00_interval_capture_msec",
        "channel00_main_enabled",
        "channel00_md_enable",
        "channel00_md_setup",
        "channel00_mds_setup",
        "channel00_mic_gain",
        "channel00_output_mic_volume",
        "channel00_record_mode_hardware",
        "channel00_resolution",
        "channel00_roi_setup",
        "channel00_saturation",
        "channel00_sd_enable",
        "channel00_sd_sample_mult",
        "channel00_sd_threshold",
        "channel00_video_bitrate",
        "channel00_video_bitrate_restriction",
        "channel00_video_bitrate_type",
        "channels_enabled",
        "channels_hardware_dewarp",
        "connection_ip",
        "connection_password",
        "connection_port",
        "connection_username",
        "created_manually",
        "economy_mode",
        "economy_mode_heart_beat_seconds",
        "economy_mode_use_md",
        "extra_flags",
        "family",
        "firmware_file_path",
        "folder",
        "force_software_dewarp",
        "grabber_enabled",
        "grabber_private_data",
        "gui_parameters",
        "have_working_hdd",
        "hw_analytics_licensed_channels",
        "icon",
        "iframe_md",
        "input00_enable",
        "input00_folder",
        "input00_guid",
        "input00_name",
        "input00_normal",
        "license_mode",
        "model",
        "model_missmatch_off",
        "name",
        "output00_enable",
        "output00_folder",
        "output00_guid",
        "output00_name",
        "output00_startup",
        "ptz_associated_with",
        "reboot",
        "setup_enabled",
        "setup_password",
        "sw_dewarp_enabled",
        "synchronize_time",
        "tube_version",
        "utc_offset_minutes",
        "video_buffer_size",
        "web_page"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/ip_cameras/[camera_GUID]/[setting]?sid=[session_id]

Table 142. 

values Description Type   TRASSIR
autodetect   string R ≥3.2
channel[XX]_audio_bitrate Audio bitrate integer RW ≥3.1
channel[XX]_audio_codec Audio codec string RW ≥3.1
channel[XX]_audio_default Default audio settings integer RW ≥3.2
channel[XX]_audio_default Sound on integer RW ≥3.1
channel[XX]_audio_sample_rate Sampling frequency string RW ≥4.0
channel[XX]_bright_default Default brightness integer RW ≥3.1
channel[XX]_brightness Brightness integer RW ≥3.1
channel[XX]_bz_setup   string RW ≥3.1
channel[XX]_camera_matrix   string RW ≥4.0
channel[XX]_codec Video codec string RW ≥3.1
channel[XX]_color Color integer RW ≥3.1
channel[XX]_compression Compression integer RW ≥3.1
channel[XX]_contrast Contrast integer RW ≥3.1
channel[XX]_deinterlace   integer RW ≥3.1
channel[XX]_distortion_coeff   string RW ≥4.0
channel[XX]_distortion_model   string RW ≥4.0
channel[XX]_ext_audio_bitrate   integer RW ≥3.1
channel[XX]_ext_audio_enabled

Substream sound is on:

0 - no, 1 - yes

integer RW ≥3.1
channel[XX]_ext_color Substream color integer RW ≥3.1
channel[XX]_ext_compression Substream compression integer RW ≥3.1
channel[XX]_ext_enabled

Channel substream is on:

0 - no, 1 - yes

integer RW ≥3.1
channel[XX]_ext_fps Substream FPS integer RW ≥3.1
channel[XX]_ext_gop Substream GOP integer RW ≥3.1
channel[XX]_ext_resolution Substream resolution string RW ≥3.1
channel[XX]_ext_video_bitrate Substream video bitrate string RW ≥3.1
channel[XX]_ext_video_bitrate_restriction   integer RW ≥4.0
channel[XX]_ext_video_bitrate_type Substream bitrate type integer RW ≥3.1
channel[XX]_extcal_points   integer RW ≥4.0
channel[XX]_fps FPS integer RW ≥3.1
channel[XX]_gop GOP integer RW ≥3.1
channel[XX]_guid Channel ID on device string RW ≥3.1
channel[XX]_hue   integer RW ≥3.1
channel[XX]_interval_capture_msec   integer RW ≥4.0
channel[XX]_main_enabled

Channel main stream is on:

0 - no, 1 - yes

integer RW ≥3.1
channel[XX]_mapping_rvec   integer RW ≥4.0
channel[XX]_mapping_tvec   integer RW ≥4.0
channel[XX]_md_enable

Channel motion detector is enabled:

0 - no, 1 - yes

integer RW ≥3.1
channel[XX]_md_setup Motion detector settings string RW ≥3.1
channel[XX]_mds_setup   string RW ≥3.2
channel[XX]_mic_gain   integer RW ≥3.2
channel[XX]_mic_volume   integer RW ≥3.2
channel[XX]_output_mic_volume   integer RW ≥3.2
channel[XX]_record_mode_hardware   integer RW ≥3.1
channel[XX]_resolution Resolution string RW ≥3.1
channel[XX]_roi_setup ROI Settings string RW ≥3.2
channel[XX]_saturation   integer RW ≥3.1
channel[XX]_sd_enable   integer RW ≥4.0
channel[XX]_sd_sample_mult   integer RW ≥4.0
channel[XX]_sd_threshold   integer RW ≥4.0
channel[XX]_video_bitrate   integer RW ≥3.1
channel[XX]_video_bitrate_restriction   integer RW ≥4.0
channel[XX]_video_bitrate_type   integer RW ≥3.1
channels_enabled

The IP device is enabled:

0 - no, 1 - yes

integer R ≥3.1
channels_hardware_dewarp Hardware image dewarp integer R ≥3.1
connection_ip The IP address of the connected device string RW ≥3.1
connection_password User password string W ≥3.1
connection_port The device's connection port integer RW ≥3.1
connection_username The username string RW ≥3.1
created_manually

Added manually:

0 - no, 1 - yes

integer R ≥4.1
economy_mode

Economy mode is on:

0 - no, 1 - yes

integer RW ≥3.1
economy_mode_heart_beat_seconds Maximum time in seconds that TRASSIR will wait for a response from an IP device integer RW ≥3.1
economy_mode_use_md   integer RW ≥3.1
extra_flags   integer RW ≥3.2
family The IP device's manufacturer string R ≥3.1
firmware_file_path Device firmware path string RW ≥4.0
folder   string RW ≥3.1
force_software_dewarp   integer RW ≥4.0
grabber_enabled

Enable the IP device:

0 - no, 1 - yes

integer RW ≥3.1
grabber_private_data   string R ≥4.0
gui_parameters   string RW ≥4.0
have_working_hdd

HDD:

-1 - are not supported, 0 - are missing, 1 - operate properly

integer R ≥3.1
hw_analytics_licensed_channels   integer RW ≥4.0
icon

The IP device's icon:

:/settings/grabber.png - Device is enabled

:/settings/grabber-disabled.png - Device is disabled

string R ≥3.1
iframe_md   integer RW ≥3.2
input[YY]_enable

Use input:

0 - no, 1 - yes

integer RW ≥3.1
input[YY]_folder   string RW ≥3.1
input[YY]_guid Input ID string RW ≥3.1
input[YY]_name Input name string RW ≥3.1
input[YY]_normal

Normal state:

0 - unlocked 1 - locked

integer RW ≥3.1
license_mode   string RW ≥4.1
model The IP device's model string R ≥3.1
model_missmatch_off

Disable "Model mismatch" mistake in IP device settings

0 - no, 1 - yes

integer RW ≥4.0
name The name of the IP device string RW ≥3.1
output[ZZ]_enable

Use output:

0 - no, 1 - yes

integer RW ≥3.1
output[ZZ]_folder   string RW ≥3.1
output[ZZ]_guid Output ID string RW ≥3.1
output[ZZ]_name Output name string RW ≥3.1
output[ZZ]_startup

On system start:

0 - disabled on start, 1 - enabled on start 2 - save state

integer RW ≥3.1
ptz_associated_with

Associated PTZ channel:

0 - do not use

integer RW ≥3.1
reboot

Reload IP device:

1 - yes

integer W ≥3.1
setup_enabled

Setting enabled:

0 - no, 1 - yes

integer RW ≥4.1
setup_password   integer W ≥4.0
sw_dewarp_enabled

Software image dewarp is enabled on the device channel:

0 - no, 1 - yes

integer RW ≥4.0
synchronize_time

Synchronize time on IP device:

1 - yes

integer RW ≥3.1
tube_version   integer R ≥4.0
utc_offset_minutes   string RW ≥4.0
video_buffer_size   integer RW ≥3.1
web_page A link to the IP device's web interface string R ≥3.1

where

  • [XX] is the serial number of the channel being configured (from 00 to 15), depending on the model of the compression card;
  • [YY] is the serial number of the input being configured (from 00 to 15), depending on the model of the compression card;
  • [ZZ] is the serial number of the output being configured (from 00 to 15), depending on the model of the compression card.

See also