Description of channel settings

Request to get the settings:

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

Response:

{
    "name" : "channels",
    "type" : "ChannelsFolder",
    "subdirs" : [
        "CR0Mi1H1",
        "zXbI18iN",
        "zzBrx1ON"
    ],
    "values" : [
        "icon",
        "retail_analyt_licensed",
        "simt_licensed",
        "archive_bluring_head_available",
        "people_base_used",
        "lpr4_used",
        "hw_archive_use_limit",
        "hw_merge_license_total",
        "hw_merge_max_depth",
        "hw_archive_use_limit"
    ]
}

Table 148. 

subdirs Description TRASSIR
[GUID_channel] Channel GUID used to get the settings ≥3.1

Retrieve a value (R):

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

Table 149. 

values Description Type   TRASSIR
icon

Path to the icon:

:/settings/setup-channels.png

 string R ≥3.1
[module_name]_licensed Number of free licenses for plugin [plugin_name] integer R ≥3.1
[plugin_name]_total Total amount o licenses for the given plugin on channel integer R ≥4.0
[plugin_name]_used Plugin used on channel integer R ≥4.0
[plugin_name]_available Plugin available on channel integer R ≥4.0

Request for the channel settings:

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

Response:

{
    "name" : "CR0Mi1H1",
    "type" : "Channel",
    "subdirs" : [
        "arch_stats",
        "flags",
        "info",
        "stats",
        "optics",
        "ptz",
        "bags",
        "face_recognizer"
    ],
    "values" : [
        "archive_minimal_days",
        "archive_minimal_days_enable",
        "archive_storage_days_main",
        "archive_storage_days_sub",
        "archive_zombie_erase",
        "archive_zombie_flag",
        "aspect_ratio",
        "default_sound",
        "detectors_decoder",
        "detectors_source_stream",
        "dewarp_max_theta",
        "dyn_heatmap_duration",
        "enable_abandonment",
        "enable_anomaly",
        "enable_anomaly_train",
        "enable_aruco",
        "enable_bags",
        "enable_deep_people",
        "enable_face",
        "enable_facer",
        "enable_fire_smoke",
        "enable_floor",
        "enable_head",
        "enable_left_objects",
        "enable_lpr5",
        "enable_motion_search",
        "enable_people",
        "enable_sabotage",
        "enable_shelf",
        "enable_shelf_v2",
        "enable_slow_down",
        "enable_vizir",
        "enable_workplace",
        "erase_anomaly",
        "erase_aruco",
        "erase_bags",
        "erase_deep_people",
        "erase_face_recognizer",
        "erase_floor",
        "erase_head_zones",
        "erase_left_objects",
        "erase_lpr",
        "erase_lpr5",
        "erase_optics",
        "erase_people_zones",
        "erase_sabotage",
        "erase_shelf_zones",
        "erase_shelves",
        "erase_simt",
        "erase_workplace_zones",
        "fire_smoke_setup",
        "flip",
        "folder",
        "generate_motion_events",
        "generate_sound_events",
        "health_ignore",
        "hw_merge_dest_channel",
        "hw_merge_intervals",
        "hw_merge_mode",
        "hw_merge_start_ts",
        "icon",
        "jumper_setup",
        "label_setup",
        "lpr_enable",
        "lpr_hardware_enable",
        "merge_source_server",
        "name",
        "netrec_server_name",
        "offload_server_abandonment",
        "offload_server_aruco",
        "offload_server_bags",
        "offload_server_deep_people",
        "offload_server_lpr4",
        "offload_server_lpr5",
        "offload_server_sabotage",
        "offload_server_shelves",
        "offload_server_tracklet",
        "people_setup",
        "record_manual",
        "record_mode_local",
        "record_on_sound",
        "record_privileged",
        "record_script",
        "restrictions",
        "rotate",
        "save_md_figures_to_archive",
        "slow_down_setup",
        "software_md_enable",
        "software_md_setup",
        "software_sd_enable",
        "software_sd_threshold",
        "sounds_setup",
        "thumbnail",
        "use_hw_fd",
        "utc_offset_minutes",
        "watermark_text",
        "watermark_text_position",
        "watermark_time_position",
        "workplace_setup"
    ]
}

Table 150. 

subdirs Description TRASSIR
arch_stats Channel archive recording stats ≥4.0
flags Flags for the channel's current state ≥3.1
info Channel info ≥3.1
stats The channel's current statistics ≥3.1
optics Optics settings (for models with the support of this setting) ≥4.1
ptz PTZ settings (for PTZ cameras) ≥4.1
[plugin_name] Plugin settings ≥4.1

