API docs by Redocly

IP Decoding Products WebInterface API (3.0.0.0)

IP Decoding Products WebInterface API

LiveView

Sets/Gets alert settings.

  1. To get values, put the API without queries.
  2. To set values, put the API with corresponding queries.
path Parameters
position-no
required
integer <int32> [ 1 .. 16 ]

Position No.
max value: refer to "registration" in the "capabilities" API.

query Parameters
red
integer <int32> [ 0 .. 255 ]

RGB of Alert Color

green
integer <int32> [ 0 .. 255 ]

RGB of Alert Color

blue
integer <int32> [ 0 .. 255 ]

RGB of Alert Color

borderSize
integer <int32> [ 0 .. 20 ]

Alert Border Size

textSize
string
Enum: "small" "medium" "large"

Alert text Size

textPosition
string
Enum: "upper" "center" "lower"

Alert text Position.
(Supported Version: V5.51 or above)

textMessage
string <= 58 characters

Alert text Message

layout
integer <int32>

The number and arrangement of cameras on a screen.

page
integer <int32>
beep
integer <int32>

Beep alert sound type
(Supported Version: V5.30 or above)

beepOut
integer <int32>

Output destination of beep sound
(Supported Version: V5.30 or above)

vol
string
Enum: "low" "middle" "high"

Volume of beep sound
(Supported Version: V5.30 or above)

sequenceEnable
boolean

Sets sequence mode.
(Supported Version: V5.30 or above)

id
integer <int32>

Sets the ID for the alert.
(Supported Version: V5.30 or above)

blinking
integer <int32>

Alert Border Blinking

  • 0: none
  • 1: border
  • 2: text
  • 3: both

(Supported Version: V5.50 or above)

opacity
integer <int32> [ 0 .. 100 ]

Fills a screen translucently. 100 means completely opaque.
(Supported Version: V6.00 or above)

Responses

Response samples

Content type
application/json
{
  • "red": 20,
  • "green": 153,
  • "blue": 37,
  • "borderSize": 5,
  • "textSize": "small",
  • "textPosition": "upper",
  • "textMessage": "textMessage",
  • "layout": 16,
  • "page": 2,
  • "beep": 2,
  • "beepOut": 6,
  • "vol": "low",
  • "sequenceEnable": false,
  • "id": 6,
  • "blinking": 3,
  • "opacity": 20
}

Sets alert settings.

(Supported Version: V4.2 or above)

path Parameters
position-no
required
integer <int32> [ 1 .. 16 ]

max value: refer to "registration" in the "capabilities" API.

Request Body schema: application/json

Alert settings

red
integer <int32> [ 0 .. 255 ]
green
integer <int32> [ 0 .. 255 ]
blue
integer <int32> [ 0 .. 255 ]
borderSize
integer <int32> [ 0 .. 20 ]
textSize
string
Enum: "small" "medium" "large"
textPosition
string
Enum: "upper" "center" "lower"

(Supported Version: V5.51 or above)

textMessage
string <= 58 characters

UTF-8

layout
integer <int32>

The number and arrangement of cameras on a screen.
range: The number of "layout" in the "capabilities" API is available.
noted: "custom" refers to 255, "preset" refers to the range from 200 to 206. (as "int32")
("preset" can only be used with an Enterprise license.)

page
integer <int32>

max value: refer to "registration" in the "capabilities" API.

beep
integer <int32> [ 0 .. 3 ]

Beep alert sound type.

  • 0: stop
  • 1: sound1
  • 2: sound2
  • 3: sound3

(Supported Version: V5.30 or above)

beepOut
integer <int32> [ 1 .. 7 ]

Output destination of beep sound

  • [0]: hdmi_1 or internal speaker with "line_out"
  • [1]: hdmi_2
  • [2]: reserved

range: from 1 to 7

  • 1: hdmi_1 or internal speaker with "line_out"
  • 2: hdmi_2
  • 3: hdmi_1 & hdmi_2

(Supported Version: V5.30 or above)

vol
string
Enum: "low" "middle" "high"

(Supported Version: V5.30 or above)
volume of beep sound

sequenceEnable
boolean

(Supported Version: V5.30 or above)

id
integer <int32> [ 1 .. 16 ]

(Supported Version: V5.30 or above) Request only, not received as a parameter.

blinking
integer <int32> [ 0 .. 3 ]

(Supported Version: V5.50 or above)
Alert Border Blinking

  • 0: none
  • 1: border
  • 2: text
  • 3: both
