[][src]Module azure_kinect::bindings

Structs

_k4a_device_t
_k4a_capture_t
_k4a_image_t
_k4a_transformation_t
_k4a_device_configuration_t

Configuration parameters for an Azure Kinect device.

_k4a_calibration_extrinsics_t

Extrinsic calibration data.

_k4a_calibration_intrinsics_t

Camera sensor intrinsic calibration data.

_k4a_calibration_camera_t

Camera calibration contains intrinsic and extrinsic calibration information for a camera.

_k4a_calibration_t

Calibration type representing device calibration.

_k4a_version_t

Version information.

_k4a_hardware_version_t

Structure to define hardware version.

_k4a_imu_sample_t

IMU sample.

_k4a_record_t
_k4a_playback_t
_k4a_playback_data_block_t
_k4a_record_configuration_t

Structure containing the device configuration used to record.

_k4a_record_video_settings_t

Structure containing additional metadata specific to custom video tracks.

_k4a_record_subtitle_settings_t

Structure containing additional metadata specific to custom subtitle tracks.

k4a_calibration_intrinsic_parameters_t__param

individual parameter or array representation of intrinsic model.

k4a_float2_t__xy

XY or array representation of vector

k4a_float3_t__xyz

XYZ or array representation of vector.

Enums

k4a_result_t

Result code returned by Azure Kinect APIs.

k4a_buffer_result_t

Result code returned by Azure Kinect APIs.

k4a_wait_result_t

Result code returned by Azure Kinect APIs.

k4a_log_level_t

Verbosity levels of debug messaging

k4a_depth_mode_t

Depth sensor capture modes.

k4a_color_resolution_t

Color sensor resolutions.

k4a_image_format_t

Image format type.

k4a_transformation_interpolation_type_t

Transformation interpolation type.

k4a_fps_t

Color and depth sensor frame rate.

k4a_color_control_command_t

Color sensor control commands

k4a_color_control_mode_t

Color sensor control mode

k4a_wired_sync_mode_t

Synchronization mode when connecting two or more devices together.

k4a_calibration_type_t

Calibration types.

k4a_calibration_model_type_t

Calibration model type.

k4a_firmware_build_t

Firmware build type.

k4a_firmware_signature_t

Firmware signature type.

k4a_stream_result_t

Return codes returned by Azure Kinect playback API.

k4a_playback_seek_origin_t

Playback seeking positions.

Constants

K4A_VERSION_MAJOR
K4A_VERSION_MINOR
K4A_VERSION_PATCH
K4A_VERSION_PRERELEASE
K4A_VERSION_BUILD_METADATA
K4A_VERSION_STR
K4A_DEVICE_DEFAULT
K4A_WAIT_INFINITE
K4A_TRACK_NAME_COLOR
K4A_TRACK_NAME_DEPTH
K4A_TRACK_NAME_IR
K4A_TRACK_NAME_IMU

Statics

K4A_DEVICE_CONFIG_INIT_DISABLE_ALL

Functions

k4a_device_get_installed_count

Gets the number of connected devices

k4a_set_debug_message_handler

Sets and clears the callback function to receive debug messages from the Azure Kinect device.

k4a_set_allocator

Sets the callback functions for the SDK allocator

k4a_device_open

Open an Azure Kinect device.

k4a_device_close

Closes an Azure Kinect device.

k4a_device_get_capture

Reads a sensor capture.

k4a_device_get_imu_sample

Reads an IMU sample.

k4a_capture_create

Create an empty capture object.

k4a_capture_release

Release a capture.

k4a_capture_reference

Add a reference to a capture.

k4a_capture_get_color_image

Get the color image associated with the given capture.

k4a_capture_get_depth_image

Get the depth image associated with the given capture.

k4a_capture_get_ir_image

Get the IR image associated with the given capture.

k4a_capture_set_color_image

Set or add a color image to the associated capture.

k4a_capture_set_depth_image

Set or add a depth image to the associated capture.

k4a_capture_set_ir_image

Set or add an IR image to the associated capture.

k4a_capture_set_temperature_c

Set the temperature associated with the capture.

