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

ON THIS PAGE

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

XLinkIn

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

How to place it

Python
C++
Python
1pipeline = dai.Pipeline()
2xlinkIn = pipeline.create(dai.node.XLinkIn)

Inputs and Outputs

Command Line
1/
2              ┌──────────────┐
3              │              │
4  (From host) │              │    out
5  ----------->│   XLinkIn    ├────────►
6              │              │
7              │              │
8              └──────────────┘
Message types
  • out - Any

Usage

Python
C++
Python
1pipeline = dai.Pipeline()
2xIn = pipeline.create(dai.node.XLinkIn)
3xIn.setStreamName("camControl")
4
5# Create ColorCamera beforehand
6xIn.out.link(cam.inputControl)
7
8with dai.Device(pipeline) as device:
9  device.startPipeline()
10  qCamControl = device.getInputQueue("camControl")
11
12  # Send a message to the ColorCamera to capture a still image
13  ctrl = dai.CameraControl()
14  ctrl.setCaptureStill(True)
15  qCamControl.send(ctrl)

Examples of functionality

Reference

class

depthai.node.XLinkIn(depthai.Node)

method
getMaxDataSize(self) -> int: int
Get maximum messages size in bytes
method
getNumFrames(self) -> int: int
Get number of frames in pool
method
method
setMaxDataSize(self, maxDataSize: int)
Set maximum message size it can receive

Parameter ``maxDataSize``:
    Maximum size in bytes
method
setNumFrames(self, numFrames: int)
Set number of frames in pool for sending messages forward

Parameter ``numFrames``:
    Maximum number of frames in pool
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
out
Outputs message of same type as send from host.

Need assistance?

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