org.bytedeco.depthai

Class Device

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.DeviceBase

org.bytedeco.depthai.Device

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class Device
extends DeviceBase

Represents the DepthAI device with the methods to interact with it. Implements the host-side queues to connect with XLinkIn and XLinkOut nodes

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.depthai.DeviceBase

DeviceBase.Config

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static long	EVENT_QUEUE_MAXIMUM_SIZE

Fields inherited from class org.bytedeco.depthai.DeviceBase

DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ, DEFAULT_TIMESYNC_NUM_SAMPLES, DEFAULT_TIMESYNC_RANDOM

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Device()
Device(ByteBuffer nameOrDeviceId)
Device(ByteBuffer nameOrDeviceId, depthai.UsbSpeed maxUsbSpeed)
Device(ByteBuffer nameOrDeviceId, int maxUsbSpeed)
Device(BytePointer nameOrDeviceId)
Device(BytePointer nameOrDeviceId, depthai.UsbSpeed maxUsbSpeed)
Device(BytePointer nameOrDeviceId, int maxUsbSpeed)
Device(DeviceBase.Config config)
Device(DeviceBase.Config config, DeviceInfo devInfo)
Device(DeviceInfo devInfo)
Device(DeviceInfo devInfo, depthai.UsbSpeed maxUsbSpeed)
Device(DeviceInfo devInfo, int maxUsbSpeed)
Device(int version)
Device(int version, depthai.UsbSpeed maxUsbSpeed)
Device(int version, DeviceInfo devInfo)
Device(int version, DeviceInfo devInfo, depthai.UsbSpeed maxUsbSpeed)
Device(int version, DeviceInfo devInfo, int maxUsbSpeed)
Device(int version, DeviceInfo devInfo, Path pathToCmd)
Device(int version, int maxUsbSpeed)
Device(int version, Path pathToCmd)
Device(long size) Native array allocator.
Device(Pipeline pipeline)
Device(Pipeline pipeline, depthai.UsbSpeed maxUsbSpeed)
Device(Pipeline pipeline, DeviceInfo devInfo)
Device(Pipeline pipeline, DeviceInfo devInfo, depthai.UsbSpeed maxUsbSpeed)
Device(Pipeline pipeline, DeviceInfo devInfo, int maxUsbSpeed)
Device(Pipeline pipeline, DeviceInfo devInfo, Path pathToCmd)
Device(Pipeline pipeline, int maxUsbSpeed)
Device(Pipeline pipeline, Path pathToCmd)
Device(Pointer p) Pointer cast constructor.
Device(String nameOrDeviceId)
Device(String nameOrDeviceId, depthai.UsbSpeed maxUsbSpeed)
Device(String nameOrDeviceId, int maxUsbSpeed)

Method Summary

