camParameterRange (Function)

Top  Previous  Next

Architecture:

NX32L

Device support:

NX-200, NX-400

Firmware version:

1.12.00


This function retrieves the range and other information for a parameter on a connected camera.

This information can then be used to determine the parameters to use for camParameterGet.

 

 

Input:

type : INT

The type of parameter to get information about.

1

- Brightness

2

- Contrast

3

- Saturation

4

- Hue

5

- Auto gain

6

- Auto white balance

7

- Adjust white balance.

8

- Red Balance

9

- Blue balance

10

- Gamma

11

- Power line frequency filter: 0 = Disabled, 1 = 50Hz, 2 = 60Hz, 3 = Auto(if supported).

12

- Auto exposure: 0 = Auto, 1 = Manual, 2 = Shutter priority, 3 = Aperture priority.

13

- Absolute exposure. Exposure time in 100μs units.

14

- Allow dynamic frame rate when Auto exposure is Auto or Aperture priority

 

 

Output:

min_value : DINT

The minimum allowed value.

 

max_value : DINT

The minimum allowed value.

 

step : DINT

The smallest value that makes a change in the camera hardware. Changing the value with less that the step size will not make a difference.

 

kind : INT

The kind of parameter this is:

0

- Unknown

1

- Integer.

2

- Boolean. Set to 1 to enable, 0 to disable.

3

- Enumeration. Each value in the range have a specific value. See the type table for a description of the valid values.

4

- Trigger. The value is not used, setting this parameter triggers the specified functionality.

 

 

flags : DINT

Bit-mask with additional information about the parameter:

 

Bit

 

0

- The parameter is disabled and can not be used.

1

- The parameter is read-only.

2

- The parameter is write-only.

3

- The parameter is volatile and will change by itself.

 

 

Returns: INT

 

0

- The parameter info was retrieved.

-1

- Failed to get the info. The camera may not support reading this parameter.

-3

- Invalid type.

-5

- Camera interface not open.

 

Declaration:

FUNCTION camParameterRange : INT;
VAR_INPUT
  type     : INT;
  min_value : ACCESS DINT;
  max_value : ACCESS DINT;
  step      : ACCESS DINT;
  kind      : ACCESS INT;
  flags     : ACCESS DINT;
END_VAR;

 

 

Example:

// get information about the brightness:
camParameterRange(type:=1, min_value := min_val, max_value := max_val, step := step, kind := kind, flags := flags);