FingerScanner.getCurrentFrame Method

Module: FingerScanner

Definition

Retrieves the current live frame from the capture session.

Python

get_current_frame(self, frame: CaptureImage) -> bool

Parameters

frame CaptureImage

in The parameter to store the current live frame.

Returns

bool

Indicates whether the current frame is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

Dart

bool getCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage

in The parameter to store the current live frame.

Returns

bool

Indicates whether the current frame is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

C#

public bool GetCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage

in The parameter to store the current live frame.

Returns

bool

Indicates whether the current frame is available.

Exceptions

FingerCaptureException

An error has occurred during FingerCapture Library execution.

C

int id3CaptureFingerScanner_GetCurrentFrame (
    ID3_FINGER_CAPTURE_FINGER_SCANNER hFingerScanner,
    ID3_DEVICES_CAPTURE_IMAGE hFrame,
    bool * available)

Parameters

hFingerScanner ID3_FINGER_CAPTURE_FINGER_SCANNER

in Handle to the FingerScanner object.

hFrame ID3_DEVICES_CAPTURE_IMAGE

in The parameter to store the current live frame.

available bool *

out Indicates whether the current frame is available.

Returns

int

An error code.

See id3FingerCaptureError file for the list of possible error codes.