Orbbec SDK K4A Wrapper
Loading...
Searching...
No Matches
k4a::data_block Class Reference

#include <k4arecord/playback.hpp>

Public Member Functions

 data_block (k4a_playback_data_block_t handle=nullptr) noexcept
 
 data_block (const data_block &)=delete
 
data_blockoperator= (const data_block &)=delete
 
 data_block (data_block &&other) noexcept
 
data_blockoperator= (data_block &&other) noexcept
 
 operator bool () const noexcept
 
bool is_valid () const noexcept
 
void reset () noexcept
 
std::chrono::microseconds get_device_timestamp_usec () const noexcept
 
size_t get_buffer_size () const noexcept
 
const uint8_t * get_buffer () const noexcept
 

Detailed Description

Wrapper for k4a_playback_data_block_t

See also
k4a_playback_data_block_t

Definition at line 26 of file playback.hpp.

Constructor & Destructor Documentation

◆ data_block() [1/2]

k4a::data_block::data_block ( k4a_playback_data_block_t  handle = nullptr)
inlinenoexcept

Creates a data_block from a k4a_playback_data_block_t Takes ownership of the handle, you should not call k4a_playback_data_block_release on the handle after giving it to the data_block; the data_block will take care of that.

Definition at line 33 of file playback.hpp.

◆ data_block() [2/2]

k4a::data_block::data_block ( data_block &&  other)
inlinenoexcept

Moves another data_block into a new data_block

Definition at line 41 of file playback.hpp.

◆ ~data_block()

k4a::data_block::~data_block ( )
inline

Definition at line 47 of file playback.hpp.

Member Function Documentation

◆ get_buffer()

const uint8_t * k4a::data_block::get_buffer ( ) const
inlinenoexcept

Get the data_block buffer.

See also
k4a_playback_data_block_get_buffer

Definition at line 112 of file playback.hpp.

◆ get_buffer_size()

size_t k4a::data_block::get_buffer_size ( ) const
inlinenoexcept

Get the size of the data_block buffer.

See also
k4a_playback_data_block_get_buffer_size

Definition at line 103 of file playback.hpp.

◆ get_device_timestamp_usec()

std::chrono::microseconds k4a::data_block::get_device_timestamp_usec ( ) const
inlinenoexcept

Get the time stamp in micro seconds for the given data_block

See also
k4a_playback_data_block_get_device_timestamp_usec

Definition at line 94 of file playback.hpp.

◆ is_valid()

bool k4a::data_block::is_valid ( ) const
inlinenoexcept

Returns true if the data_block is valid, false otherwise

Definition at line 74 of file playback.hpp.

◆ operator bool()

k4a::data_block::operator bool ( ) const
inlineexplicitnoexcept

Returns true if the data_block is valid, false otherwise

Definition at line 67 of file playback.hpp.

◆ operator=()

data_block & k4a::data_block::operator= ( data_block &&  other)
inlinenoexcept

Moves another data_block into this data_block; other is set to invalid

Definition at line 54 of file playback.hpp.

◆ reset()

void k4a::data_block::reset ( )
inlinenoexcept

Releases the underlying k4a_playback_data_block_t; the data_block is set to invalid.

Definition at line 81 of file playback.hpp.


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