Camera Class

Namespace: id3.Devices

Definition

Expands upon DeviceChannel to focus on camera data capture, including live feed management and snapshot functionalities, alongside maintaining a list of supported video formats.

Python

class Camera

Dart

class Camera implements Finalizable

C#

public partial class Camera

Java

public class Camera implements AutoCloseable, Serializable

C

typedef struct id3DevicesCamera *ID3_DEVICES_CAMERA;

Usage

Python

cameraInstance = Camera()
# ...

Explicit destruction

# ...
del cameraInstance

Dart

final cameraInstance = sdk.Camera();
// ...

Explicit destruction

// ...
cameraInstance.dispose()

C#

using (var cameraInstance = new Camera())
{
   // ...
}

Explicit destruction

var cameraInstance = new Camera()
// ...
cameraInstance.Dispose()

Java

try (Camera cameraInstance = new Camera()) {
// ...
}

Explicit destruction

Camera cameraInstance = new Camera();
// ...
cameraInstance.close();

C

ID3_DEVICES_CAMERA hCamera{};
int err = id3DevicesCamera_Initialize(&hCamera);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesCamera_Dispose(&hCamera);
}

Properties

Name	Type	Description
captureCallback	CaptureCallback	Callback invoked when new camera capture data becomes available.
deviceAddedCallback	PlugAndPlayCallback	Callback invoked when a device is added to the channel.
deviceClosedCallback	DeviceSelectedCallback	Callback function for when a device is closed on this channel.
deviceEventCallback	DeviceEventCallback	(C++): Callback for generic device events.
deviceFilterList	DeviceTypeList	A list filtering the types of devices this channel will interact with.
deviceId	int	Identifier for the device associated with this channel, intended for internal or plugin use.
deviceInfo	DeviceInfo	Fetches the device object.
deviceOpenedCallback	DeviceSelectedCallback	Callback that is called when a device is opened on this channel.
deviceRemovedCallback	PlugAndPlayCallback	Callback function triggered upon the removal of a device from the channel.
deviceState	DeviceState	Reflects the current state of the device, such as connected, disconnected, etc.
deviceStatusChangedCallback	DeviceCaptureStatusChangedCallback	Callback for when there’s any change in the device’s operational status.
isCapturing	bool	Indicates if the device is currently capturing data, providing a quick status check.
parameterCategoryList	StringList	Lists categories of parameters relevant to the device.
takeSnapshotCallback	CaptureCallback	Callback triggered when a snapshot capture is completed.
videoFormat	int	Sets or gets the current video format.
videoFormatList	VideoFormatList	Lists all video formats supported by the camera, aiding in format selection and compatibility checks.

Methods

Name	Description
addDeviceFilter	Adds a filter to specify the types of devices this channel should handle.
applyParameters	Applies a set of parameters to the device.
checkCommand	(C++/dotnet): Checks if a specific command is available on the device.
checkParameter	Confirms if a parameter exists on the device.
clearDeviceFilter	Clears all set device filters, removing any type restrictions.
closeDevice	Controls closing the associated device.
getCurrentFrame	Fetches the most recent frame from the live feed.
getLastSnapshot	Fetches the most recent snapshot taken by the takeSnapshot function.
getMeasurementData	Retrieves a list of measurement data collected during capture sessions.
getParameter	Retrieves a device parameter’s value.
getParameterDescriptor	Fetches the descriptor of a device parameter.
getParameterList	Obtains all supported parameters, optionally filtered by category.
getParameterNameList	Retrieves names of all supported parameters, optionally filtered by category.
getParameterValueInt	Gets the integer value of a device parameter.
getSpecificFrame	Gets a specific live frame.
isPreviouslyDisconnectedDevice	Checks if the specified device was previously disconnected.
openDevice	Controls opening the associated device.
sendCommand	(C++/dotnet): Issues a command to the device.
sendCommandBoolean	(C++/dotnet): Issues a command with a boolean as result to the device.
sendModelCommand	(C++/dotnet): Dispatches a command to the device model.
setParameter	Sets a device parameter’s value.
setParameterValueInt	Assigns an integer value to a device parameter.
startCapture	Initiates data capture, allowing for an optional parameter to specify capture modes or configurations.
stopCapture	Ends the data capture process, stopping the live feed or any ongoing capture activity.
takeSnapshot	Triggers a snapshot capture process, with the result accessible through getLastSnapshot.
waitForCapture	Waits for new capture data within a specified timeout period.