Azure Kinect Sensor SDK  refs/heads/master
Documentation for https://github.com/Microsoft/Azure-Kinect-Sensor-SDK
k4a::playback Class Reference

Wrapper for k4a_playback_t. More...

#include <k4arecord/playback.hpp>

Public Member Functions

 playback (k4a_playback_t handle=nullptr) noexcept
 Creates a k4a::playback from a k4a_playback_t Takes ownership of the handle, i.e. More...
 
 playback (playback &&other) noexcept
 Moves another k4a::playback into a new k4a::playback.
 
 playback (const playback &)=delete
 
playbackoperator= (const playback &)=delete
 
playbackoperator= (playback &&other) noexcept
 Moves another k4a::playback into this k4a::playback; other is set to invalid.
 
 operator bool () const noexcept
 Returns true if the k4a::playback is valid, false otherwise.
 
bool is_valid () const noexcept
 Returns true if the k4a::playback is valid, false otherwise.
 
void close () noexcept
 Closes a K4A recording. More...
 
std::vector< uint8_t > get_raw_calibration () const
 Get the raw calibration blob for the K4A device that made the recording. More...
 
calibration get_calibration () const
 Get the camera calibration for the K4A device that made the recording, which is used for all transformation functions. More...
 
k4a_record_configuration_t get_record_configuration () const
 Gets the configuration of the recording. More...
 
bool get_next_capture (capture *cap)
 Get the next capture in the recording. More...
 
bool get_previous_capture (capture *cap)
 Get the previous capture in the recording. More...
 
bool get_tag (const char *name, std::string *out) const
 Reads the value of a tag from the recording Returns false if the tag does not exist. More...
 
bool get_next_imu_sample (k4a_imu_sample_t *sample)
 Get the next IMU sample in the recording. More...
 
bool get_previous_imu_sample (k4a_imu_sample_t *sample)
 Get the previous IMU sample in the recording. More...
 
void seek_timestamp (std::chrono::microseconds offset, k4a_playback_seek_origin_t origin)
 Seeks to a specific time point in the recording Throws error on failure. More...
 
std::chrono::microseconds get_recording_length () const noexcept
 Get the last valid timestamp in the recording. More...
 
void set_color_conversion (k4a_image_format_t format)
 Set the image format that color captures will be converted to. More...
 
bool get_next_data_block (const char *track, data_block *block)
 Get the next data block in the recording. More...
 
bool get_previous_data_block (const char *track, data_block *block)
 Get the previous data block from the recording. More...
 
bool get_attachment (const char *attachment, std::vector< uint8_t > *data)
 Get the attachment block from the recording. More...
 

Static Public Member Functions

static playback open (const char *path)
 Opens a K4A recording for playback. More...
 

Detailed Description

Wrapper for k4a_playback_t.

Wraps a handle for a playback object

See also
k4a_playback_t

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