Class Buffer

• Defined in File Buffer.hpp

Inheritance Relationships

Base Type

• public dai::ADatatype (Class ADatatype)

Derived Types

• public dai::AprilTagConfig (Class AprilTagConfig)

• public dai::AprilTags (Class AprilTags)

• public dai::BenchmarkReport (Class BenchmarkReport)

• public dai::CalibrationQuality (Struct CalibrationQuality)

• public dai::CameraControl (Class CameraControl)

• public dai::CoverageData (Struct CoverageData)

• public dai::DynamicCalibrationControl (Class DynamicCalibrationControl)

• public dai::DynamicCalibrationResult (Struct DynamicCalibrationResult)

• public dai::EdgeDetectorConfig (Class EdgeDetectorConfig)

• public dai::EncodedFrame (Class EncodedFrame)

• public dai::FeatureTrackerConfig (Class FeatureTrackerConfig)

• public dai::IMUData (Class IMUData)

• public dai::ImageAlignConfig (Class ImageAlignConfig)

• public dai::ImageFiltersConfig (Class ImageFiltersConfig)

• public dai::ImageManipConfig (Class ImageManipConfig)

• public dai::ImgAnnotations (Class ImgAnnotations)

• public dai::ImgDetections (Class ImgDetections)

• public dai::ImgFrame (Class ImgFrame)

• public dai::MapData (Class MapData)

• public dai::MessageGroup (Class MessageGroup)

• public dai::NNData (Class NNData)

• public dai::ObjectTrackerConfig (Class ObjectTrackerConfig)

• public dai::PointCloudConfig (Class PointCloudConfig)

• public dai::PointCloudData (Class PointCloudData)

• public dai::RGBDData (Class RGBDData)

• public dai::SpatialImgDetections (Class SpatialImgDetections)

• public dai::SpatialLocationCalculatorConfig (Class SpatialLocationCalculatorConfig)

• public dai::SpatialLocationCalculatorData (Class SpatialLocationCalculatorData)

• public dai::StereoDepthConfig (Class StereoDepthConfig)

• public dai::SystemInformation (Class SystemInformation)

• public dai::SystemInformationS3 (Class SystemInformationS3)

• public dai::ThermalConfig (Class ThermalConfig)

• public dai::ToFConfig (Class ToFConfig)

• public dai::ToFDepthConfidenceFilterConfig (Class ToFDepthConfidenceFilterConfig)

• public dai::TrackedFeatures (Class TrackedFeatures)

• public dai::Tracklets (Class Tracklets)

• public dai::TransformData (Class TransformData)

Class Documentation

class Buffer : public dai::ADatatype

Base message - buffer of binary data.

Subclassed by dai::AprilTagConfig, dai::AprilTags, dai::BenchmarkReport, dai::CalibrationQuality, dai::CameraControl, dai::CoverageData, dai::DynamicCalibrationControl, dai::DynamicCalibrationResult, dai::EdgeDetectorConfig, dai::EncodedFrame, dai::FeatureTrackerConfig, dai::IMUData, dai::ImageAlignConfig, dai::ImageFiltersConfig, dai::ImageManipConfig, dai::ImgAnnotations, dai::ImgDetections, dai::ImgFrame, dai::MapData, dai::MessageGroup, dai::NNData, dai::ObjectTrackerConfig, dai::PointCloudConfig, dai::PointCloudData, dai::RGBDData, dai::SpatialImgDetections, dai::SpatialLocationCalculatorConfig, dai::SpatialLocationCalculatorData, dai::StereoDepthConfig, dai::SystemInformation, dai::SystemInformationS3, dai::ThermalConfig, dai::ToFConfig, dai::ToFDepthConfidenceFilterConfig, dai::TrackedFeatures, dai::Tracklets, dai::TransformData

Public Functions

Buffer() = default

Buffer(size_t size)

Buffer(long fd)

Buffer(long fd, size_t size)

~Buffer() override

virtual void serialize(std::vector<std::uint8_t> &metadata, DatatypeEnum &datatype) const override

span<uint8_t> getData()

Get non-owning reference to internal buffer.

Returns:

Reference to internal buffer

span<const uint8_t> getData() const

void setData(const std::vector<std::uint8_t> &data)

Parameters:

data – Copies data to internal buffer

void setData(const long fd)

void setData(std::vector<std::uint8_t> &&data)

Parameters:

data – Moves data to internal buffer

std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> getTimestamp() const

Retrieves timestamp related to dai::Clock::now()

std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> getTimestampDevice() const

Retrieves timestamp directly captured from device’s monotonic clock, not synchronized to host time. Used mostly for debugging

void setTimestamp(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> timestamp)

Sets image timestamp related to dai::Clock::now()

void setTimestampDevice(std::chrono::time_point<std::chrono::steady_clock, std::chrono::steady_clock::duration> timestamp)

Sets image timestamp related to dai::Clock::now()

int64_t getSequenceNum() const

Retrieves image sequence number

void setSequenceNum(int64_t sequenceNum)

Sets image sequence number

virtual span<const uint8_t> getRecordData() const

virtual dai::VisualizeType getVisualizationMessage() const

Get visualizable message

Returns:

Visualizable message, either ImgFrame, ImgAnnotations or std::monostate (None)

DEPTHAI_SERIALIZE(Buffer, sequenceNum, ts, tsDevice)

Public Members

int64_t sequenceNum = 0

Timestamp ts = {}

Timestamp tsDevice = {}