k4a_capture_get_temperature_c

Get the temperature associated with the capture.

k4a_image_create

Create an image.

k4a_image_create_from_buffer

Create an image from a pre-allocated buffer.

k4a_image_get_buffer

Get the image buffer.

k4a_image_get_size

Get the image buffer size.

k4a_image_get_format

Get the format of the image.

k4a_image_get_width_pixels

Get the image width in pixels.

k4a_image_get_height_pixels

Get the image height in pixels.

k4a_image_get_stride_bytes

Get the image stride in bytes.

k4a_image_get_timestamp_usec

Get the image's device timestamp in microseconds.

k4a_image_get_device_timestamp_usec

Get the image's device timestamp in microseconds.

k4a_image_get_system_timestamp_nsec

Get the image's system timestamp in nanoseconds.

k4a_image_get_exposure_usec

Get the image exposure in microseconds.

k4a_image_get_white_balance

Get the image white balance.

k4a_image_get_iso_speed

Get the image ISO speed.

k4a_image_set_device_timestamp_usec

Set the device time stamp, in microseconds, of the image.

k4a_image_set_timestamp_usec

Set the device time stamp, in microseconds, of the image.

k4a_image_set_system_timestamp_nsec

Set the system time stamp, in nanoseconds, of the image.

k4a_image_set_exposure_usec

Set the exposure time, in microseconds, of the image.

k4a_image_set_exposure_time_usec

Set the exposure time, in microseconds, of the image.

k4a_image_set_white_balance

Set the white balance of the image.

k4a_image_set_iso_speed

Set the ISO speed of the image.

k4a_image_reference

Add a reference to the k4a_image_t.

k4a_image_release

Remove a reference from the k4a_image_t.

k4a_device_start_cameras

Starts color and depth camera capture.

k4a_device_stop_cameras

Stops the color and depth camera capture.

k4a_device_start_imu

Starts the IMU sample stream.

k4a_device_stop_imu

Stops the IMU capture.

k4a_device_get_serialnum

Get the Azure Kinect device serial number.

k4a_device_get_version

Get the version numbers of the device's subsystems.

k4a_device_get_color_control_capabilities

Get the Azure Kinect color sensor control capabilities.

k4a_device_get_color_control

Get the Azure Kinect color sensor control value.

k4a_device_set_color_control

Set the Azure Kinect color sensor control value.

k4a_device_get_raw_calibration

Get the raw calibration blob for the entire Azure Kinect device.

k4a_device_get_calibration

Get the camera calibration for the entire Azure Kinect device.

k4a_device_get_sync_jack

Get the device jack status for the synchronization in and synchronization out connectors.

k4a_calibration_get_from_raw

Get the camera calibration for a device from a raw calibration blob.

k4a_transformation_create

Get handle to transformation handle.

k4a_transformation_destroy

Destroy transformation handle.

k4a_transformation_depth_image_to_color_camera

Transforms the depth map into the geometry of the color camera.

k4a_transformation_depth_image_to_color_camera_custom

Transforms depth map and a custom image into the geometry of the color camera.

k4a_transformation_color_image_to_depth_camera

Transforms a color image into the geometry of the depth camera.

k4a_transformation_depth_image_to_point_cloud

Transforms the depth image into 3 planar images representing X, Y and Z-coordinates of corresponding 3D points.

k4a_playback_open

Opens an existing recording file for reading.

k4a_playback_get_raw_calibration

Get the raw calibration blob for the Azure Kinect device used during recording.

k4a_playback_get_calibration

Get the camera calibration for Azure Kinect device used during recording. The output struct is used as input to all transformation functions.

k4a_playback_get_record_configuration

Get the device configuration used during recording.

k4a_playback_check_track_exists

Checks whether a track with the given track name exists in the playback file.

k4a_playback_get_track_count

Get the number of tracks in a playback file.

k4a_playback_get_track_name

Gets the name of a track at a specific index.

k4a_playback_track_is_builtin

Checks whether a track is one of the built-in tracks: "COLOR", "DEPTH", etc...

k4a_playback_track_get_video_settings

Gets the video-specific track information for a particular video track.

