org.bytedeco.depthai

Class DataOutputQueue

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.DataOutputQueue

All Implemented Interfaces:

AutoCloseable

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

Access to receive messages coming from XLink stream

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
DataOutputQueue(Pointer p) Pointer cast constructor.
DataOutputQueue(XLinkConnection conn, ByteBuffer streamName)
DataOutputQueue(XLinkConnection conn, ByteBuffer streamName, int maxSize, boolean blocking)
DataOutputQueue(XLinkConnection conn, BytePointer streamName)
DataOutputQueue(XLinkConnection conn, BytePointer streamName, int maxSize, boolean blocking) Alias for callback id
DataOutputQueue(XLinkConnection conn, String streamName)
DataOutputQueue(XLinkConnection conn, String streamName, int maxSize, boolean blocking)

Method Summary

Modifier and Type	Method and Description
void	_close() Closes the queue and the underlying thread
int	addCallback(depthai.Callback callback) Adds a callback on message received
int	addCallback(depthai.MessageCallback arg0) Adds a callback on message received
int	addCallback(depthai.NameMessageCallback arg0) Adds a callback on message received
ADatatype	front() Gets first message in the queue.
AprilTagConfig	frontAprilTagConfig()
ImgDetections	frontImgDetections()
ImgFrame	frontImgFrame()
IMUData	frontIMUData()
NNData	frontNNData()
SpatialImgDetections	frontSpatialImgDetections()
SpatialLocationCalculatorConfig	frontSpatialLocationCalculatorConfig()
SpatialLocationCalculatorData	frontSpatialLocationCalculatorData()
StereoDepthConfig	frontStereoDepthConfig()
SystemInformation	frontSystemInformation()
Tracklets	frontTracklets()
void	frontVoid()
ADatatype	get() Block until a message is available.
ADatatypeVector	getAll() Block until at least one message in the queue.
AprilTagConfig	getAprilTagConfig()
boolean	getBlocking() Gets current queue behavior when full (maxSize)
ImgDetections	getImgDetections()
ImgFrame	getImgFrame()
IMUData	getIMUData()
int	getMaxSize() Gets queue maximum size
BytePointer	getName() Gets queues name
NNData	getNNData()
SpatialImgDetections	getSpatialImgDetections()
SpatialLocationCalculatorConfig	getSpatialLocationCalculatorConfig()
SpatialLocationCalculatorData	getSpatialLocationCalculatorData()
StereoDepthConfig	getStereoDepthConfig()
SystemInformation	getSystemInformation()
Tracklets	getTracklets()
void	getVoid()
boolean	has() Check whether front of the queue has message of type T
boolean	hasAprilTagConfig()
boolean	hasImgDetections()
boolean	hasImgFrame()
boolean	hasIMUData()
boolean	hasNNData()
boolean	hasSpatialImgDetections()
boolean	hasSpatialLocationCalculatorConfig()
boolean	hasSpatialLocationCalculatorData()
boolean	hasStereoDepthConfig()
boolean	hasSystemInformation()
boolean	hasTracklets()
boolean	isClosed() Check whether queue is closed \warning This function is thread-unsafe and may return outdated incorrect values.
boolean	removeCallback(int callbackId) Removes a callback
void	setBlocking(boolean blocking) Sets queue behavior when full (maxSize)
void	setMaxSize(int maxSize) Sets queue maximum size
ADatatype	tryGet() Try to retrieve message T from queue.
ADatatypeVector	tryGetAll() Try to retrieve all messages in the queue.
AprilTagConfig	tryGetAprilTagConfig()
ImgDetections	tryGetImgDetections()
ImgFrame	tryGetImgFrame()
IMUData	tryGetIMUData()
NNData	tryGetNNData()
SpatialImgDetections	tryGetSpatialImgDetections()
SpatialLocationCalculatorConfig	tryGetSpatialLocationCalculatorConfig()
SpatialLocationCalculatorData	tryGetSpatialLocationCalculatorData()
StereoDepthConfig	tryGetStereoDepthConfig()
SystemInformation	tryGetSystemInformation()
Tracklets	tryGetTracklets()
void	tryGetVoid()

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, 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

Constructor Detail

DataOutputQueue

public DataOutputQueue(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       BytePointer streamName,
                       @Cast(value="unsigned int")
                       int maxSize,
                       @Cast(value="bool")
                       boolean blocking)

Alias for callback id

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       BytePointer streamName)

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       ByteBuffer streamName,
                       @Cast(value="unsigned int")
                       int maxSize,
                       @Cast(value="bool")
                       boolean blocking)

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       ByteBuffer streamName)

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       String streamName,
                       @Cast(value="unsigned int")
                       int maxSize,
                       @Cast(value="bool")
                       boolean blocking)

DataOutputQueue

public DataOutputQueue(@SharedPtr
                       XLinkConnection conn,
                       @StdString
                       String streamName)

Method Detail

isClosed

@Cast(value="bool")
public boolean isClosed()

