OrbbecSDK  1.5.7
OrbbecSDK: Software-Development-Kit for Orbbec 3D-Sensor devices
Public Member Functions | List of all members
ob::VideoFrame Class Reference

#include <Frame.hpp>

+ Inheritance diagram for ob::VideoFrame:

Public Member Functions

 VideoFrame (Frame &frame)
 
virtual ~VideoFrame () noexcept
 
uint32_t width ()
 Get frame width. More...
 
uint32_t height ()
 Get frame height. More...
 
void * metadata ()
 Get the metadata of the frame. More...
 
uint32_t metadataSize ()
 Get the metadata size of the frame. More...
 
uint8_t pixelAvailableBitSize ()
 Get the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are valid bits, and the upper 6 bits are filled with 0) More...
 
- Public Member Functions inherited from ob::Frame
 Frame (std::unique_ptr< FrameImpl > impl)
 
 Frame (Frame &frame)
 
virtual ~Frame () noexcept
 
virtual OBFrameType type ()
 Get the type of frame. More...
 
virtual OBFormat format ()
 Get the format of the frame. More...
 
virtual uint64_t index ()
 Get the sequence number of the frame. More...
 
virtual void * data ()
 Get frame data. More...
 
virtual uint32_t dataSize ()
 Get the frame data size. More...
 
uint64_t timeStamp ()
 Get the hardware timestamp of the frame. More...
 
uint64_t timeStampUs ()
 Get the hardware timestamp of the frame us. More...
 
uint64_t systemTimeStamp ()
 Get frame system timestamp. More...
 
template<typename T >
bool is ()
 Check if the runtime type of the frame object is compatible with a given type. More...
 
template<typename T >
std::shared_ptr< T > as ()
 Frame object type conversion. More...
 

Additional Inherited Members

- Protected Attributes inherited from ob::Frame
std::unique_ptr< FrameImpl > impl_
 

Detailed Description

Definition at line 201 of file Frame.hpp.

Constructor & Destructor Documentation

ob::VideoFrame::VideoFrame ( Frame frame)
virtual ob::VideoFrame::~VideoFrame ( )
inlinevirtualnoexcept

Definition at line 204 of file Frame.hpp.

Member Function Documentation

uint32_t ob::VideoFrame::width ( )

Get frame width.

Returns
uint32_t returns the width of the frame
uint32_t ob::VideoFrame::height ( )

Get frame height.

Returns
uint32_t returns the height of the frame
void* ob::VideoFrame::metadata ( )

Get the metadata of the frame.

Returns
void* returns the metadata of the frame
uint32_t ob::VideoFrame::metadataSize ( )

Get the metadata size of the frame.

Returns
uint32_t returns the metadata size of the frame
uint8_t ob::VideoFrame::pixelAvailableBitSize ( )

Get the effective number of pixels (such as Y16 format frame, but only the lower 10 bits are valid bits, and the upper 6 bits are filled with 0)

Attention
Only valid for Y8/Y10/Y11/Y12/Y14/Y16 format
Returns
uint8_t returns the effective number of pixels in the pixel, or 0 if it is an unsupported format

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