k4a_playback_track_get_codec_id

Gets the codec id string for a particular track.

k4a_playback_track_get_codec_context

Gets the codec context for a particular track.

k4a_playback_get_tag

Read the value of a tag from a recording.

k4a_playback_set_color_conversion

Set the image format that color captures will be converted to. By default the conversion format will be the same as the image format stored in the recording file, and no conversion will occur.

k4a_playback_get_attachment

Reads an attachment file from a recording.

k4a_playback_get_next_capture

Read the next capture in the recording sequence.

k4a_playback_get_previous_capture

Read the previous capture in the recording sequence.

k4a_playback_get_next_imu_sample

Read the next IMU sample in the recording sequence.

k4a_playback_get_previous_imu_sample

Read the previous IMU sample in the recording sequence.

k4a_playback_get_next_data_block

Read the next data block for a particular track.

k4a_playback_get_previous_data_block

Read the previous data block for a particular track.

k4a_playback_data_block_get_device_timestamp_usec

Get the device timestamp of a data block in microseconds.

k4a_playback_data_block_get_buffer_size

Get the buffer size of a data block.

k4a_playback_data_block_get_buffer

Get the buffer of a data block.

k4a_playback_data_block_release

Release a data block handle.

k4a_playback_seek_timestamp

Seek to a specific timestamp within a recording.

k4a_playback_get_recording_length_usec

Returns the length of the recording in microseconds.

k4a_playback_get_last_timestamp_usec

Gets the last timestamp in a recording, relative to the start of the recording.

k4a_playback_close

Closes a recording playback handle.

k4a_record_create

Opens a new recording file for writing.

k4a_record_add_tag

Adds a tag to the recording.

k4a_record_add_imu_track

Adds the track header for recording IMU.

k4a_record_add_attachment

Adds an attachment to the recording.

k4a_record_add_custom_video_track

Adds custom video tracks to the recording.

k4a_record_add_custom_subtitle_track

Adds custom subtitle tracks to the recording.

k4a_record_write_header

Writes the recording header and metadata to file.

k4a_record_write_capture

Writes a camera capture to file.

k4a_record_write_imu_sample

Writes an imu sample to file.

k4a_record_write_custom_track_data

Writes data for a custom track to file.

k4a_record_flush

Flushes all pending recording data to disk.

k4a_record_close

Closes a recording handle.

k4a_calibration_2d_to_2d

Transform a 2D pixel coordinate with an associated depth value of the source camera into a 2D pixel coordinate of the target camera.

k4a_calibration_2d_to_3d

Transform a 2D pixel coordinate with an associated depth value of the source camera into a 3D point of the target coordinate system.

k4a_calibration_3d_to_2d

Transform a 3D point of a source coordinate system into a 2D pixel coordinate of the target camera.

k4a_calibration_3d_to_3d

Transform a 3D point of a source coordinate system into a 3D point of the target coordinate system

k4a_calibration_color_2d_to_depth_2d

Transform a 2D pixel coordinate from color camera into a 2D pixel coordinate of the depth camera.

Type Definitions

__int32_t
__int64_t
__uint8_t
__uint32_t
__uint64_t
k4a_device_t
k4a_capture_t
k4a_image_t
k4a_transformation_t
k4a_logging_message_cb_t

Callback function for debug messages being generated by the Azure Kinect SDK.

k4a_memory_destroy_cb_t

Callback function for a memory object being destroyed.

k4a_memory_allocate_cb_t

Callback function for a memory allocation.

k4a_device_configuration_t
k4a_calibration_extrinsics_t
k4a_calibration_intrinsics_t
k4a_calibration_camera_t
k4a_calibration_t
k4a_version_t
k4a_hardware_version_t
k4a_imu_sample_t
k4a_record_t
k4a_playback_t
k4a_playback_data_block_t
k4a_record_configuration_t
k4a_record_video_settings_t
k4a_record_subtitle_settings_t
size_t

Unions

k4a_calibration_intrinsic_parameters_t

Camera intrinsic calibration data.

k4a_float2_t

Two dimensional floating point vector.

k4a_float3_t

Three dimensional floating point vector.