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
Command Line
1/
2 ┌──────────────┐
3 │ │
4 input │ │ (to host)
5 ─────────►│ XLinkOut ├------------►
6 │ │
7 │ │
8 └──────────────┘input-Any
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: floatGet rate limit in messages per second
method
getMetadataOnly(self) -> bool: boolGet whether to transfer only messages attributes and not buffer data
method
getStreamName(self) -> str: strGet stream name
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.