ob::FrameHelper Class Reference

FrameHepler class, which provides some static functions to set timestamp for frame objects FrameHepler inherited from the FrameFactory and the timestamp interface implement here both for compatibility purposes. More...

#include <Frame.hpp>

Inheritance diagram for ob::FrameHelper:

Static Public Member Functions
static void	setFrameDeviceTimestampUs (std::shared_ptr< Frame > frame, uint64_t deviceTimestampUs)
	Set the device timestamp of the frame.
static void	setFrameSystemTimestamp (std::shared_ptr< Frame > frame, uint64_t systemTimestamp)
static void	setFrameDeviceTimestamp (std::shared_ptr< Frame > frame, uint64_t deviceTimestamp)
Static Public Member Functions inherited from ob::FrameFactory
static std::shared_ptr< Frame >	createFrame (OBFrameType frameType, OBFormat format, uint32_t dataSize)
	Create a Frame object of a specific type with a given format and data size.
static std::shared_ptr< VideoFrame >	createVideoFrame (OBFrameType frameType, OBFormat format, uint32_t width, uint32_t height, uint32_t stride=0)
	Create a VideoFrame object of a specific type with a given format, width, height, and stride.
static std::shared_ptr< Frame >	createFrameFromOtherFrame (std::shared_ptr< const Frame > otherFrame, bool shouldCopyData=true)
	Create (clone) a frame object based on the specified other frame object.
static std::shared_ptr< Frame >	createFrameFromStreamProfile (std::shared_ptr< const StreamProfile > profile)
	Create a Frame From (according to)Stream Profile object.
static std::shared_ptr< Frame >	createFrameFromBuffer (OBFrameType frameType, OBFormat format, uint8_t *buffer, BufferDestroyCallback destroyCallback, uint32_t bufferSize)
	Create a frame object based on an externally created buffer.
static std::shared_ptr< VideoFrame >	createVideoFrameFromBuffer (OBFrameType frameType, OBFormat format, uint32_t width, uint32_t height, uint8_t *buffer, BufferDestroyCallback destroyCallback, uint32_t bufferSize, uint32_t stride=0)
	Create a video frame object based on an externally created buffer.

Additional Inherited Members
Public Types inherited from ob::FrameFactory
typedef std::function< void(uint8_t *)>	BufferDestroyCallback
	The callback function to destroy the buffer when the frame is destroyed.

Detailed Description

FrameHepler class, which provides some static functions to set timestamp for frame objects FrameHepler inherited from the FrameFactory and the timestamp interface implement here both for compatibility purposes.

Definition at line 969 of file Frame.hpp.

Member Function Documentation

setFrameDeviceTimestampUs()

static void ob::FrameHelper::setFrameDeviceTimestampUs ( std::shared_ptr< Frame > frame, uint64_t deviceTimestampUs )

inlinestatic

Set the device timestamp of the frame.

Parameters

frame	The frame object.
deviceTimestampUs	The device timestamp to set in microseconds.

Definition at line 977 of file Frame.hpp.

setFrameSystemTimestamp()

static void ob::FrameHelper::setFrameSystemTimestamp ( std::shared_ptr< Frame > frame, uint64_t systemTimestamp )

inlinestatic

Definition at line 986 of file Frame.hpp.

setFrameDeviceTimestamp()

static void ob::FrameHelper::setFrameDeviceTimestamp ( std::shared_ptr< Frame > frame, uint64_t deviceTimestamp )

inlinestatic

Definition at line 992 of file Frame.hpp.

---

The documentation for this class was generated from the following file:

• C:/Users/hzcyf/Projects/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Frame.hpp