Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Configuration Article | CA-20220907-TP-02

VDG Sense | API | Usage

Image Added

PDF Download

Table of Contents

Some commands like selectCamera and fillLayout require a cameraview parameter or comma separated list of cameraview parameters. A cameraview parameter consists of maximal 6 name:value pairs, separated by a semicolon (‘;’), see table below. Only the cameraid is required. A cameraid value of 0 will blank the corresponding panel. The order of the pairs is arbitrary.

If the server id is omitted, the server this command is send to will be used. If one of the cutout parameters is ommited, a default value of 0 is used for the left and top parameter and a default value of 1000 is used for the right and bottom parameter.

Parameters

Name

Value

Remarks

serverid

[uid]

Optional unique server id. When omitted, uses the default server.

cameraid

[uid]

Required unique camera id. A value of zero (0) blanks the panel. (deviceid works similar)

left

[0..1000]

Optional left position in promille for image cutout.

top

[0..1000]

Optional top position in promille for image cutout.

right

[0..1000]

Optional right position in promille for image cutout.

bottom

[0..1000]

Optional bottom position in promille for image cutout.

Query Examples

Example of the most elementary camera view:
cameraid:1

...

Cutout with correct aspect ratio within borders.

...

Cutout parameters

(all values are in promille)

Left

200

Top

300

Right

700

Bottom

800

Result:

Width

500

Height

500

ZoomFactor

2

Result:

...

Example 2

Cutout with incorrect aspect ratio within borders.

...

Cutout parameters

(all values are in promille)

Left

500

Top

200

Right

800

Bottom

300 —-> 500 (corrected to match aspect ratio)

Result:

Width

300

Height

300

Zoomfactor

3.33333

Result:

...

Example 3

Cutout with incorrect aspect ratio within borders.

...

Cutout parameters 

(all values are in promille)

Left

300

Top

500

Right

400 —-> 600 (corrected to match aspect ratio)

Bottom

800

Result:

Width

100

Height

300

Zoomfactor

3.33333

Result

...

Example 4

Cutout with incorrect aspect ratio where the resulting cutout would pass the bottom border.

...

Cutout parameters 

(all values are in promille)

Left

500

Top

800

Right

800 —-> 700 (corrected to match aspect ratio)

Bottom

900 —-> 1000 (corrected to match aspect ratio)

Result:

Width

300 —-> 200 (corrected to match aspect ratio)

Height

100 —-> 200 (corrected to match aspect ratio)

ZoomFactor

5

Result

...

Example 5

Cutout with incorrect aspect ratio where the resulting cutout would pass the right border.

...

Cutout parameters 

(all values are in promille)

Left

800

Top

500

Right

900 —-> 1000

Bottom

900 —-> 700

Result:

Width

100 —-> 200

Height

400 —-> 200

ZoomFactor

5

Result

...

 

Example 6

Cutout with correct aspect ratio that passes the right border.

...

Cutout parameters 

(all values are in promille)

Left

800

Top

200

Right

1200 —-> 1000

Bottom

600 —-> 400

Result:

Width

400 —-> 200

Height

400 —-> 200

ZoomFactor

5

Result

...

 

Example 7

Cutout with incorrect aspect ratio that passes the right border.

...

Cutout parameters 

(all values are in promille)

Left

700

Top

500

Right

1100 —-> 1000

Bottom

600 —-> 800

Result:

Width

400 —-> 300

Height

100 —-> 300

ZoomFactor

3.3333333

Result

...

 

Example 8

Cutout with correct aspect ratio that passes the bottom border.

...

Cutout parameters 

(all values are in promille)

Left

500

Top

700

Right

900 —-> 800

Bottom

1100 —-> 1000

Result:

Width

400 —-> 300

Height

400 —-> 300

ZoomFactor

3.3333333

Result

...

 

Example 9

Cutout with incorrect aspect ratio that passes the bottom border.

...

Cutout parameters 

(all values are in promille)

Left

500

Top

700

Right

600 —-> 800

Bottom

1100 —-> 1000

Result:

Width

100 —-> 300

Height

400 —-> 300

Max

300

Aspect ratio

0.25 —> 1

ZoomFactor

3.3333333

Result

...

 

Example 10

Cutout with incorrect aspect ratio and reversed values that also passes all borders.

...

Cutout parameters 

(all values are in promille)

Left

1200 —-> 0

Top

1100 —-> 0

Right

-100 —-> 1000

Bottom

-100 —-> 1000

Result:

Width

-1300 —-> 1000

Height

-1200 —-> 1000

ZoomFactor

1

Result

...