Retrieve a value (R):

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

Write a value (W):

https://[server_address]:[port]/settings/channels/[channel_GUID]/[setting]=[value]?sid=[session_id]

Table 151. 

values Description Type   TRASSIR
archive_minimal_days   integer RW 3.1-3.2
archive_minimal_days_enable   string RW 3.1-3.2
archive_storage_days_main   integer RW ≥4.0
archive_storage_days_sub   integer RW ≥4.0
archive_zombie_erase

Hide lost channel archive:

0 - no

1 - yes

integer RW ≥3.1
archive_zombie_flag

Display Hide lost channel archive button in the settings:

0 - no

1 - yes

integer RW ≥3.1
aspect_ratio Aspect ratio: [along_the_horizontal]:[along_the_vertical] string RW ≥3.1
default_sound Default sound string RW ≥4.1
detectors_decoder Software detectors string RW ≥4.0
detectors_source_stream

The stream being decompressed for the motion detector:

0 - Select automatically

1 - Primary stream

2 - Auxiliary stream (substream)

integer RW ≥3.1
dewarp_max_theta   real RW ≥4.0
dyn_heatmap_duration   string RW ≥3.2
enable_abandonment

Left object detector:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_anomaly   integer RW ≥4.0
enable_anomaly_train   integer RW ≥4.0
enable_aruco

ArUco detector:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_bags

Bags counter:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_deep_people

Neuro detector:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_face

Face detector:

0 - Disable

1 - Enable

integer RW ≥3.1
enable_facer

Face tracker/Recognizer:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_fire_smoke

Fire/smoke detector:

0 - Disable

1 - Enable

integer RW ≥3.1
enable_floor

Floor mapping:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_head

Head tracker:

0 - Disable

1 - Enable

integer RW ≥3.2
enable_left_objects

Left object detector:

0 - Disable

1 - Enable

integer RW ≥4.0
enable_lpr5

AutoTRASSIR (LPR5) license plate recognizer:

0 - Disable

1 - Enable

integer RW ≥4.1
enable_motion_search

ActiveSearch:

0 - Disable

1 - Enable

integer RW ≥3.1
enable_people

Queue detector:

0 - Disable

1 - Enable

integer RW ≥3.2
enable_sabotage

Sabotage detector:

0 - Disable

12 - Enable

13 - Enable shift detection

14 - Enable defocus detection

15 - Enable shift and defocus detection

integer RW ≥3.1
enable_shelf

Empty shelf detector:

0 - Disable

1 - Enable

integer RW ≥3.2
enable_shelf_v2

Neural empty shelf detector:

0 - Disable

1 - Enable

integer RW ≥4.1
enable_slow_down

Left object detector:

0 - Disable

1 - Enable

integer RW ≥3.1
enable_vizir   integer RW ≥4.1
enable_workplace

Workplace detector:

0 - Disable

1 - Enable

integer RW ≥3.3
erase_anomaly   integer RW ≥4.0
erase_aruco

Delete ArUco detector settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_bags

Delete bags counter settings:

0 - No

1 - Yes

integer RW ≥4.1
erase_deep_people

Delete neuro detector settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_face_recognizer

Delete face tracker/recognizer settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_floor

Delete floor mapping settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_head_zones

Delete head tracker zone settings:

0 - No

1 - Yes

integer RW ≥3.2
erase_left_objects

Delete left object detector settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_lpr

Delete AutoTRASSIR (LPR1/LPR3) license plate recognizer settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_lpr5

Delete AutoTRASSIR (LPR5) license plate recognizer settings:

0 - No

1 - Yes

integer RW ≥4.1
erase_optics

Delete optics settings:

0 - No

1 - Yes

integer RW ≥3.1
erase_people_zones

Delete queue detector settings:

0 - No

1 - Yes

integer RW ≥3.2
erase_sabotage

Delete sabotage detector settings:

0 - No

1 - Yes

integer RW ≥4.0
erase_shelf_zones

Delete empty shelf detector settings:

0 - No

1 - Yes

integer RW ≥3.2
erase_shelves

Delete neural empty shelf detector:

0 - No

1 - Yes

integer RW ≥4.0
erase_simt

Delete SIMT settings:

0 - No

1 - Yes

integer RW ≥3.1
erase_workplace_zones

Delete workplace detector settings:

0 - No

1 - Yes

integer RW ≥3.3
fire_smoke_setup Fire/smoke detector settings: integer RW ≥3.1
flip

