org.bytedeco.depthai

Class XLinkOut

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.Node

org.bytedeco.depthai.XLinkOut

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai::node")
 @NoOffset
 @Properties(inherit=depthai.class)
public class XLinkOut
extends Node

\brief XLinkOut node. Sends messages over XLink.

Nested Class Summary

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

Node.Connection, Node.DatatypeHierarchy, Node.Input, Node.Output

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
XLinkOut(PipelineImpl par, long nodeId)
XLinkOut(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
float	getFpsLimit() Get rate limit in messages per second
boolean	getMetadataOnly() Get whether to transfer only messages attributes and not buffer data
BytePointer	getName() Retrieves nodes name
BytePointer	getStreamName() Get stream name
Node.Input	input() Input for any type of messages to be transfered over XLink stream Default queue is blocking with size 8
void	setFpsLimit(float fps) Specifies a message sending limit.
void	setMetadataOnly(boolean metadataOnly) Specify whether to transfer only messages attributes and not buffer data
void	setStreamName(BytePointer name) Specifies XLink stream name to use.
void	setStreamName(String name)

Methods inherited from class org.bytedeco.depthai.Node

assetManager, clone, getAssets, getInputRefs, getInputs, getOutputRefs, getOutputs, getParentPipeline, getProperties, getRequiredOpenVINOVersion, id, inputs, outputs

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, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

XLinkOut

public XLinkOut(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

XLinkOut

public XLinkOut(@SharedPtr
                PipelineImpl par,
                @Cast(value="int64_t")
                long nodeId)

Method Detail

getName

@StdString
public BytePointer getName()

Description copied from class: Node

Retrieves nodes name

Overrides:

getName in class Node

input

@MemberGetter
 @ByRef
public Node.Input input()

Input for any type of messages to be transfered over XLink stream Default queue is blocking with size 8

setStreamName

public void setStreamName(@StdString
                          BytePointer name)

Specifies XLink stream name to use. The name should not start with double underscores '__', as those are reserved for internal use.

Parameters:

name - Stream name

setStreamName

public void setStreamName(@StdString
                          String name)

setFpsLimit

public void setFpsLimit(float fps)

Specifies a message sending limit. It's approximated from specified rate.

Parameters:

fps - Approximate rate limit in messages per second

setMetadataOnly

public void setMetadataOnly(@Cast(value="bool")
                            boolean metadataOnly)

Specify whether to transfer only messages attributes and not buffer data

getStreamName

@StdString
public BytePointer getStreamName()

Get stream name

getFpsLimit

public float getFpsLimit()

Get rate limit in messages per second

getMetadataOnly

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

Get whether to transfer only messages attributes and not buffer data