|
| DepthFrame (const ob_frame *impl) |
| Construct a new DepthFrame object with a given pointer to the internal frame object.
|
|
| ~DepthFrame () noexcept override=default |
|
float | getValueScale () const |
| Get the value scale of the depth frame. The pixel value of depth frame is multiplied by the scale to give a depth value in millimeters. For example, if valueScale=0.1 and a certain coordinate pixel value is pixelValue=10000, then the depth value = pixelValue*valueScale = 10000*0.1=1000mm.
|
|
| VideoFrame (const ob_frame *impl) |
| Construct a new VideoFrame object with a given pointer to the internal frame object.
|
|
| ~VideoFrame () noexcept override=default |
|
uint32_t | getWidth () const |
| Get the width of the frame.
|
|
uint32_t | getHeight () const |
| Get the height of the frame.
|
|
OBPixelType | getPixelType () const |
| Get the Pixel Type object.
|
|
uint8_t | getPixelAvailableBitSize () const |
| Get the effective number of pixels in the frame.
|
|
uint32_t | width () const |
|
uint32_t | height () const |
|
uint8_t | pixelAvailableBitSize () const |
|
| Frame (const ob_frame *impl) |
| Construct a new Frame object with a given pointer to the internal frame object.
|
|
const ob_frame * | getImpl () const |
| Get the internal (impl) frame object.
|
|
virtual | ~Frame () noexcept |
| Destroy the Frame object.
|
|
virtual OBFrameType | getType () const |
| Get the type of frame.
|
|
virtual OBFormat | getFormat () const |
| Get the format of the frame.
|
|
virtual uint64_t | getIndex () const |
| Get the sequence number of the frame.
|
|
virtual uint8_t * | getData () const |
| Get frame data.
|
|
virtual uint32_t | getDataSize () const |
| Get the size of the frame data.
|
|
uint64_t | getTimeStampUs () const |
| Get the hardware timestamp of the frame in microseconds.
|
|
uint64_t | getSystemTimeStampUs () const |
| Get the system timestamp of the frame in microseconds.
|
|
uint64_t | getGlobalTimeStampUs () const |
| Get the global timestamp of the frame in microseconds.
|
|
uint8_t * | getMetadata () const |
| Get the metadata pointer of the frame.
|
|
uint32_t | getMetadataSize () const |
| Get the size of the metadata of the frame.
|
|
bool | hasMetadata (OBFrameMetadataType type) const |
| Check if the frame object has metadata of a given type.
|
|
int64_t | getMetadataValue (OBFrameMetadataType type) const |
| Get the metadata value.
|
|
std::shared_ptr< StreamProfile > | getStreamProfile () const |
| get StreamProfile of the frame
|
|
std::shared_ptr< Sensor > | getSensor () const |
| get owner sensor of the frame
|
|
std::shared_ptr< Device > | getDevice () const |
| get owner device of the frame
|
|
template<typename T > |
bool | is () const |
| Check if the runtime type of the frame object is compatible with a given type.
|
|
template<typename T > |
std::shared_ptr< T > | as () |
| Convert the frame object to a target type.
|
|
template<typename T > |
std::shared_ptr< const T > | as () const |
| Convert the frame object to a target type.
|
|
OBFrameType | type () const |
|
virtual OBFormat | format () const |
|
virtual uint64_t | index () const |
|
virtual void * | data () const |
|
virtual uint32_t | dataSize () const |
|
uint64_t | timeStamp () const |
|
uint64_t | timeStampUs () const |
|
uint64_t | systemTimeStamp () const |
|
uint64_t | systemTimeStampUs () const |
|
uint64_t | globalTimeStampUs () const |
|
uint8_t * | metadata () const |
|
uint32_t | metadataSize () const |
|