Table of Contents

Interface ICameraControl

Namespace
VAST.Capture
Assembly
VAST.Common.dll

Abstract camera control to generalize platform specific camera control

public interface ICameraControl

Properties

CurrentZoom

Gets or sets current zoom value. Works only when IsAbsoluteZoomSupported is true. When you set new zoom value then transition is abrupt. Use StartSmoothZoom function for smooth zoom transition.

float CurrentZoom { get; set; }

Property Value

float

IsAbsolutePanTiltSupported

Gets whether pan/tilt functions with absolute parameters are supported by current camera

bool IsAbsolutePanTiltSupported { get; }

Property Value

bool

IsAbsoluteZoomSupported

Gets whether zoom functions with absolute parameters are supported by current camera

bool IsAbsoluteZoomSupported { get; }

Property Value

bool

IsExposureSupported

Gets whether exposure functions are supported by current camera

bool IsExposureSupported { get; }

Property Value

bool

IsFlashSupported

Gets whether flash on/off is supported by current camera

bool IsFlashSupported { get; }

Property Value

bool

IsManualFocusSupported

Gets whether manual focus is supported by current camera

bool IsManualFocusSupported { get; }

Property Value

bool

IsPanTiltSupported

Gets whether at least one pan/tilt function is supported by current camera

bool IsPanTiltSupported { get; }

Property Value

bool

IsPresetSupported

Gets whether preset function is supported by current camera

bool IsPresetSupported { get; }

Property Value

bool

IsSmoothZoomSupported

Gets whether smooth zoom functions are supported by current camera

bool IsSmoothZoomSupported { get; }

Property Value

bool

IsSmoothZoomWithSpeedSupported

Gets whether smooth zoom with user specified speed function is supported by current camera

bool IsSmoothZoomWithSpeedSupported { get; }

Property Value

bool

IsWhiteBalanceSupported

Gets whether white balance functions are supported by current camera

bool IsWhiteBalanceSupported { get; }

Property Value

bool

IsZoomSpeedSupported

Gets whether continuous zoom is supported by current camera

bool IsZoomSpeedSupported { get; }

Property Value

bool

IsZoomSupported

Gets whether at least one zoom function is supported by current camera

bool IsZoomSupported { get; }

Property Value

bool

MaxZoom

Gets maximum zoom value

float MaxZoom { get; }

Property Value

float

MinZoom

Gets minimum zoom value

float MinZoom { get; }

Property Value

float

Methods

Focus()

Initiates camera auto-focus

void Focus()

RecallPreset(int, float)

Recalls specified camera preset

void RecallPreset(int presetNo, float speed)

Parameters

presetNo int

Preset number

speed float

The speed at which to move to the new preset: 0.0 (as slow as possible) .. 1.0 (as fast as possible)

SetAutoExposure()

Set auto exposure

void SetAutoExposure()

SetAutoWhiteBalance(WhiteBalance)

Set specified white balance preset

void SetAutoWhiteBalance(WhiteBalance whiteBalancePreset)

Parameters

whiteBalancePreset WhiteBalance

White balance preset

SetFlash(bool)

Turns camera flash on or off

void SetFlash(bool isOn)

Parameters

isOn bool

If true turns camera flash on, if false turns it off

SetManualExposure(float)

Set camera exposure iris manually

void SetManualExposure(float exposureLevel)

Parameters

exposureLevel float

Exposure level: 0.0 (dark) .. 1.0 (light)

SetManualExposure(float, float, float)

Set camera exposure parameters manually

void SetManualExposure(float iris, float gain, float shutterSpeed)

Parameters

iris float

Iris: 0.0 (dark) .. 1.0 (light)

gain float

Gain: 0.0 (dark) .. 1.0 (light)

shutterSpeed float

Shutter speed: 0.0 (slow) .. 1.0 (fast)

SetManualFocus(float)

Sets camera manual focus

void SetManualFocus(float focusValue)

Parameters

focusValue float

Focus value: 0.0 (focused to infinity) .. 1.0 (focused as close as possible)

SetManualFocusSpeed(float)

Sets camera manual focus speed

void SetManualFocusSpeed(float focusSpeed)

Parameters

focusSpeed float

Focus speed: -1.0 (focus outwards) ... +1.0 (focus inwards)

SetManualWhiteBalance(float, float)

Set white balance manual value

void SetManualWhiteBalance(float red, float blue)

Parameters

red float

Red: 0.0 (not red) .. 1.0 (very red)

blue float

Blue: 0.0 (not blue) .. 1.0 (very blue)

SetPanTilt(float, float)

Starts pan/tilt transition to specified position. Works only when IsAbsolutePanTiltSupported is true.

void SetPanTilt(float panValue, float tiltValue)

Parameters

panValue float

Desired new pan value: -1.0 (left) .. 0.0 (centered) .. +1.0 (right)

tiltValue float

Desired new tilt value: -1.0 (bottom) .. 0.0 (centered) .. +1.0 (top)

SetPanTiltSpeed(float, float)

Starts continuous pan/tilt transition with specified speeds.

void SetPanTiltSpeed(float panSpeed, float tiltSpeed)

Parameters

panSpeed float

Desired new pan speed: -1.0 (moving right) .. 0.0 (stopped) .. +1.0 (moving left)

tiltSpeed float

Desired new tilt speed: -1.0 (down) .. 0.0 (stopped) .. +1.0 (moving up)

SetZoomSpeed(float)

Starts continuous smooth zoom with specified speed. Works only when IsZoomSpeedSupported is true.

void SetZoomSpeed(float zoomSpeed)

Parameters

zoomSpeed float

Desired zoom speed: -1.0 (zoom outwards) .. +1.0 (zoom inwards)

StartSmoothZoom(float)

Starts smooth zoom transition to zoomTo value. Works only when IsSmoothZoomSupported and IsAbsoluteZoomSupported are true.

void StartSmoothZoom(float zoomTo)

Parameters

zoomTo float

Desired new zoom value

StartSmoothZoom(float, float)

Starts smooth zoom transition to zoomTo value with specified zoom speed. Works only when IsSmoothZoomWithSpeedSupported and IsAbsoluteZoomSupported are true.

void StartSmoothZoom(float zoomTo, float zoomSpeed)

Parameters

zoomTo float

Desired new zoom value

zoomSpeed float

Desired zoom speed

StopPanTilt()

Stops pan/tilt transition currently in progress. If there is no transition in progress then does nothing.

void StopPanTilt()

StopSmoothZoom()

Stops zoom transition currently in progress. If there is no transition in progress then does nothing.

void StopSmoothZoom()

StorePreset(int)

Stores current camera preset

void StorePreset(int presetNo)

Parameters

presetNo int

Preset number