Class XLinkOut

• Defined in File XLinkOut.hpp

Inheritance Relationships

Base Type

• public dai::DeviceNodeCRTP< DeviceNode, XLinkOut, XLinkOutProperties > (Template Class DeviceNodeCRTP)

Class Documentation

class XLinkOut : public dai::DeviceNodeCRTP<DeviceNode, XLinkOut, XLinkOutProperties>

XLinkOut node. Sends messages over XLink.

Public Functions

void setStreamName(const std::string &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

void setFpsLimit(float fps)

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

Parameters:

fps – Approximate rate limit in messages per second

void setMetadataOnly(bool metadataOnly)

Specify whether to transfer only messages attributes and not buffer data

std::string getStreamName() const

Get stream name.

float getFpsLimit() const

Get rate limit in messages per second.

bool getMetadataOnly() const

Get whether to transfer only messages attributes and not buffer data.

virtual void buildInternal() override

Function called from within the create function to build the node. This function is useful for initialization, setting up inputs and outputs = stuff that cannot be perform in the constuctor.

inline DeviceNodeCRTP()

inline DeviceNodeCRTP(const std::shared_ptr<Device> &device)

inline DeviceNodeCRTP(std::unique_ptr<Properties> props)

inline DeviceNodeCRTP(std::unique_ptr<Properties> props, bool confMode)

inline DeviceNodeCRTP(const std::shared_ptr<Device> &device, std::unique_ptr<Properties> props, bool confMode)

Public Members

Input input = {*this, {"in", DEFAULT_GROUP, DEFAULT_BLOCKING, DEFAULT_QUEUE_SIZE, {{{DatatypeEnum::Buffer, true}}}, DEFAULT_WAIT_FOR_MESSAGE}}

Input for any type of messages to be transferred over XLink stream

Default queue is blocking with size 8

Public Static Attributes

static constexpr const char *NAME = "XLinkOut"