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

Wrapper for k4a_device_t. More...

#include <k4a/k4a.hpp>

Public Member Functions

 device (k4a_device_t handle=nullptr) noexcept
 Creates a device from a k4a_device_t Takes ownership of the handle, i.e. More...
 
 device (device &&dev) noexcept
 Moves another device into a new device.
 
 device (const device &)=delete
 
deviceoperator= (const device &)=delete
 
deviceoperator= (device &&dev) noexcept
 Moves another device into this device; other is set to invalid.
 
 operator bool () const noexcept
 Returns true if the device is valid, false otherwise.
 
bool is_valid () const noexcept
 Returns true if the device is valid, false otherwise.
 
k4a_device_t handle () const noexcept
 Returns the underlying k4a_device_t handle. More...
 
void close () noexcept
 Closes a k4a device. More...
 
bool get_capture (capture *cap, std::chrono::milliseconds timeout)
 Reads a sensor capture into cap. More...
 
bool get_capture (capture *cap)
 Reads a sensor capture into cap. More...
 
bool get_imu_sample (k4a_imu_sample_t *imu_sample, std::chrono::milliseconds timeout)
 Reads an IMU sample. More...
 
bool get_imu_sample (k4a_imu_sample_t *imu_sample)
 Reads an IMU sample. More...
 
void start_cameras (const k4a_device_configuration_t *configuration)
 Starts the K4A device's cameras Throws error on failure. More...
 
void stop_cameras () noexcept
 Stops the K4A device's cameras. More...
 
void start_imu ()
 Starts the K4A IMU Throws error on failure. More...
 
void stop_imu () noexcept
 Stops the K4A IMU. More...
 
std::string get_serialnum () const
 Get the K4A device serial number Throws error on failure. More...
 
void get_color_control (k4a_color_control_command_t command, k4a_color_control_mode_t *mode, int32_t *value) const
 Get the K4A color sensor control value Throws error on failure. More...
 
void set_color_control (k4a_color_control_command_t command, k4a_color_control_mode_t mode, int32_t value)
 Set the K4A color sensor control value Throws error on failure. More...
 
std::vector< uint8_t > get_raw_calibration () const
 Get the raw calibration blob for the entire K4A device. More...
 
calibration get_calibration (k4a_depth_mode_t depth_mode, k4a_color_resolution_t color_resolution) const
 Get the camera calibration for the entire K4A device, which is used for all transformation functions. More...
 
bool is_sync_in_connected () const
 Get the device jack status for the synchronization in connector Throws error on failure. More...
 
bool is_sync_out_connected () const
 Get the device jack status for the synchronization out connector Throws error on failure. More...
 
k4a_hardware_version_t get_version () const
 Get the version numbers of the K4A subsystems' firmware Throws error on failure. More...
 

Static Public Member Functions

static device open (uint32_t index)
 Open a k4a device. More...
 
static uint32_t get_installed_count () noexcept
 Gets the number of connected devices. More...
 

Detailed Description

Wrapper for k4a_device_t.

Wraps a handle for a device.


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