ExtendedCamera.getCurrentFrameset Method

Module: ExtendedCamera

Definition

Fetches the most recent set of frames captured across enabled streams.

get_current_frameset(self, frameset: Frameset) -> bool

Parameters

frameset Frameset
in Intended to hold the latest collection of frames (the frameset).

Returns

bool
Indicates if a new frameset is currently available for retrieval.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
bool getCurrentFrameset(Frameset frameset)

Parameters

frameset Frameset
in Intended to hold the latest collection of frames (the frameset).

Returns

bool
Indicates if a new frameset is currently available for retrieval.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public bool GetCurrentFrameset(Frameset frameset)

Parameters

frameset Frameset
in Intended to hold the latest collection of frames (the frameset).

Returns

bool
Indicates if a new frameset is currently available for retrieval.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public boolean getCurrentFrameset(Frameset frameset) throws DevicesException

Parameters

frameset Frameset
in Intended to hold the latest collection of frames (the frameset).

Returns

boolean
Indicates if a new frameset is currently available for retrieval.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesExtendedCamera_GetCurrentFrameset (
    ID3_DEVICES_EXTENDED_CAMERA hExtendedCamera,
    ID3_DEVICES_FRAMESET hFrameset,
    bool * available)

Parameters

hExtendedCamera ID3_DEVICES_EXTENDED_CAMERA
in Handle to the ExtendedCamera object.

hFrameset ID3_DEVICES_FRAMESET
in Intended to hold the latest collection of frames (the frameset).

available bool *
out Indicates if a new frameset is currently available for retrieval.

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.