HomeCloudSoftwareHardware
DepthAI Components
DepthAI Tutorials
DepthAI Perception
Tools
ROS
Neural Networks
DepthAI API References

ON THIS PAGE

  • XLinkOut
  • How to place it
  • Inputs and Outputs
  • Usage
  • Examples of functionality
  • Reference

XLinkOut

XLinkOut node is used to send data from the device to the host via XLink.

How to place it

Python
C++

Python

Python
1pipeline = dai.Pipeline()
2xlinkOut = pipeline.create(dai.node.XLinkOut)

Inputs and Outputs

React Flow

Usage

Python
C++

Python

Python
1pipeline = dai.Pipeline()
2xOut = pipeline.create(dai.node.XLinkOut)
3xOut.setStreamName("camOut")
4
5# Here we will send camera preview (ImgFrame) to the host via XLink.
6# Host can then display the frame to the user
7cam.preview.link(xOut.input)

Examples of functionality

Reference

class

depthai.node.XLinkOut(depthai.Node)

method
getFpsLimit(self) -> float: float
Get rate limit in messages per second
method
getMetadataOnly(self) -> bool: bool
Get whether to transfer only messages attributes and not buffer data
method
method
setFpsLimit(self, fpsLimit: float)
Specifies a message sending limit. It's approximated from specified rate.  Parameter ``fps``:     Approximate rate limit in messages per second
method
setMetadataOnly(self, arg0: bool)
Specify whether to transfer only messages attributes and not buffer data
method
setStreamName(self, streamName: str)
Specifies XLink stream name to use.  The name should not start with double underscores '__', as those are reserved for internal use.  Parameter ``name``:     Stream name
property
input
Input for any type of messages to be transferred over XLink stream  Default queue is blocking with size 8

Need assistance?

Head over to Discussion Forum for technical support or any other questions you might have.