Description of compression card settings

Request to get the compression card settings:

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

Response:

{
    "name" : "boards",
    "type" : "BoardsFolder",
    "subdirs" : [
        "DVS_board0",
        "DVS_board1"
    ],
    "values" : [

    ]
}

Table 130.

subdirs	Description	TRASSIR
DVS_board[X]	The name of the microprocessor belonging to the compression card processing the signal from the camera, where [X] is the serial number of the compression card's microprocessor.	≥3.1

subdirs

Description

TRASSIR

DVS_board[X]

The name of the microprocessor belonging to the compression card processing the signal from the camera,

where

[X] is the serial number of the compression card's microprocessor.

≥3.1

Request to get the compression card's microprocessor settings:

https://[server_address]:[port]/settings/boards/DVS_board[X]/?sid=[session_id]

Response:

{
    "name" : "DVS_board0",
    "type" : "Grabber",
    "subdirs" : [
        "bz_caps",
        "caps",
        "feedback",
        "md_caps"
    ],
    "values" : [
        "channel00_audio_bitrate",
        "channel00_audio_codec",
        "channel00_audio_default",
        "channel00_audio_enabled",
        "channel00_bright_default",
        "channel00_brightness",
        "channel00_bz_setup",
        "channel00_codec",
        "channel00_color",
        "channel00_compression",
        "channel00_contrast",
        "channel00_deinterlace",
        "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_type",
        "channel00_fps",
        "channel00_gop",
        "channel00_guid",
        "channel00_hue",
        "channel00_main_enabled",
        "channel00_md_enable",
        "channel00_md_setup",
        "channel00_mic_gain",
        "channel00_mic_volume",
        "channel00_record_mode_hardware",
        "channel00_resolution",
        "channel00_saturation",
        "channel00_video_bitrate",
        "channel00_video_bitrate_type",
        "channels_enabled",
        "connection_ip",
        "connection_password",
        "connection_port",
        "connection_username",
        "economy_mode",
        "economy_mode_heart_beat_seconds",
        "economy_mode_use_md",
        "family",
        "folder",
        "grabber_enabled",
        "have_working_hdd",
        "icon",
        "input00_enable",
        "input00_folder",
        "input00_guid",
        "input00_name",
        "input00_normal",
        "model",
        "name",
        "output00_enable",
        "output00_folder",
        "output00_guid",
        "output00_name",
        "output00_startup",
        "ptz_associated_with",
        "reboot",
        "synchronize_time",
        "video_buffer_size",
        "web_page"
    ]
}

Table 131.

subdirs	Description	TRASSIR
bz_caps		≥3.1
caps		≥3.1
feedback		≥3.1
md_caps		≥3.1

Retrieve a value (R):

https://[server_address]:[port]/settings/boards/DVS_board[X]/[setting]?sid=[session_id]

Write a value (W):

https://[server_address]:[port]/settings/boards/DVS_board[X]/[setting]=[value]?sid=[session_id]

Table 132.

values	Description	Type	TRASSIR
channel[XX]_audio_bitrate			≥3.1
channel[XX]_audio_codec			≥3.1
channel[XX]_audio_default			≥3.2
channel[XX]_audio_enabled			≥3.1
channel[XX]_bright_default			≥3.1
channel[XX]_brightness			≥3.1
channel[XX]_bz_setup			≥3.1
channel[XX]_codec			≥3.1
channel[XX]_color			≥3.1
channel[XX]_compression			≥3.1
channel[XX]_contrast			≥3.1
channel[XX]_deinterlace			≥3.1
channel[XX]_ext_audio_bitrate			≥3.1
channel[XX]_ext_audio_enabled			≥3.1
channel[XX]_ext_color			≥3.1
channel[XX]_ext_compression			≥3.1
channel[XX]_ext_enabled			≥3.1
channel[XX]_ext_fps			≥3.1
channel[XX]_ext_gop			≥3.1
channel[XX]_ext_resolution			≥3.1
channel[XX]_ext_video_bitrate			≥3.1
channel[XX]_ext_video_bitrate_type			≥3.1
channel[XX]_fps			≥3.1
channel[XX]_gop			≥3.1
channel[XX]_guid			≥3.1
channel[XX]_hue			≥3.1
channel[XX]_main_enabled			≥3.1
channel[XX]_md_enable			≥3.1
channel[XX]_md_setup			≥3.1
channel[XX]_mic_gain			≥3.2
channel[XX]_mic_volume			≥3.2
channel[XX]_record_mode_hardware			≥3.1
channel[XX]_resolution			≥3.1
channel[XX]_saturation			≥3.1
channel[XX]_video_bitrate			≥3.1
channel[XX]_video_bitrate_type			≥3.1
channels_enabled			≥3.1
connection_ip			≥3.1
connection_password			≥3.1
connection_port			≥3.1
connection_username			≥3.1
economy_mode			≥3.1
economy_mode_heart_beat_seconds			≥3.1
economy_mode_use_md			≥3.1
family			≥3.1
folder			≥3.1
grabber_enabled			≥3.1
have_working_hdd			≥3.1
icon	Path to the icon:		≥3.1
input[YY]_enable			≥3.1
input[YY]_folder			≥3.1
input[YY]_guid			≥3.1
input[YY]_name			≥3.1
input[YY]_normal			≥3.1
model			≥3.1
name		string	≥3.1
output[ZZ]_enable			≥3.1
output[ZZ]_folder			≥3.1
output[ZZ]_guid			≥3.1
output[ZZ]_name			≥3.1
output[ZZ]_startup			≥3.1
ptz_associated_with			≥3.1
reboot			≥3.1
synchronize_time			≥3.1
video_buffer_size			≥3.1
web_page			≥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.