Modifier and Type	Method and Description
static long	EVENT_QUEUE_MAXIMUM_SIZE() Maximum number of elements in event queue
DataInputQueue	getInputQueue(ByteBuffer name)
DataInputQueue	getInputQueue(ByteBuffer name, int maxSize)
DataInputQueue	getInputQueue(ByteBuffer name, int maxSize, boolean blocking)
DataInputQueue	getInputQueue(BytePointer name) Gets an input queue corresponding to stream name.
DataInputQueue	getInputQueue(BytePointer name, int maxSize)
DataInputQueue	getInputQueue(BytePointer name, int maxSize, boolean blocking) Gets an input queue corresponding to stream name.
DataInputQueue	getInputQueue(String name)
DataInputQueue	getInputQueue(String name, int maxSize)
DataInputQueue	getInputQueue(String name, int maxSize, boolean blocking)
StringVector	getInputQueueNames() Get all available input queue names
DataOutputQueue	getOutputQueue(ByteBuffer name)
DataOutputQueue	getOutputQueue(ByteBuffer name, int maxSize)
DataOutputQueue	getOutputQueue(ByteBuffer name, int maxSize, boolean blocking)
DataOutputQueue	getOutputQueue(BytePointer name) Gets an output queue corresponding to stream name.
DataOutputQueue	getOutputQueue(BytePointer name, int maxSize)
DataOutputQueue	getOutputQueue(BytePointer name, int maxSize, boolean blocking) Gets a queue corresponding to stream name, if it exists, otherwise it throws.
DataOutputQueue	getOutputQueue(String name)
DataOutputQueue	getOutputQueue(String name, int maxSize)
DataOutputQueue	getOutputQueue(String name, int maxSize, boolean blocking)
StringVector	getOutputQueueNames() Get all available output queue names
Device	getPointer(long i)
BytePointer	getQueueEvent()
ByteBuffer	getQueueEvent(ByteBuffer queueName)
ByteBuffer	getQueueEvent(ByteBuffer queueName, Pointer timeout)
BytePointer	getQueueEvent(BytePointer queueName)
BytePointer	getQueueEvent(BytePointer queueName, Pointer timeout) Gets or waits until specified queue has received a message
BytePointer	getQueueEvent(Pointer timeout) Gets or waits until any queue has received a message
String	getQueueEvent(String queueName)
String	getQueueEvent(String queueName, Pointer timeout)
BytePointer	getQueueEvent(StringVector queueNames)
BytePointer	getQueueEvent(StringVector queueNames, Pointer timeout) Gets or waits until any of specified queues has received a message
StringVector	getQueueEvents()
StringVector	getQueueEvents(ByteBuffer queueName)
StringVector	getQueueEvents(ByteBuffer queueName, long maxNumEvents, Pointer timeout)
StringVector	getQueueEvents(BytePointer queueName)
StringVector	getQueueEvents(BytePointer queueName, long maxNumEvents, Pointer timeout) Gets or waits until specified queue has received a message
StringVector	getQueueEvents(long maxNumEvents, Pointer timeout) Gets or waits until any queue has received a message
StringVector	getQueueEvents(String queueName)
StringVector	getQueueEvents(String queueName, long maxNumEvents, Pointer timeout)
StringVector	getQueueEvents(StringVector queueNames)
StringVector	getQueueEvents(StringVector queueNames, long maxNumEvents, Pointer timeout) Gets or waits until any of specified queues has received a message
Device	position(long position)

Methods inherited from class org.bytedeco.depthai.DeviceBase

_close, addLogCallback, DEFAULT_SEARCH_TIME, DEFAULT_SYSTEM_INFORMATION_LOGGING_RATE_HZ, DEFAULT_TIMESYNC_NUM_SAMPLES, DEFAULT_TIMESYNC_PERIOD, DEFAULT_TIMESYNC_RANDOM, DEFAULT_USB_SPEED, factoryResetCalibration, flashCalibration, flashCalibration2, flashEepromClear, flashFactoryCalibration, flashFactoryEepromClear, getAllAvailableDevices, getAllConnectedDevices, getAnyAvailableDevice, getAnyAvailableDevice, getAnyAvailableDevice, getBootloaderVersion, getCameraSensorNames, getChipTemperature, getCmxMemoryUsage, getConnectedCameraFeatures, getConnectedCameras, getConnectedIMU, getConnection, getCrashDump, getDdrMemoryUsage, getDefaultSearchTime, getDeviceByMxId, getDeviceByMxId, getDeviceByMxId, getDeviceInfo, getDeviceName, getEmbeddedDeviceBinary, getEmbeddedDeviceBinary, getEmbeddedDeviceBinary, getEmbeddedIMUFirmwareVersion, getFirstAvailableDevice, getFirstAvailableDevice, getIMUFirmwareUpdateStatus, getIMUFirmwareVersion, getIrDrivers, getLeonCssCpuUsage, getLeonCssHeapUsage, getLeonMssCpuUsage, getLeonMssHeapUsage, getLogLevel, getLogOutputLevel, getMxId, getSystemInformationLoggingRate, getUsbSpeed, getXLinkChunkSize, hasCrashDump, isClosed, isEepromAvailable, isPipelineRunning, readCalibration, readCalibration2, readCalibrationOrDefault, readCalibrationRaw, readFactoryCalibration, readFactoryCalibrationOrDefault, readFactoryCalibrationRaw, removeLogCallback, setIrFloodLightBrightness, setIrFloodLightBrightness, setIrLaserDotProjectorBrightness, setIrLaserDotProjectorBrightness, setLogLevel, setLogLevel, setLogOutputLevel, setLogOutputLevel, setSystemInformationLoggingRate, setTimesync, setTimesync, setXLinkChunkSize, startIMUFirmwareUpdate, startIMUFirmwareUpdate, startPipeline, startPipeline

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_QUEUE_MAXIMUM_SIZE

