Frameset Class

Namespace: id3.Devices

Definition

Manages a set of frames captured from a device, incorporating mechanisms for command execution, frame retrieval, processing, and option management.

Python

class Frameset

Dart

class Frameset implements Finalizable

C#

public partial class Frameset

Java

public class Frameset implements AutoCloseable, Serializable

C

typedef struct id3DevicesFrameset *ID3_DEVICES_FRAMESET;

Usage

Python

framesetInstance = Frameset()
# ...

Explicit destruction

# ...
del framesetInstance

Dart

final framesetInstance = sdk.Frameset();
// ...

Explicit destruction

// ...
framesetInstance.dispose()

C#

using (var framesetInstance = new Frameset())
{
   // ...
}

Explicit destruction

var framesetInstance = new Frameset()
// ...
framesetInstance.Dispose()

Java

try (Frameset framesetInstance = new Frameset()) {
// ...
}

Explicit destruction

Frameset framesetInstance = new Frameset();
// ...
framesetInstance.close();

C

ID3_DEVICES_FRAMESET hFrameset{};
int err = id3DevicesFrameset_Initialize(&hFrameset);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesFrameset_Dispose(&hFrameset);
}

Properties

Name	Type	Description
callback	FramesetCallback	(C++) Specifies a callback function to be invoked in response to certain events or conditions within the frameset lifecycle.
deviceId	int	(C++) Identifies the device from which the frameset originates, intended primarily for plugin usage.
options	DeviceParameterList	Contains adjustable parameters or settings applicable to the frameset, facilitating customization and optimization of processing.
picture	CaptureImage	Stores the primary frame of the set, allowing for direct manipulation and analysis.

Methods

Name	Description
clearOptions	Removes all options currently set on the frameset, resetting it to a default state.
executeCommand	Performs an operation specified by the command string, enabling dynamic interaction with the frameset.
getFrame	Retrieves a specific frame from the frameset, identified by the stream name.
process	Applies processing to the frameset using the provided arguments, allowing for complex manipulation or analysis.