Request for black zone capabilities:

https://[server_address]:[port]/settings/boards/DVS_board[X]/bz_caps/?sid=[session_id]

Response:

{
    "name" : "bz_caps",
    "type" : "ZoneCaps",
    "subdirs" : [

    ],
    "values" : [
        "capabilities"
        "default_setup_string",
        "grid_h",
        "grid_w",
        "maximum_rects_count",
        "maximum_zones_count",
        "parameter_name1",
        "parameter_name2",
        "parameter_name3",
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/boards/DVS_board[X]/bz_caps/[setting]?sid=[session_id]

Table 133.

values	Description	Type		TRASSIR
capabilities		integer	R	≥3.1
default_setup_string		string	R	≥3.1
grid_h		integer	R	≥3.1
grid_w		integer	R	≥3.1
maximum_rects_count		integer	R	≥3.1
maximum_zones_count		integer	R	≥3.1
parameter_name[X]	where [X] is the parameter's serial number (from 1 to 3)	string	R	≥3.1

Request for compression card capabilities:

https://[server_address]:[port]/settings/boards/DVS_board[X]/caps/?sid=[session_id]

Response:

{
    "name" : "caps",
    "type" : "GrabberCaps",
    "subdirs" : [

    ],
    "values" : [
        "audio_capabilities",
        "audio_channel_count",
        "audio_codecs",
        "audio_sample_rates",
        "defaults",
        "gpio_input_count",
        "gpio_output_count",
        "grabber_capabilities",
        "presets",
        "video_capabilities",
        "video_channel_count",
        "video_codecs",
        "video_main_bitrate_max"
        "video_main_bitrate_min",
        "video_resolution_default",
        "video_resolution_ext_default",
        "video_resolutions",
        "video_resolutions_ext",
        "video_sub_bitrate_max",
        "video_sub_bitrate_min"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/boards/DVS_board[X]/caps/[setting]?sid=[session_id]

Table 134.

values	Type		TRASSIR
audio_capabilities	integer	R	≥3.1
audio_channel_count	integer	R	≥3.1
audio_codecs	string	R	≥3.1
audio_sample_rates	string	R	≥3.1
video_sub_bitrate_min	string	R	≥3.1
gpio_input_count	integer	R	≥3.1
gpio_output_count	integer	R	≥3.1
grabber_capabilities	integer	R	≥3.1
presets	string	R	≥3.1
video_capabilities	integer	R	≥3.1
video_channel_count	integer	R	≥3.1
video_codecs	string	R	≥3.1
video_main_bitrate_max	integer	R	≥3.1
video_main_bitrate_min	integer	R	≥3.1
video_resolution_default	string	R	≥3.1
video_resolution_ext_default	string	R	≥3.1
video_resolutions	string	R	≥3.1
video_resolutions_ext	string	R	≥3.1
video_sub_bitrate_max	integer	R	≥3.1
video_sub_bitrate_min	integer	R	≥3.1

Request to get a response:

https://[server_address]:[port]/settings/boards/DVS_board[X]/feedback/?sid=[session_id]

Response:

{
    "name" : "feedback",
    "type" : "GrabberFeedback",
    "subdirs" : [

    ],
    "values" : [
        "any_error",
        "last_error_message",
        "state"
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/boards/DVS_board[X]/feedback/[setting]?sid=[session_id]

Table 135.

values	Description	Type		TRASSIR
any_error	0 - No errors	integer	R	≥3.1
last_error_message		string	R	≥3.1
state		integer	R	≥3.1

Request for motion detector capabilities:

https://[server_address]:[port]/settings/boards/DVS_board[X]/md_caps/?sid=[session_id]

Response:

{
    "name" : "md_caps",
    "type" : "ZoneCaps",
    "subdirs" : [

    ],
    "values" : [
        "capabilities"
        "default_setup_string",
        "grid_h",
        "grid_w",
        "maximum_rects_count",
        "maximum_zones_count",
        "parameter_name1",
        "parameter_name2",
        "parameter_name3",
    ]
}

Retrieve a value (R):

https://[server_address]:[port]/settings/boards/DVS_board[X]/md_caps/[setting]?sid=[session_id]

Table 136.

values	Description	Type		TRASSIR
capabilities		integer	R	≥3.1
default_setup_string		string	R	≥3.1
grid_h		integer	R	≥3.1
grid_w		integer	R	≥3.1
maximum_rects_count		integer	R	≥3.1
maximum_zones_count		integer	R	≥3.1
parameter_name[X]	where [X] is the parameter's serial number (from 1 to 3)	string	R	≥3.1

Server setting descriptions

Description of compression card settings

See also