Check whether queue is closed \warning This function is thread-unsafe and may return outdated incorrect values. It is only meant for use in simple single-threaded code. Well written code should handle exceptions when calling any DepthAI apis to handle hardware events and multithreaded use.

_close

@Name(value="close")
public void _close()

Closes the queue and the underlying thread

setBlocking

public void setBlocking(@Cast(value="bool")
                        boolean blocking)

Sets queue behavior when full (maxSize)

Parameters:

blocking - Specifies if block or overwrite the oldest message in the queue

getBlocking

@Cast(value="bool")
public boolean getBlocking()

Gets current queue behavior when full (maxSize)

Returns:

True if blocking, false otherwise

setMaxSize

public void setMaxSize(@Cast(value="unsigned int")
                       int maxSize)

Sets queue maximum size

Parameters:

maxSize - Specifies maximum number of messages in the queue

getMaxSize

@Cast(value="unsigned int")
public int getMaxSize()

Gets queue maximum size

Returns:

Maximum queue size

getName

@StdString
public BytePointer getName()

Gets queues name

Returns:

Queue name

addCallback

@Cast(value="dai::DataOutputQueue::CallbackId")
public int addCallback(depthai.NameMessageCallback arg0)

Adds a callback on message received

Parameters:

callback - Callback function with queue name and message pointer

Returns:

Callback id

addCallback

@Cast(value="dai::DataOutputQueue::CallbackId")
public int addCallback(depthai.MessageCallback arg0)

Adds a callback on message received

Parameters:

callback - Callback function with message pointer

Returns:

Callback id

addCallback

@Cast(value="dai::DataOutputQueue::CallbackId")
public int addCallback(depthai.Callback callback)

Adds a callback on message received

Parameters:

callback - Callback function without any parameters

Returns:

Callback id

removeCallback

@Cast(value="bool")
public boolean removeCallback(@Cast(value="dai::DataOutputQueue::CallbackId")
                                                  int callbackId)

Removes a callback

Parameters:

callbackId - Id of callback to be removed

Returns:

True if callback was removed, false otherwise

has

@Cast(value="bool")
public boolean has()

Check whether front of the queue has message of type T

Returns:

True if queue isn't empty and the first element is of type T, false otherwise

hasAprilTagConfig

@Name(value="has<dai::AprilTagConfig>")
 @Cast(value="bool")
public boolean hasAprilTagConfig()

hasImgFrame

@Name(value="has<dai::ImgFrame>")
 @Cast(value="bool")
public boolean hasImgFrame()

hasIMUData

@Name(value="has<dai::IMUData>")
 @Cast(value="bool")
public boolean hasIMUData()

hasSpatialLocationCalculatorConfig

@Name(value="has<dai::SpatialLocationCalculatorConfig>")
 @Cast(value="bool")
public boolean hasSpatialLocationCalculatorConfig()

hasImgDetections

@Name(value="has<dai::ImgDetections>")
 @Cast(value="bool")
public boolean hasImgDetections()

hasNNData

@Name(value="has<dai::NNData>")
 @Cast(value="bool")
public boolean hasNNData()

hasTracklets

@Name(value="has<dai::Tracklets>")
 @Cast(value="bool")
public boolean hasTracklets()

hasSpatialImgDetections

@Name(value="has<dai::SpatialImgDetections>")
 @Cast(value="bool")
public boolean hasSpatialImgDetections()

hasSpatialLocationCalculatorData

@Name(value="has<dai::SpatialLocationCalculatorData>")
 @Cast(value="bool")
public boolean hasSpatialLocationCalculatorData()

hasStereoDepthConfig

@Name(value="has<dai::StereoDepthConfig>")
 @Cast(value="bool")
public boolean hasStereoDepthConfig()

hasSystemInformation

@Name(value="has<dai::SystemInformation>")
 @Cast(value="bool")
public boolean hasSystemInformation()

tryGet

@SharedPtr
 @ByVal
public ADatatype tryGet()

Try to retrieve message T from queue. If message isn't of type T it returns nullptr

Returns:

Message of type T or nullptr if no message available

tryGetVoid

@Name(value="tryGet<dai::ADatatype>")
public void tryGetVoid()

tryGetAprilTagConfig

@Name(value="tryGet<dai::AprilTagConfig>")
 @SharedPtr
public AprilTagConfig tryGetAprilTagConfig()

tryGetImgFrame

@Name(value="tryGet<dai::ImgFrame>")
 @SharedPtr
public ImgFrame tryGetImgFrame()

tryGetIMUData

@Name(value="tryGet<dai::IMUData>")
 @SharedPtr
public IMUData tryGetIMUData()

tryGetSpatialLocationCalculatorConfig

@Name(value="tryGet<dai::SpatialLocationCalculatorConfig>")
 @SharedPtr
public SpatialLocationCalculatorConfig tryGetSpatialLocationCalculatorConfig()

tryGetImgDetections

@Name(value="tryGet<dai::ImgDetections>")
 @SharedPtr
public ImgDetections tryGetImgDetections()

tryGetNNData

@Name(value="tryGet<dai::NNData>")
 @SharedPtr