public static final long EVENT_QUEUE_MAXIMUM_SIZE

Constructor Detail

Device

public Device(@Const @ByRef
              Pipeline pipeline)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              Path pathToCmd)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@Const @ByRef
              Pipeline pipeline,
              @Const @ByRef
              DeviceInfo devInfo,
              @Const @ByRef
              Path pathToCmd)

Device

public Device()

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              Path pathToCmd)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@Cast(value="dai::OpenVINO::Version")
              int version,
              @Const @ByRef
              DeviceInfo devInfo,
              @Const @ByRef
              Path pathToCmd)

Device

public Device(@ByVal
              DeviceBase.Config config)

Device

public Device(@ByVal
              DeviceBase.Config config,
              @Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Const @ByRef
              DeviceInfo devInfo)

Device

public Device(@Const @ByRef
              DeviceInfo devInfo,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@Const @ByRef
              DeviceInfo devInfo,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@StdString
              BytePointer nameOrDeviceId)

Device

public Device(@StdString
              ByteBuffer nameOrDeviceId)

Device

public Device(@StdString
              String nameOrDeviceId)

Device

public Device(@StdString
              BytePointer nameOrDeviceId,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@StdString
              ByteBuffer nameOrDeviceId,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@StdString
              String nameOrDeviceId,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@StdString
              BytePointer nameOrDeviceId,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(@StdString
              ByteBuffer nameOrDeviceId,
              depthai.UsbSpeed maxUsbSpeed)

Device

public Device(@StdString
              String nameOrDeviceId,
              @Cast(value="dai::UsbSpeed")
              int maxUsbSpeed)

Device

public Device(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Device

public Device(long size)

Native array allocator. Access with Pointer.position(long).

Method Detail

position

public Device position(long position)

Overrides:

position in class Pointer

getPointer

public Device getPointer(long i)

Overrides:

getPointer in class Pointer

EVENT_QUEUE_MAXIMUM_SIZE

@MemberGetter
 @Cast(value="const std::size_t")
public static long EVENT_QUEUE_MAXIMUM_SIZE()

Maximum number of elements in event queue

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name)

Gets an output queue corresponding to stream name. If it doesn't exist it throws

Parameters:

name - Queue/stream name, created by XLinkOut node

Returns:

Smart pointer to DataOutputQueue

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 ByteBuffer name)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize,
                                                 @Cast(value="bool")
                                                 boolean blocking)

Gets a queue corresponding to stream name, if it exists, otherwise it throws. Also sets queue options

Parameters:

name - Queue/stream name, set in XLinkOut node

maxSize - Maximum number of messages in queue

blocking - Queue behavior once full. True specifies blocking and false overwriting of oldest messages. Default: true

Returns:

Smart pointer to DataOutputQueue

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 BytePointer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 ByteBuffer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize,
                                                 @Cast(value="bool")
                                                 boolean blocking)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 ByteBuffer name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize,
                                                 @Cast(value="bool")
                                                 boolean blocking)

getOutputQueue

@SharedPtr
public DataOutputQueue getOutputQueue(@StdString
                                                 String name,
                                                 @Cast(value="unsigned int")
                                                 int maxSize)

getOutputQueueNames

@ByVal
public StringVector getOutputQueueNames()

Get all available output queue names

Returns:

Vector of output queue names

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name)

Gets an input queue corresponding to stream name. If it doesn't exist it throws

Parameters:

name - Queue/stream name, set in XLinkIn node

Returns:

Smart pointer to DataInputQueue

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               ByteBuffer name)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name,
                                               @Cast(value="unsigned int")
                                               int maxSize,
                                               @Cast(value="bool")
                                               boolean blocking)

Gets an input queue corresponding to stream name. If it doesn't exist it throws. Also sets queue options

Parameters:

name - Queue/stream name, set in XLinkOut node

maxSize - Maximum number of messages in queue

blocking - Queue behavior once full. True: blocking, false: overwriting of oldest messages. Default: true

Returns:

Smart pointer to DataInputQueue

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               BytePointer name,
                                               @Cast(value="unsigned int")
                                               int maxSize)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               ByteBuffer name,
                                               @Cast(value="unsigned int")
                                               int maxSize,
                                               @Cast(value="bool")
                                               boolean blocking)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               ByteBuffer name,
                                               @Cast(value="unsigned int")
                                               int maxSize)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name,
                                               @Cast(value="unsigned int")
                                               int maxSize,
                                               @Cast(value="bool")
                                               boolean blocking)

getInputQueue

@SharedPtr
public DataInputQueue getInputQueue(@StdString
                                               String name,
                                               @Cast(value="unsigned int")
                                               int maxSize)

getInputQueueNames

@ByVal
public StringVector getInputQueueNames()

Get all available input queue names

Returns:

Vector of input queue names

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Const @ByRef
                                          StringVector queueNames,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until any of specified queues has received a message

Parameters:

queueNames - Names of queues for which to block

maxNumEvents - Maximum number of events to remove from queue - Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite - Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Const @ByRef
                                          StringVector queueNames)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          BytePointer queueName,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until specified queue has received a message

Parameters:

queueName - Name of queues for which to wait for

maxNumEvents - Maximum number of events to remove from queue. Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          BytePointer queueName)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          ByteBuffer queueName,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          ByteBuffer queueName)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          String queueName,
                                          @Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@StdString
                                          String queueName)

getQueueEvents

@ByVal
public StringVector getQueueEvents(@Cast(value="std::size_t")
                                          long maxNumEvents,
                                          @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                          Pointer timeout)

Gets or waits until any queue has received a message

Parameters:

maxNumEvents - Maximum number of events to remove from queue. Default is unlimited

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Names of queues which received messages first

getQueueEvents

@ByVal
public StringVector getQueueEvents()

getQueueEvent

@StdString
public BytePointer getQueueEvent(@Const @ByRef
                                            StringVector queueNames,
                                            @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until any of specified queues has received a message

Parameters:

queueNames - Names of queues for which to wait for

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message first

getQueueEvent

@StdString
public BytePointer getQueueEvent(@Const @ByRef
                                            StringVector queueNames)

getQueueEvent

@StdString
public BytePointer getQueueEvent(@StdString
                                            BytePointer queueName,
                                            @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until specified queue has received a message

Parameters:

queueNames - Name of queues for which to wait for

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message

getQueueEvent

@StdString
public BytePointer getQueueEvent(@StdString
                                            BytePointer queueName)

getQueueEvent

@StdString
public ByteBuffer getQueueEvent(@StdString
                                           ByteBuffer queueName,
                                           @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                           Pointer timeout)

getQueueEvent

@StdString
public ByteBuffer getQueueEvent(@StdString
                                           ByteBuffer queueName)

getQueueEvent

@StdString
public String getQueueEvent(@StdString
                                       String queueName,
                                       @ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                       Pointer timeout)

getQueueEvent

@StdString
public String getQueueEvent(@StdString
                                       String queueName)

getQueueEvent

@StdString
public BytePointer getQueueEvent(@ByVal(nullValue="std::chrono::microseconds(-1)") @Cast(value="std::chrono::microseconds*")
                                            Pointer timeout)

Gets or waits until any queue has received a message

Parameters:

timeout - Timeout after which return regardless. If negative then wait is indefinite. Default is -1

Returns:

Queue name which received a message

getQueueEvent

@StdString
public BytePointer getQueueEvent()