DepthAI v2 has been superseded by DepthAI v3. You are viewing legacy documentation.
CloudSoftwareHardware
DepthAI Components
DepthAI Tutorials
DepthAI Perception
ROS
Neural Networks
DepthAI API References

ON THIS PAGE

  • MessageGroup
  • Creating MessageGroup
  • Reference

MessageGroup

The MessageGroup message type is a versatile container used in DepthAI pipelines to group together a map of arbitrary DepthAI messages. It serves as the primary output of the Sync node, effectively synchronizing various input streams, and acts as the input to the MessageDemux node for subsequent disaggregation and processing.

Creating MessageGroup

MessageGroup can be created automatically by the Sync node as it aligns and groups messages from different sources based on their timestamps. Alternatively, it can be manually constructed in a host application or within a Script node to create custom groupings of DepthAI messages.

Reference

class

depthai.MessageGroup(depthai.Buffer)

method
__getitem__(self, arg0: str) -> ADatatype: ADatatype
method
__init__(self)
method
__iter__(self) -> typing.Iterator[tuple[str, ADatatype]]: typing.Iterator[tuple[str, ADatatype]]
method
__setitem__(self, arg0: str, arg1: ADatatype)
method
getIntervalNs(self) -> int: int
Retrieves interval between the first and the last message in the group.
method
getMessageNames(self) -> list[str]: list[str]
Gets the names of messages in the group
method
method
getSequenceNum(self) -> int: int
Retrieves sequence number
method
getTimestamp(self) -> datetime.timedelta: datetime.timedelta
Retrieves timestamp related to dai::Clock::now()
method
getTimestampDevice(self) -> datetime.timedelta: datetime.timedelta
Retrieves timestamp directly captured from device's monotonic clock, not synchronized to host time. Used mostly for debugging
method
isSynced(self, arg0: int) -> bool: bool
True if all messages in the group are in the interval  Parameter ``thresholdNs``:     Maximal interval between messages
method
method
method

Need assistance?

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