Flip:

hmirror - Mirror vertically

vmirror - Mirror horizontal

empty string - No mirroring

string RW ≥3.1
folder The name of the group string RW ≥3.1
generate_motion_events

Generate events when motion is detected:

0 - No

1 - Yes

integer RW ≥3.1
generate_sound_events

Generate events when sound is detected:

0 - No

1 - Yes

integer RW ≥3.2
health_ignore   string RW ≥3.1
hw_merge_dest_channel   string RW ≥4.0
hw_merge_intervals   string RW ≥4.0
hw_merge_mode

Hardware archive merge is on:

0 - No

1 - Yes

integer RW ≥3.3
hw_merge_start_ts   string RW ≥4.0
icon

Path to the icon:

:/settings/camera.png

 string RW ≥3.1
jumper_setup

Configuring a teleport to a camera:

[X]:[Y]:[channel_GUID]_[server_GUID]

 string RW ≥3.2
label_setup Label settings string RW ≥4.0
lpr_enable

AutoTRASSIR (LPR1/LPR3) license plate recognizer settings

0 - Disable

1 - Enable

integer RW ≥3.1
lpr_hardware_enable

Hardware license plate recognizer

0 - Disable

1 - Enable

integer RW ≥3.2
merge_source_server   integer RW ≥4.0
name The name of the channel string RW ≥3.1
netrec_server_name Network channel recording server name string RW ≥3.1
offload_server_abandonment Left object detector analytics server string RW ≥4.0
offload_server_aruco ArUco detector analytics server string RW ≥4.0
offload_server_bags Bags counter analytics server string RW ≥4.1
offload_server_deep_people Neuro detector analytics server string RW ≥4.0
offload_server_lpr4 License plate recognizer (LPR4) analytics server string RW ≥4.0
offload_server_lpr5 (LPR5) license plate recognizer module server string RW ≥4.1
offload_server_sabotage Sabotage detector analytics server string RW ≥4.0
offload_server_shelves Neural empty shelf detector analytics server string RW ≥4.1
offload_server_tracklet   string RW ≥4.1
people_setup Neuro detector settings string RW ≥3.2
record_manual

Manual recording:

0 - Disable

1 - Enable

integer RW ≥3.1
record_mode_local

Archive recording:

0 - Disable

1 - Continuous

2 - Manual recording

3 - On detector

integer RW ≥3.1
record_on_sound

Record on Sound

0 - Disable

1 - Enable

integer RW ≥3.2
record_privileged

0 - Ordinary channel

1 - Privileged channel

integer RW ≥3.1
record_script   integer RW ≥3.1
restrictions Channel restrictions string RW ≥4.0
rotate

Rotate:

empty string - No rotation

rotate90 - 90 degrees

rotate180 - 180 degrees

rotate270 - 270 degrees

string RW ≥3.1
save_md_figures_to_archive

Save objects recognized by motion detector to the archive

0 - no

1 - yes

integer RW ≥4.0
slow_down_setup Slowdown detector settings string RW ≥3.1
software_md_enable

Motion detector:

0 - Disable

1 - Enable activity detector

2 - Enable moving objects detector (SIMT)

3 - Enable hardware detector

11 - Enable activity detector HD

integer RW ≥3.1
software_md_setup Motion detector settings string RW ≥3.1
software_sd_enable

Sound detector:

0 - Disable

1048576 - Any sound

integer RW ≥3.2
software_sd_threshold

Sound detector trigger threshold:

from 0 to 100

 integer RW ≥3.2
sounds_setup Sound settings string RW ≥4.1
thumbnail Video preview string R ≥3.1
use_hw_fd   integer RW ≥4.1
utc_offset_minutes   string RW ≥4.0
watermark_text Text on video string RW ≥3.1
watermark_text_position

Location of text on video:

0 - Do not display

1 - Left upper corner

2 - Right upper corner

3 - Bottom left corner

4 - Bottom right corner

integer RW ≥3.1
watermark_time_position

Date and time location on video:

0 - Do not display

1 - Left upper corner

2 - Right upper corner

3 - Bottom left corner

4 - Bottom right corner

integer RW ≥3.1
workplace_setup Workplace detector settings string RW ≥3.3

Request for getting channel archive record statistics:

https://[server_address]:[port]/settings/channels/[channel_GUID]/arch_stats/?sid=[session_id]

Response:

{
    "name" : "arch_stats",
    "type" : "ChannelArchiveStats",
    "subdirs" : [

    ],
    "values" : [
        "archive_stat_data",
        "forecast_gb_per_day",
        "gb_per_day",
        "gb_per_day_reliable",
        "gb_per_week",
        "gb_per_week_reliable",
        "mainstream_depth",
        "second_stream_days_presented",
        "second_stream_gb_per_day",
        "second_stream_gb_per_week",
        "second_stream_hours_presented",
        "substream_depth",
        "update_time"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/channels/[channel_GUID]/arch_stats/[setting]?sid=[session_id]

Table 152. 

values Description Type   TRASSIR
archive_stat_data Channel archive recording data string R ≥4.0
forecast_gb_per_day Estimated archive depth per day, GB real R ≥4.0
gb_per_day Storage depth, GB real R ≥4.0
gb_per_day_reliable   integer R ≥4.0
gb_per_week Estimated archive depth per seven days, GB integer R ≥4.0
gb_per_week_reliable   integer R ≥4.0
mainstream_depth Mainstream depth, days real R ≥4.0
second_stream_days_presented   integer R ≥4.0
second_stream_gb_per_day   real R ≥4.0
second_stream_gb_per_week   real R ≥4.0
second_stream_hours_presented   integer R ≥4.0
substream_depth Substream depth, days real R ≥4.0
update_time   string R ≥4.0

Request for the channel's state flags:

https://[server_address]:[port]/settings/channels/[channel_GUID]/flags/?sid=[session_id]

Response:

{
    "name" : "flags",
    "type" : "ChannelFlags",
    "subdirs" : [

    ],
    "values" : [
        "abrmobj",
        "activity",
        "allow_dynamic_dewarp",
        "appearing",
        "aruco_detection",
        "audio_detect",
        "bag_detection",
        "bitrate_exceeded",
        "crossline",
        "direction",
        "entering",
        "exiting",
        "face",
        "fastmove",
        "fire",
        "gathering",
        "glassbreak",
        "gunshot",
        "hw_archive",
        "intrusion",
        "item_abandoned",
        "item_missing",
        "loitering",
        "lpr_detection",
        "motion",
        "motion_like_activity",
        "passing",
        "people",
        "presence",
        "recording_hw",
        "recording_local",
        "sabotage",
        "scream",
        "shelf_detection",
        "signal",
        "slow_down",
        "smoke",
        "sound",
        "speed",
        "stop",
        "thermal_signal",
        "voice"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/channels/[channel_GUID]/flags/[setting]?sid=[session_id]

Table 153. 

values Description Type   TRASSIR
abrmobj

Left object detector:

0 - Disable

1 - Enable

integer R ≥4.0
activity   integer R ≥3.3
allow_dynamic_dewarp   integer R ≥4.0
appearing   integer R ≥4.0
aruco_detection

ArUco detector:

0 - Disable

1 - Enable

integer R ≥4.1
audio_detect

Sound detector:

0 - Off

1 - On

integer R ≥4.1
bag_detection

Bags counter:

0 - Off

1 - On

integer R ≥4.1
bitrate_exceeded

Bitrate exceeded:

0 - Yes

1 - No

integer R ≥4.0
crossline

Border crossed:

0 - Yes

1 - No

integer R ≥3.3
direction

Motion in the preset direction:

0 - Yes

1 - No

integer R ≥4.0
entering

Zone intrusion:

0 - Yes

1 - No

integer R ≥4.0
exiting

Exiting zone:

0 - Yes

1 - No

integer R ≥4.0
explosion   integer R ≥4.1
face

Face in a frame:

0 - No

1 - Yes

integer R ≥3.1
fastmove   integer R ≥4.1
fire

Fire in a frame:

0 - No

1 - Yes

integer R ≥3.1
gathering   integer R ≥4.1
glassbreak   integer R ≥4.1
gunshot   integer R ≥4.1
hw_archive   integer R ≥3.1
intrusion

Zone intrusion captured:

0 - No

1 - Yes

integer R ≥3.2
item_abandoned

Abandoned item in a frame:

0 - No

1 - Yes

integer R ≥3.2
item_missing

Item disappeared from the frame:

0 - No

1 - Yes

integer R ≥3.2
loitering   integer R ≥4.1
lpr_detection

License plate recognized:

0 - No

1 - Yes

integer R ≥4.1
motion

Motion in a frame:

0 - No

1 - Yes

integer R ≥3.1
motion_like_activity   integer R ≥4.1
passing   integer R ≥4.0
people

Person in a frame:

0 - No

1 - Yes

integer R ≥3.2
presence   integer R ≥4.0
recording_hw

Archive recording to device:

0 - Off

1 - On

integer R ≥3.1
recording_local

Archive recoding to server disks:

0 - Off

1 - On

integer R ≥3.1
sabotage

Sabotage detector enabled:

0 - No

1 - Yes

integer R ≥3.1
scream   integer R ≥4.1
shelf_detection

Empty shelf detector enabled:

0 - No

1 - Yes

integer R ≥4.1
signal

Signal on:

0 - No

1 - Yes

integer R ≥3.1
slow_down

Left object detector enabled:

0 - No

1 - Yes

integer R ≥3.1
smoke

Smoke detected in a frame:

0 - No

1 - Yes

integer R ≥3.1
sound

Sound detected:

0 - No

1 - Yes

integer R ≥3.2
speed   integer R ≥4.0
stop   integer R ≥4.0
thermal_signal   integer R ≥4.0
voice

Voice in a frame:

0 - No

1 - Yes

integer R ≥3.2

Request for information about a channel:

https://[server_address]:[port]/settings/channels/[channel_GUID]/info/?sid=[session_id]

Response:

{
    "name" : "info",
    "type" : "ChannelInfo",
    "subdirs" : [

    ],
    "values" : [
        "abandonment_status",
        "address_audio_main",
        "address_audio_raw",
        "address_audio_ss",
        "address_figures_detector",
        "address_figures_subtitles",
        "address_video_main",
        "address_video_raw",
        "address_video_ss",
        "addrflags",
        "aruco_status",
        "bags_status",
        "deep_people_status",
        "economy_mode",
        "grabber_channel_n",
        "grabber_error",
        "grabber_path",
        "lpr4_status",
        "lpr5_status",
        "merge_too_slow",
        "sabotage_status",
        "shelves_status",
        "tracklet_status"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/channels/[channel_GUID]/info/[setting]?sid=[session_id]

Table 154. 

values Description Type   TRASSIR
abandonment_status

Left object detector:

0 - Disable

1 - Enable

integer R ≥4.0
address_audio_main   string R ≥3.1
address_audio_raw   string R ≥3.1
address_audio_ss   string R ≥3.1
address_figures_detector   string R ≥3.1
address_figures_subtitles   string R ≥3.1
address_video_main   string R ≥3.1
address_video_raw   string R ≥3.1
address_video_ss   string R ≥3.1
addrflags   string R ≥3.1
bags_status

Bags counter:

0 - Disable

1 - Enable

integer R ≥4.1
deep_people_status

Neuro detector:

0 - Disable

1 - Enable

integer R ≥4.0
economy_mode

Economy mode:

0 - Disable

1 - Enable

integer R ≥3.1
grabber_channel_n Number of channels, available in driver string R ≥3.1
grabber_error Device driver error string R ≥4.0
grabber_path Device driver path string R ≥3.1
lpr4_status

AutoTRASSIR license plate recognizer (LPR4):

0 - Disable

1 - Enable

integer R ≥4.0
lpr5_status

AutoTRASSIR (LPR5) license plate recognizer:

0 - Disable

1 - Enable

integer R ≥4.1
merge_too_slow

Error - Slow synchronization:

0 - No

1 - Yes

integer R ≥4.0
sabotage_status

Sabotage detector:

0 - Disable

1 - Enable

integer R ≥4.0
shelves_status

Neural empty shelf detector:

0 - Disable

1 - Enable

integer R ≥4.1
tracklet_status   integer R ≥4.1

Request for the channel's current statistics:

https://[server_address]:[port]/settings/channels/[channel_GUID]/stats/?sid=[session_id]

Response:

{
    "name" : "stats",
    "type" : "ChannelStats",
    "subdirs" : [

    ],
    "values" : [
        "debt_sec_hw_merge",
        "fps_main",
        "fps_ss",
        "kbps_hw_merge",
        "kbps_main",
        "kbps_ss",
        "last_error_hw_merge"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/channels/[channel_GUID]/stats/[setting]?sid=[session_id]

Table 155. 

values Description Type   TRASSIR
debt_sec_hw_merge Storage depth real R ≥4.0
fps_main Mainstream FPS real R ≥3.1
fps_ss Sub stream FPS real R ≥3.1
kbps_hw_merge Synchronization speed with the device archive real R ≥4.0
kbps_main Mainstream bitrate real R ≥3.1
kbps_ss Sub stream bitrate real R ≥3.1
last_error_hw_merge Last merge error with the device archive string R ≥4.0

See also