public NNData tryGetNNData()

tryGetTracklets

@Name(value="tryGet<dai::Tracklets>")
 @SharedPtr
public Tracklets tryGetTracklets()

tryGetSpatialImgDetections

@Name(value="tryGet<dai::SpatialImgDetections>")
 @SharedPtr
public SpatialImgDetections tryGetSpatialImgDetections()

tryGetSpatialLocationCalculatorData

@Name(value="tryGet<dai::SpatialLocationCalculatorData>")
 @SharedPtr
public SpatialLocationCalculatorData tryGetSpatialLocationCalculatorData()

tryGetStereoDepthConfig

@Name(value="tryGet<dai::StereoDepthConfig>")
 @SharedPtr
public StereoDepthConfig tryGetStereoDepthConfig()

tryGetSystemInformation

@Name(value="tryGet<dai::SystemInformation>")
 @SharedPtr
public SystemInformation tryGetSystemInformation()

get

@SharedPtr
 @ByVal
public ADatatype get()

Block until a message is available.

Returns:

Message of type T or nullptr if no message available

getVoid

@Name(value="get<dai::ADatatype>")
public void getVoid()

getAprilTagConfig

@Name(value="get<dai::AprilTagConfig>")
 @SharedPtr
public AprilTagConfig getAprilTagConfig()

getImgFrame

@Name(value="get<dai::ImgFrame>")
 @SharedPtr
public ImgFrame getImgFrame()

getIMUData

@Name(value="get<dai::IMUData>")
 @SharedPtr
public IMUData getIMUData()

getSpatialLocationCalculatorConfig

@Name(value="get<dai::SpatialLocationCalculatorConfig>")
 @SharedPtr
public SpatialLocationCalculatorConfig getSpatialLocationCalculatorConfig()

getImgDetections

@Name(value="get<dai::ImgDetections>")
 @SharedPtr
public ImgDetections getImgDetections()

getNNData

@Name(value="get<dai::NNData>")
 @SharedPtr
public NNData getNNData()

getTracklets

@Name(value="get<dai::Tracklets>")
 @SharedPtr
public Tracklets getTracklets()

getSpatialImgDetections

@Name(value="get<dai::SpatialImgDetections>")
 @SharedPtr
public SpatialImgDetections getSpatialImgDetections()

getSpatialLocationCalculatorData

@Name(value="get<dai::SpatialLocationCalculatorData>")
 @SharedPtr
public SpatialLocationCalculatorData getSpatialLocationCalculatorData()

getStereoDepthConfig

@Name(value="get<dai::StereoDepthConfig>")
 @SharedPtr
public StereoDepthConfig getStereoDepthConfig()

getSystemInformation

@Name(value="get<dai::SystemInformation>")
 @SharedPtr
public SystemInformation getSystemInformation()

front

@SharedPtr
 @ByVal
public ADatatype front()

Gets first message in the queue.

Returns:

Message of type T or nullptr if no message available

frontVoid

@Name(value="front<dai::ADatatype>")
public void frontVoid()

frontAprilTagConfig

@Name(value="front<dai::AprilTagConfig>")
 @SharedPtr
public AprilTagConfig frontAprilTagConfig()

frontImgFrame

@Name(value="front<dai::ImgFrame>")
 @SharedPtr
public ImgFrame frontImgFrame()

frontIMUData

@Name(value="front<dai::IMUData>")
 @SharedPtr
public IMUData frontIMUData()

frontSpatialLocationCalculatorConfig

@Name(value="front<dai::SpatialLocationCalculatorConfig>")
 @SharedPtr
public SpatialLocationCalculatorConfig frontSpatialLocationCalculatorConfig()

frontImgDetections

@Name(value="front<dai::ImgDetections>")
 @SharedPtr
public ImgDetections frontImgDetections()

frontNNData

@Name(value="front<dai::NNData>")
 @SharedPtr
public NNData frontNNData()

frontTracklets

@Name(value="front<dai::Tracklets>")
 @SharedPtr
public Tracklets frontTracklets()

frontSpatialImgDetections

@Name(value="front<dai::SpatialImgDetections>")
 @SharedPtr
public SpatialImgDetections frontSpatialImgDetections()

frontSpatialLocationCalculatorData

@Name(value="front<dai::SpatialLocationCalculatorData>")
 @SharedPtr
public SpatialLocationCalculatorData frontSpatialLocationCalculatorData()

frontStereoDepthConfig

@Name(value="front<dai::StereoDepthConfig>")
 @SharedPtr
public StereoDepthConfig frontStereoDepthConfig()

frontSystemInformation

@Name(value="front<dai::SystemInformation>")
 @SharedPtr
public SystemInformation frontSystemInformation()

tryGetAll

@ByVal
public ADatatypeVector tryGetAll()

Try to retrieve all messages in the queue.

Returns:

Vector of messages

getAll

@ByVal
public ADatatypeVector getAll()

Block until at least one message in the queue. Then return all messages from the queue.

Returns:

Vector of messages