opacity
integer <int32> [ 0 .. 100 ]

(Supported Version: V6.00 or above)
Fills a screen translucently. 100 means completely opaque.

Responses

Request samples

Content type
application/json
{
  • "red": 20,
  • "green": 153,
  • "blue": 37,
  • "borderSize": 5,
  • "textSize": "small",
  • "textPosition": "upper",
  • "textMessage": "textMessage",
  • "layout": 16,
  • "page": 2,
  • "beep": 2,
  • "beepOut": 6,
  • "vol": "low",
  • "sequenceEnable": false,
  • "id": 6,
  • "blinking": 3,
  • "opacity": 20
}

Response samples

Content type
application/json
{
  • "red": 20,
  • "green": 153,
  • "blue": 37,
  • "borderSize": 5,
  • "textSize": "small",
  • "textPosition": "upper",
  • "textMessage": "textMessage",
  • "layout": 16,
  • "page": 2,
  • "beep": 2,
  • "beepOut": 6,
  • "vol": "low",
  • "sequenceEnable": false,
  • "id": 6,
  • "blinking": 3,
  • "opacity": 20
}

Sets alert settings.

(Supported Version: V4.2 or above)

path Parameters
position-no
required
integer <int32> [ 1 .. 16 ]

max value: refer to "registration" in the "capabilities" API.

Request Body schema: application/json

Alert settings

red
integer <int32> [ 0 .. 255 ]
green
integer <int32> [ 0 .. 255 ]
blue
integer <int32> [ 0 .. 255 ]
borderSize
integer <int32> [ 0 .. 20 ]
textSize
string
Enum: "small" "medium" "large"
textPosition
string
Enum: "upper" "center" "lower"

(Supported Version: V5.51 or above)

textMessage
string <= 58 characters

UTF-8

layout
integer <int32>

The number and arrangement of cameras on a screen.
range: The number of "layout" in the "capabilities" API is available.
noted: "custom" refers to 255, "preset" refers to the range from 200 to 206. (as "int32")
("preset" can only be used with an Enterprise license.)

page
integer <int32>

max value: refer to "registration" in the "capabilities" API.

beep
integer <int32> [ 0 .. 3 ]

Beep alert sound type.

  • 0: stop
  • 1: sound1
  • 2: sound2
  • 3: sound3

(Supported Version: V5.30 or above)

beepOut
integer <int32> [ 1 .. 7 ]

Output destination of beep sound

  • [0]: hdmi_1 or internal speaker with "line_out"
  • [1]: hdmi_2
  • [2]: reserved

range: from 1 to 7

  • 1: hdmi_1 or internal speaker with "line_out"
  • 2: hdmi_2
  • 3: hdmi_1 & hdmi_2

(Supported Version: V5.30 or above)

vol
string
Enum: "low" "middle" "high"

(Supported Version: V5.30 or above)
volume of beep sound

sequenceEnable
boolean

(Supported Version: V5.30 or above)

id
integer <int32> [ 1 .. 16 ]

(Supported Version: V5.30 or above) Request only, not received as a parameter.

blinking
integer <int32> [ 0 .. 3 ]

(Supported Version: V5.50 or above)
Alert Border Blinking

  • 0: none
  • 1: border
  • 2: text
  • 3: both
opacity
integer <int32> [ 0 .. 100 ]

(Supported Version: V6.00 or above)
Fills a screen translucently. 100 means completely opaque.

Responses

Request samples

Content type
application/json
{
  • "red": 20,
  • "green": 153,
  • "blue": 37,
  • "borderSize": 5,
  • "textSize": "small",
  • "textPosition": "upper",
  • "textMessage": "textMessage",
  • "layout": 16,
  • "page": 2,
  • "beep": 2,
  • "beepOut": 6,
  • "vol": "low",
  • "sequenceEnable": false,
  • "id": 6,
  • "blinking": 3,
  • "opacity": 20
}

Response samples

Content type
application/json
{
  • "red": 20,
  • "green": 153,
  • "blue": 37,
  • "borderSize": 5,
  • "textSize": "small",
  • "textPosition": "upper",
  • "textMessage": "textMessage",
  • "layout": 16,
  • "page": 2,
  • "beep": 2,
  • "beepOut": 6,
  • "vol": "low",
  • "sequenceEnable": false,
  • "id": 6,
  • "blinking": 3,
  • "opacity": 20
}